Management API Reference for service=timer-service

The Jakarta Enterprise Beans timer service

Children (2)

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ejb3.timer-service	false	none

Attributes (4)

default-data-store - The default data store used for persistent timers

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" : "The default data store used for persistent timers", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["default-persistent-timer-management"], "requires" : ["thread-pool-name"], "capability-reference" : "org.wildfly.ejb3.timer-service.timer-persistence-service", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

default-persistent-timer-management - The default timer management to use for persistent timers.

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" : "The default timer management to use for persistent timers.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["default-data-store"], "capability-reference" : "org.wildfly.clustering.ejb.timer-management-provider", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

default-transient-timer-management - The default timer management to use for transient timers.

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" : "The default timer management to use for transient timers.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["thread-pool-name"], "capability-reference" : "org.wildfly.clustering.ejb.timer-management-provider", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

thread-pool-name - The name of the thread pool used to run timer service invocations

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" : "The name of the thread pool used to run timer service invocations", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["default-transient-timer-management"], "capability-reference" : "org.wildfly.threads.executor.ejb3", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Adds the timer service

Request Parameter	Type	Required	Expressions Allowed	Description
default-data-store	STRING	true	false	The default data store used for persistent timers
default-persistent-timer-management	STRING	true	false	The default timer management to use for persistent timers.
default-transient-timer-management	STRING	true	false	The default timer management to use for transient timers.
thread-pool-name	STRING	true	false	The name of the thread pool used to run timer service invocations

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds the timer service",
    "request-properties" : {
        "default-data-store" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default data store used for persistent timers",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["default-persistent-timer-management"],
            "requires" : ["thread-pool-name"],
            "capability-reference" : "org.wildfly.ejb3.timer-service.timer-persistence-service",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-persistent-timer-management" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default timer management to use for persistent timers.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["default-data-store"],
            "capability-reference" : "org.wildfly.clustering.ejb.timer-management-provider",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-transient-timer-management" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default timer management to use for transient timers.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["thread-pool-name"],
            "capability-reference" : "org.wildfly.clustering.ejb.timer-management-provider",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "thread-pool-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the thread pool used to run timer service invocations",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["default-transient-timer-management"],
            "capability-reference" : "org.wildfly.threads.executor.ejb3",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove - Removes the timer service

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the timer service",
    "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.ejb3.service.timer-service

        
<feature spec="subsystem.ejb3.service.timer-service">
  <param name="default-data-store" value="{value}"/>
  <param name="default-persistent-timer-management" value="{value}"/>
  <param name="default-transient-timer-management" value="{value}"/>
  <param name="thread-pool-name" value="{value}"/>
<feature/>