Management API Reference for subsystem=request-controller

The request controller subsystem. Used for request limiting and graceful shutdown.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.request-controller	false	none

Attributes (3)

active-requests - The number of requests that are currently running on the server.

Type	INT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of requests that are currently running on the server.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

max-requests - The maximum number of all types of requests that can be running on a server at a time. Once this limit is hit, any new requests will be rejected.

Type	INT
Default Value	-1
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" : "INT" }, "description" : "The maximum number of all types of requests that can be running on a server at a time. Once this limit is hit, any new requests will be rejected.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : -1, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

track-individual-endpoints - If this is true, requests are tracked at an endpoint level, which will allow individual deployments to be suspended.

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" : "If this is true, requests are tracked at an endpoint level, which will allow individual deployments to be suspended.", "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 - Adds the request controller subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
max-requests	INT	false	true	-1	The maximum number of all types of requests that can be running on a server at a time. Once this limit is hit, any new requests will be rejected.
track-individual-endpoints	BOOLEAN	false	true	false	If this is true, requests are tracked at an endpoint level, which will allow individual deployments to be suspended.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the request controller subsystem.",
    "request-properties" : {
        "max-requests" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of all types of requests that can be running on a server at a time. Once this limit is hit, any new requests will be rejected.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : -1,
            "stability" : "default"
        },
        "track-individual-endpoints" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If this is true, requests are tracked at an endpoint level, which will allow individual deployments to be suspended.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the request controller subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the request controller 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.request-controller

        
<feature spec="subsystem.request-controller">
  <param name="max-requests" value="{value}"/>
  <param name="track-individual-endpoints" value="{value}"/>
<feature/>