Management API Reference for subsystem=undertow

Undertow subsystem

Children (6)

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.undertow	false	none
org.wildfly.undertow.http-invoker	false	none

Attributes (7)

default-security-domain - The default security domain used by web deployments

Type	STRING
Default Value	other
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default security domain used by web deployments", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "other", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"security-domain-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

default-server - The default server to use for deployments

Type	STRING
Default Value	default-server
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default server to use for deployments", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "default-server", "capability-reference" : "org.wildfly.undertow.server", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

default-servlet-container - The default servlet container to use for deployments

Type	STRING
Default Value	default
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default servlet container to use for deployments", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "default", "capability-reference" : "org.wildfly.undertow.servlet-container", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

default-virtual-host - The default virtual host to use for deployments

Type	STRING
Default Value	default-host
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default virtual host to use for deployments", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "default-host", "capability-reference" : "org.wildfly.undertow.host", "capability-reference-pattern-elements" : [ "default-server", "default-virtual-host" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

instance-id - The cluster instance id (defaults to {$jboss.node.name} if undefined)

Type	STRING
Default Value	${jboss.node.name}
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The cluster instance id (defaults to {$jboss.node.name} if undefined)", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : { "EXPRESSION_VALUE" : "${jboss.node.name}" }, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

obfuscate-session-route - Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

statistics-enabled - Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).

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?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

add - Operation Adds subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
default-security-domain	STRING	false	true	other	The default security domain used by web deployments
default-server	STRING	false	false	default-server	The default server to use for deployments
default-servlet-container	STRING	false	false	default	The default servlet container to use for deployments
default-virtual-host	STRING	false	false	default-host	The default virtual host to use for deployments
instance-id	STRING	false	true	${jboss.node.name}	The cluster instance id (defaults to {$jboss.node.name} if undefined)
obfuscate-session-route	BOOLEAN	false	true	false	Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker
statistics-enabled	BOOLEAN	false	true	false	Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation Adds subsystem",
    "request-properties" : {
        "default-security-domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default security domain used by web deployments",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "other",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-server" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default server to use for deployments",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "default-server",
            "capability-reference" : "org.wildfly.undertow.server",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-servlet-container" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default servlet container to use for deployments",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "default",
            "capability-reference" : "org.wildfly.undertow.servlet-container",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-virtual-host" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default virtual host to use for deployments",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "default-host",
            "capability-reference" : "org.wildfly.undertow.host",
            "capability-reference-pattern-elements" : [
                "default-server",
                "default-virtual-host"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "instance-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The cluster instance id (defaults to {$jboss.node.name} if undefined)",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : {
                "EXPRESSION_VALUE" : "${jboss.node.name}"
            },
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "obfuscate-session-route" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Operation Removes subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation Removes 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.undertow

        
<feature spec="subsystem.undertow">
  <param name="default-security-domain" value="{value}"/>
  <param name="instance-id" value="{value}"/>
  <param name="obfuscate-session-route" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>