Management API Reference for component=transaction

The cache transaction configuration.

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-configuration.component.transaction	true	/subsystem=infinispan/cache-container=/replicated-cache=/component=transaction /subsystem=infinispan/cache-container=/scattered-cache=/component=transaction /subsystem=infinispan/cache-container=/invalidation-cache=/component=transaction /subsystem=infinispan/cache-container=/local-cache=/component=transaction
org.wildfly.clustering.infinispan.cache	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/distributed-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=

Attributes (4)

complete-timeout - The duration (in ms) after which idle transactions are removed.

Type	LONG
Default Value	60000
Unit	MILLISECONDS
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	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The duration (in ms) after which idle transactions are removed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

locking - The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Type	STRING
Default Value	PESSIMISTIC
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	PESSIMISTIC OPTIMISTIC
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PESSIMISTIC", "allowed" : [ "OPTIMISTIC", "PESSIMISTIC" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

mode - Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

Type	STRING
Default Value	NONE
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	NON_XA BATCH FULL_XA NONE NON_DURABLE_XA
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "NONE", "allowed" : [ "NONE", "BATCH", "NON_XA", "NON_DURABLE_XA", "FULL_XA" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

stop-timeout - If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

Type	LONG
Default Value	10000
Unit	MILLISECONDS
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	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Adds a transaction configuration element to the cache.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
complete-timeout	LONG	false	true	60000	The duration (in ms) after which idle transactions are removed.
locking	STRING	false	true	PESSIMISTIC	The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.
mode	STRING	false	true	NONE	Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.
stop-timeout	LONG	false	true	10000	If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a transaction configuration element to the cache.",
    "request-properties" : {
        "complete-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The duration (in ms) after which idle transactions are removed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "locking" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PESSIMISTIC",
            "allowed" : [
                "OPTIMISTIC",
                "PESSIMISTIC"
            ],
            "stability" : "default"
        },
        "mode" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "NONE",
            "allowed" : [
                "NONE",
                "BATCH",
                "NON_XA",
                "NON_DURABLE_XA",
                "FULL_XA"
            ],
            "stability" : "default"
        },
        "stop-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a transaction configuration element from the cache.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a transaction configuration element from the cache.",
    "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.infinispan.cache-container.distributed-cache.component.transaction

        
<feature spec="subsystem.infinispan.cache-container.distributed-cache.component.transaction">
  <param name="cache-container" value="{resource name}"/>
  <param name="distributed-cache" value="{resource name}"/>
  <param name="complete-timeout" value="{value}"/>
  <param name="locking" value="{value}"/>
  <param name="mode" value="{value}"/>
  <param name="stop-timeout" value="{value}"/>
<feature/>