Management API Reference for component=state-transfer

The state transfer configuration for distributed and replicated caches.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-configuration.component.state-transfer	true	/subsystem=infinispan/cache-container=/distributed-cache=/component=state-transfer /subsystem=infinispan/cache-container=/replicated-cache=/component=state-transfer

Attributes (2)

chunk-size - The maximum number of cache entries in a batch of transferred state.

Type	INT
Default Value	512
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 cache entries in a batch of transferred state.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 512, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

timeout - The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup. If timeout is 0, state transfer is performed asynchronously, and the cache will be immediately available.

Type	LONG
Default Value	240000
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 maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup. If timeout is 0, state transfer is performed asynchronously, and the cache will be immediately available.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 240000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Add a state transfer configuration.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
chunk-size	INT	false	true	512	The maximum number of cache entries in a batch of transferred state.
timeout	LONG	false	true	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup. If timeout is 0, state transfer is performed asynchronously, and the cache will be immediately available.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a state transfer configuration.",
    "request-properties" : {
        "chunk-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of cache entries in a batch of transferred state.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 512,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup. If timeout is 0, state transfer is performed asynchronously, and the cache will be immediately available.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 240000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a state transfer configuration.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a state transfer configuration.",
    "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.scattered-cache.component.state-transfer

        
<feature spec="subsystem.infinispan.cache-container.scattered-cache.component.state-transfer">
  <param name="cache-container" value="{resource name}"/>
  <param name="scattered-cache" value="{resource name}"/>
  <param name="chunk-size" value="{value}"/>
  <param name="timeout" value="{value}"/>
<feature/>