Management API Reference for setting=websockets

If websockets are enabled for this container

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.undertow.servlet-container.websocket	true	none

Attributes (5)

buffer-pool - The buffer pool to use for websocket 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 buffer pool to use for websocket deployments", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "default", "capability-reference" : "org.wildfly.undertow.byte-buffer-pool", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

deflater-level - Configures the level of compression of the DEFLATE algorithm

Type	INT
Default Value	0
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
Min	0
Max	9
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Configures the level of compression of the DEFLATE algorithm", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "min" : 0, "max" : 9, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

dispatch-to-worker - If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

per-message-deflate - Enables websocket's per-message compression extension, RFC-7692

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" : "Enables websocket's per-message compression extension, RFC-7692", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

worker - The worker to use for websocket 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 worker to use for websocket deployments", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "default", "capability-reference" : "org.wildfly.io.worker", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Adds websockets support

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
buffer-pool	STRING	false	false	default	The buffer pool to use for websocket deployments
deflater-level	INT	false	true	0	Configures the level of compression of the DEFLATE algorithm
dispatch-to-worker	BOOLEAN	false	true	true	If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.
per-message-deflate	BOOLEAN	false	true	false	Enables websocket's per-message compression extension, RFC-7692
worker	STRING	false	false	default	The worker to use for websocket deployments

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds websockets support",
    "request-properties" : {
        "buffer-pool" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The buffer pool to use for websocket deployments",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "default",
            "capability-reference" : "org.wildfly.undertow.byte-buffer-pool",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "deflater-level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Configures the level of compression of the DEFLATE algorithm",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "min" : 0,
            "max" : 9,
            "stability" : "default"
        },
        "dispatch-to-worker" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "per-message-deflate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables websocket's per-message compression extension, RFC-7692",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "worker" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The worker to use for websocket deployments",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "default",
            "capability-reference" : "org.wildfly.io.worker",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes websockets support

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes websockets support",
    "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.servlet-container.setting.websockets

        
<feature spec="subsystem.undertow.servlet-container.setting.websockets">
  <param name="servlet-container" value="{resource name}"/>
  <param name="deflater-level" value="{value}"/>
  <param name="dispatch-to-worker" value="{value}"/>
  <param name="per-message-deflate" value="{value}"/>
<feature/>