WildFly 34 Model Reference

A managed executor service

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.ee.concurrent.executor true

none

Attributes (19)

  • active-thread-count The approximate number of threads that are actively executing tasks.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • completed-task-count The approximate total number of tasks that have completed execution.
    • Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • context-service The name of the context service to be used by the executor.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • core-threads The minimum number of threads to be used by the executor. If left undefined the default core-size is calculated based on the number of processors. A value of zero is not advised and in some cases invalid. See the queue-length attribute for details on how this value is used to determine the queuing strategy.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • current-queue-size The current size of the executor's task queue.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • hung-task-termination-period The period, in milliseconds, for attempting hung tasks automatic termination, by cancelling such tasks, and interrupting their executing threads. If value is 0, which is the default, hung tasks are never cancelled.
    • Attribute Value
    Default Value 0
    Type LONG
    Nillable true
    Expressions Allowed true
    Min 0
    Max -1
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • hung-task-threshold The runtime, in milliseconds, for tasks to be considered hung by the managed executor service. If value is 0 tasks are never considered hung.
    • Attribute Value
    Default Value 0
    Type LONG
    Nillable true
    Expressions Allowed true
    Min 0
    Max -1
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • hung-thread-count The number of executor threads that are hung.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • jndi-name The JNDI Name to lookup the managed executor service.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • keepalive-time When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.
    • Attribute Value
    Default Value 60000
    Type LONG
    Nillable true
    Expressions Allowed true
    Min 0
    Max -1
    Unit MILLISECONDS
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • long-running-tasks Flag which hints the duration of tasks executed by the executor.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • max-thread-count The largest number of executor threads.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • max-threads The maximum number of threads to be used by the executor. If left undefined the value from core-size will be used. This value is ignored if an unbounded queue is used (only core-threads will be used in that case).
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • queue-length The executors task queue capacity. A length of 0 means direct hand-off and possible rejection will occur. An undefined length (the default), or Integer.MAX_VALUE, indicates that an unbounded queue should be used. All other values specify an exact queue size. If an unbounded queue or direct hand-off is used, a core-threads value greater than zero is required.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • reject-policy The policy to be applied to aborted tasks.
    • Attribute Value
    Default Value ABORT
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Allowed Values ABORT
    RETRY_ABORT
    Stability default
  • task-count The approximate total number of tasks that have ever been submitted for execution.
    • Attribute Value
    Type LONG
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • thread-count The current number of executor threads.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type metric
    Stability default
  • thread-factory The name of the thread factory to be used by the executor.
    • Deprecated Since 5.0.0
    Deprecated, the executor's thread factory should be configured using attribute named thread-priority.
    Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default
  • thread-priority The priority applied to threads created by the executor.
    • Attribute Value
    Default Value 5
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 10
    Storage configuration
    Access Type read-write
    Restart Required resource-services
    Stability default

Operations (3)

  • add Adds the executor
    Request Parameter Type Required Expressions Allowed Default value Description
    context-service STRING false false The name of the context service to be used by the executor.
    core-threads INT false true The minimum number of threads to be used by the executor. If left undefined the default core-size is calculated based on the number of processors. A value of zero is not advised and in some cases invalid. See the queue-length attribute for details on how this value is used to determine the queuing strategy.
    hung-task-termination-period LONG false true 0 The period, in milliseconds, for attempting hung tasks automatic termination, by cancelling such tasks, and interrupting their executing threads. If value is 0, which is the default, hung tasks are never cancelled.
    hung-task-threshold LONG false true 0 The runtime, in milliseconds, for tasks to be considered hung by the managed executor service. If value is 0 tasks are never considered hung.
    jndi-name STRING true true The JNDI Name to lookup the managed executor service.
    keepalive-time LONG false true 60000 When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.
    long-running-tasks BOOLEAN false true false Flag which hints the duration of tasks executed by the executor.
    max-threads INT false true The maximum number of threads to be used by the executor. If left undefined the value from core-size will be used. This value is ignored if an unbounded queue is used (only core-threads will be used in that case).
    queue-length INT false true The executors task queue capacity. A length of 0 means direct hand-off and possible rejection will occur. An undefined length (the default), or Integer.MAX_VALUE, indicates that an unbounded queue should be used. All other values specify an exact queue size. If an unbounded queue or direct hand-off is used, a core-threads value greater than zero is required.
    reject-policy STRING false true ABORT The policy to be applied to aborted tasks.
    thread-factory STRING false false The name of the thread factory to be used by the executor.
    thread-priority INT false true 5 The priority applied to threads created by the executor.
  • remove Removes the executor.
  • terminate-hung-tasks Attempts to terminate the executor's hung tasks, by cancelling such tasks, and interrupting their executing threads.