Management API Reference for long-running-threads

A thread pool executor with a bounded queue where threads submittings tasks may block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the caller blocks until room becomes available in the queue.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.threads.executor.long-running-threads	true	/subsystem=jca/distributed-workmanager=/long-running-threads=

Attributes (11)

allow-core-timeout - Whether core threads may time out.

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" : "Whether core threads may time out.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

core-threads - The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

Type	INT
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
Min	0
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

current-thread-count - The current number of threads in the pool.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The current number of threads in the pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

keepalive-time - Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Type	OBJECT
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" : "OBJECT" }, "description" : "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "time" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The time", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default" }, "unit" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time unit", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

largest-thread-count - The largest number of threads that have ever simultaneously been in the pool.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The largest number of threads that have ever simultaneously been in the pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

max-threads - The maximum thread pool size.

Type	INT
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	0
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum thread pool size.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

name - The name of the thread pool.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the thread pool.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

queue-length - The queue length.

Type	INT
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The queue length.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

queue-size - The queue size.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The queue size.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

rejected-count - The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

thread-factory - Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

Type	STRING
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" : "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.threads.thread-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (2)

add - Adds a blocking bounded queue thread pool.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
allow-core-timeout	BOOLEAN	false	true	false	Whether core threads may time out.
core-threads	INT	false	true		The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.
keepalive-time	OBJECT	false	false		Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
max-threads	INT	true	true		The maximum thread pool size.
queue-length	INT	true	true		The queue length.
thread-factory	STRING	false	false		Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a blocking bounded queue thread pool.",
    "request-properties" : {
        "allow-core-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether core threads may time out.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "core-threads" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "keepalive-time" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "time" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "LONG"
                    },
                    "description" : "The time",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "stability" : "default"
                },
                "unit" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The time unit",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "allowed" : [
                        "NANOSECONDS",
                        "MICROSECONDS",
                        "MILLISECONDS",
                        "SECONDS",
                        "MINUTES",
                        "HOURS",
                        "DAYS"
                    ],
                    "stability" : "default"
                }
            }
        },
        "max-threads" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum thread pool size.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min" : 0,
            "max" : 2147483647,
            "stability" : "default"
        },
        "queue-length" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The queue length.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "thread-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.threads.thread-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a blocking bounded queue thread pool.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a blocking bounded queue thread pool.",
    "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.jca.workmanager.long-running-threads

        
<feature spec="subsystem.jca.workmanager.long-running-threads">
  <param name="long-running-threads" value="{resource name}"/>
  <param name="workmanager" value="{resource name}"/>
  <param name="allow-core-timeout" value="{value}"/>
  <param name="core-threads" value="{value}"/>
  <param name="keepalive-time" value="{value}"/>
  <param name="max-threads" value="{value}"/>
  <param name="queue-length" value="{value}"/>
  <param name="thread-factory" value="{value}"/>
<feature/>