Management API Reference for distributed-cache

A distributed cache configuration.

Children (3)

component
memory
- heap
- off-heap
store
- custom
- file
- hotrod
- jdbc
- none
- remote

Provided Capabilities (10)

Name	Dynamic	Other provider points
org.wildfly.clustering.server.service-provider-registrar	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.singleton-service-target-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.registry-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.singleton-service-builder-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.server.registry-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.infinispan.cache-configuration	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.singleton-service-configurator-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.infinispan.cache	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.service-provider-registry	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/scattered-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.infinispan.cache-container-configuration	true	/subsystem=infinispan/cache-container=*

Attributes (7)

capacity-factor - Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.

Type	DOUBLE
Default Value	1.0
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
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "DOUBLE" }, "description" : "Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1.0, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

l1-lifespan - Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Type	LONG
Default Value	0
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" : "Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

modules - The set of modules associated with this cache's configuration.

Type	LIST
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
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The set of modules associated with this cache's configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

owners - Number of cluster-wide replicas for each cache entry.

Type	INT
Default Value	2
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" : "Number of cluster-wide replicas for each cache entry.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

remote-timeout - In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

Type	LONG
Default Value	17500
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" : "In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 17500, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

segments - Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.

Type	INT
Default Value	256
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" : "Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 256, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

statistics-enabled - If enabled, statistics will be collected for this cache

Type	BOOLEAN
Default Value	false
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
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If enabled, statistics will be collected for this cache", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Add a distributed cache to this cache container

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
capacity-factor	DOUBLE	false	true	1.0	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.
l1-lifespan	LONG	false	true	0	Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.
modules	LIST	false	true		The set of modules associated with this cache's configuration.
owners	INT	false	true	2	Number of cluster-wide replicas for each cache entry.
remote-timeout	LONG	false	true	17500	In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
segments	INT	false	true	256	Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.
statistics-enabled	BOOLEAN	false	true	false	If enabled, statistics will be collected for this cache

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a distributed cache to this cache container",
    "request-properties" : {
        "capacity-factor" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1.0,
            "stability" : "default"
        },
        "l1-lifespan" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "modules" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The set of modules associated with this cache's configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "owners" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Number of cluster-wide replicas for each cache entry.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "remote-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 17500,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "segments" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Controls the number of hash space segments which is the granularity for key distribution in the cluster. Value must be strictly positive.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 256,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If enabled, statistics will be collected for this cache",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a distributed cache from this cache container

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a distributed cache from this cache container",
    "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

        
<feature spec="subsystem.infinispan.cache-container.distributed-cache">
  <param name="cache-container" value="{resource name}"/>
  <param name="distributed-cache" value="{resource name}"/>
  <param name="capacity-factor" value="{value}"/>
  <param name="l1-lifespan" value="{value}"/>
  <param name="modules" value="{value}"/>
  <param name="owners" value="{value}"/>
  <param name="remote-timeout" value="{value}"/>
  <param name="segments" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>