Management API Reference for infinispan-timer-management

Provided Capabilities (1)

Attributes (4)

• cache - The name of the cache associated with this provider

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache associated with this provider", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration", "capability-reference-pattern-elements" : [ "cache-container", "cache" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

• cache-container - The name of the cache container associated with this provider

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache container associated with this provider", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.clustering.infinispan.default-cache-configuration", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

• marshaller - Indicates the marshalling implementation used for serializing the timeout context of a timer.

  Type	STRING
  Default Value	JBOSS
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Allowed Values	JBOSS PROTOSTREAM
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates the marshalling implementation used for serializing the timeout context of a timer.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "JBOSS", "allowed" : [ "JBOSS", "PROTOSTREAM" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• max-active-timers - The maximum number of active timers to retain in memory before triggering passivation.

  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?	resource-services
  Min	1
  Max	2147483647
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of active timers to retain in memory before triggering passivation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

• add - Adds an Infinispan-based timer management provider

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  cache	STRING	false	false		The name of the cache associated with this provider
  cache-container	STRING	true	false		The name of the cache container associated with this provider
  marshaller	STRING	false	true	JBOSS	Indicates the marshalling implementation used for serializing the timeout context of a timer.
  max-active-timers	INT	false	true		The maximum number of active timers to retain in memory before triggering passivation.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds an Infinispan-based timer management provider", "request-properties" : { "cache" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache associated with this provider", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration", "capability-reference-pattern-elements" : [ "cache-container", "cache" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "cache-container" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache container associated with this provider", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.clustering.infinispan.default-cache-configuration", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "marshaller" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates the marshalling implementation used for serializing the timeout context of a timer.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "JBOSS", "allowed" : [ "JBOSS", "PROTOSTREAM" ], "stability" : "default" }, "max-active-timers" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of active timers to retain in memory before triggering passivation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min" : 1, "max" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes an Infinispan-based timer management provider

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes an Infinispan-based timer management provider", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.distributable-ejb.infinispan-timer-management

          
  <feature spec="subsystem.distributable-ejb.infinispan-timer-management">
    <param name="infinispan-timer-management" value="{resource name}"/>
    <param name="cache" value="{value}"/>
    <param name="cache-container" value="{value}"/>
    <param name="marshaller" value="{value}"/>
    <param name="max-active-timers" value="{value}"/>
  <feature/>
          
        

  📋