Management API Reference for distributed-workmanager

DistributedWorkManager for resource adapters

Stability Level: default

Children (2)

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.connector.workmanager	true	none

Attributes (6)

elytron-enabled - Enables Elytron security for this workmanager.

Deprecated Since 6.0.0

Elytron is enabled by default and this field is ignored.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables Elytron security for this workmanager.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "deprecated" : { "since" : "6.0.0", "reason" : "Elytron is enabled by default and this field is ignored." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

name - The name of the DistributedWorkManager

Type	STRING
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 DistributedWorkManager", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

policy - The policy decides when to redistribute a Work instance

Type	STRING
Default Value	WATERMARK
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
Allowed Values	NEVER WATERMARK ALWAYS
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The policy decides when to redistribute a Work instance", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "WATERMARK", "allowed" : [ "NEVER", "ALWAYS", "WATERMARK" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

policy-options - List of policy's options key/value pairs

Type	OBJECT
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" : "OBJECT" }, "description" : "List of policy's options key/value pairs", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

selector - The selector decides to which nodes in the network to redistribute the Work instance to

Type	STRING
Default Value	PING_TIME
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
Allowed Values	MAX_FREE_THREADS PING_TIME FIRST_AVAILABLE
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The selector decides to which nodes in the network to redistribute the Work instance to", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PING_TIME", "allowed" : [ "FIRST_AVAILABLE", "PING_TIME", "MAX_FREE_THREADS" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

selector-options - List of selector's options key/value pairs

Type	OBJECT
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" : "OBJECT" }, "description" : "List of selector's options key/value pairs", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Add distributed work manager

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
elytron-enabled	BOOLEAN	false	true	true	Enables Elytron security for this workmanager.
name	STRING	true	false		The name of the DistributedWorkManager
policy	STRING	false	true	WATERMARK	The policy decides when to redistribute a Work instance
policy-options	OBJECT	false	true		List of policy's options key/value pairs
selector	STRING	false	true	PING_TIME	The selector decides to which nodes in the network to redistribute the Work instance to
selector-options	OBJECT	false	true		List of selector's options key/value pairs

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add distributed work manager",
    "request-properties" : {
        "elytron-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables Elytron security for this workmanager.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "6.0.0",
                "reason" : "Elytron is enabled by default and this field is ignored."
            }
        },
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the DistributedWorkManager",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "policy" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The policy decides when to redistribute a Work instance",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "WATERMARK",
            "allowed" : [
                "NEVER",
                "ALWAYS",
                "WATERMARK"
            ],
            "stability" : "default"
        },
        "policy-options" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "List of policy's options key/value pairs",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "selector" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The selector decides to which nodes in the network to redistribute the Work instance to",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PING_TIME",
            "allowed" : [
                "FIRST_AVAILABLE",
                "PING_TIME",
                "MAX_FREE_THREADS"
            ],
            "stability" : "default"
        },
        "selector-options" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "List of selector's options key/value pairs",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove distributed work manager

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove distributed work manager",
    "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.distributed-workmanager

        
<feature spec="subsystem.jca.distributed-workmanager">
  <param name="distributed-workmanager" value="{resource name}"/>
  <param name="elytron-enabled" value="{value}"/>
  <param name="name" value="{value}"/>
  <param name="policy" value="{value}"/>
  <param name="policy-options" value="{value}"/>
  <param name="selector" value="{value}"/>
  <param name="selector-options" value="{value}"/>
<feature/>