Management API Reference for subsystem=ee

The configuration of the EE subsystem.

Children (6)

Attributes (5)

annotation-property-replacement - Flag indicating whether Jakarta EE annotations will have property replacements applied

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether Jakarta EE annotations will have property replacements applied", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

ear-subdeployments-isolated - Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

global-modules - A list of modules that should be made available to all deployments.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of modules that should be made available to all deployments.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the module", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "slot" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The module's slot", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "main", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "annotations" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If a pre-computed annotation index should be imported from META-INF/jandex.idx", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "services" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If any services exposed in META-INF/services should be made available to the deployments class loader", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "meta-inf" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If a modules META-INF directory should be made available to the deployments class loader", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

jboss-descriptor-property-replacement - Flag indicating whether JBoss specific deployment descriptors will have property replacements applied

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether JBoss specific deployment descriptors will have property replacements applied", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

spec-descriptor-property-replacement - Flag indicating whether descriptors defined by the Jakarta EE specification will have property replacements applied

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Flag indicating whether descriptors defined by the Jakarta EE specification will have property replacements applied", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Adds the EE subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
annotation-property-replacement	BOOLEAN	false	true	false	Flag indicating whether Jakarta EE annotations will have property replacements applied
ear-subdeployments-isolated	BOOLEAN	false	true	false	Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.
global-modules	LIST	false	false		A list of modules that should be made available to all deployments.
jboss-descriptor-property-replacement	BOOLEAN	false	true	true	Flag indicating whether JBoss specific deployment descriptors will have property replacements applied
spec-descriptor-property-replacement	BOOLEAN	false	true	true	Flag indicating whether descriptors defined by the Jakarta EE specification will have property replacements applied

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the EE subsystem.",
    "request-properties" : {
        "annotation-property-replacement" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag indicating whether Jakarta EE annotations will have property replacements applied",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "ear-subdeployments-isolated" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "global-modules" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of modules that should be made available to all deployments.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the module",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "slot" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The module's slot",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "main",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "annotations" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BOOLEAN"
                    },
                    "description" : "If a pre-computed annotation index should be imported from META-INF/jandex.idx",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : false,
                    "stability" : "default"
                },
                "services" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BOOLEAN"
                    },
                    "description" : "If any services exposed in META-INF/services should be made available to the deployments class loader",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : false,
                    "stability" : "default"
                },
                "meta-inf" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BOOLEAN"
                    },
                    "description" : "If a modules META-INF directory should be made available to the deployments class loader",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : true,
                    "stability" : "default"
                }
            }
        },
        "jboss-descriptor-property-replacement" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag indicating whether JBoss specific deployment descriptors will have property replacements applied",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "spec-descriptor-property-replacement" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Flag indicating whether descriptors defined by the Jakarta EE specification will have property replacements applied",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the EE subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the EE subsystem.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.ee

        
<feature spec="subsystem.ee">
  <param name="annotation-property-replacement" value="{value}"/>
  <param name="ear-subdeployments-isolated" value="{value}"/>
  <param name="global-modules" value="{value}"/>
  <param name="jboss-descriptor-property-replacement" value="{value}"/>
  <param name="spec-descriptor-property-replacement" value="{value}"/>
<feature/>