Management API Reference for cache-container

The configuration of an infinispan cache container

Children (8)

Provided Capabilities (11)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache-container	true	none
org.wildfly.clustering.cache.default-singleton-service-builder-factory	true	none
org.wildfly.clustering.default-singleton-service-target-factory	true	none
org.wildfly.clustering.server.default-service-provider-registrar	true	none
org.wildfly.clustering.infinispan.default-cache-configuration	true	none
org.wildfly.clustering.default-registry-factory	true	none
org.wildfly.clustering.server.default-registry-factory	true	none
org.wildfly.clustering.infinispan.default-cache	true	none
org.wildfly.clustering.cache.default-singleton-service-configurator-factory	true	none
org.wildfly.clustering.default-service-provider-registry	true	none
org.wildfly.clustering.infinispan.cache-container-configuration	true	none

Attributes (10)

aliases - The list of aliases for this cache container

Type	LIST
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" : "LIST" }, "description" : "The list of aliases for this cache container", "expressions-allowed" : false, "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 }`

cache-manager-status - The status of the cache manager component. May return null if the cache manager is not started.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The status of the cache manager component. May return null if the cache manager is not started.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

cluster-name - The name of the cluster this node belongs to. May return null if the cache manager is not started.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cluster this node belongs to. May return null if the cache manager is not started.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

coordinator-address - The logical address of the cluster's coordinator. May return null if the cache manager is not started.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The logical address of the cluster's coordinator. May return null if the cache manager is not started.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

default-cache - The default infinispan cache

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 default infinispan cache", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration", "capability-reference-pattern-elements" : [ "cache-container", "default-cache" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

is-coordinator - Set to true if this node is the cluster's coordinator. May return null if the cache manager is not started.

Type	BOOLEAN
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Set to true if this node is the cluster's coordinator. May return null if the cache manager is not started.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

local-address - The local address of the node. May return null if the cache manager is not started.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The local address of the node. May return null if the cache manager is not started.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

marshaller - Defines the marshalling implementation used to marshal cache entries.

Type	STRING
Default Value	LEGACY
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	LEGACY JBOSS PROTOSTREAM
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the marshalling implementation used to marshal cache entries.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "LEGACY", "allowed" : [ "LEGACY", "JBOSS", "PROTOSTREAM" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

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

Type	LIST
Default Value	["org.wildfly.clustering.cache.infinispan.embedded"]
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 container's configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : ["org.wildfly.clustering.cache.infinispan.embedded"], "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 }

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

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 container", "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 cache container to the infinispan subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
aliases	LIST	false	false		The list of aliases for this cache container
default-cache	STRING	false	false		The default infinispan cache
marshaller	STRING	false	true	LEGACY	Defines the marshalling implementation used to marshal cache entries.
modules	LIST	false	true	["org.wildfly.clustering.cache.infinispan.embedded"]	The set of modules associated with this cache container's configuration.
statistics-enabled	BOOLEAN	false	true	false	If enabled, statistics will be collected for this cache container

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a cache container to the infinispan subsystem",
    "request-properties" : {
        "aliases" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of aliases for this cache container",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "default-cache" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default infinispan cache",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration",
            "capability-reference-pattern-elements" : [
                "cache-container",
                "default-cache"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "marshaller" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the marshalling implementation used to marshal cache entries.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "LEGACY",
            "allowed" : [
                "LEGACY",
                "JBOSS",
                "PROTOSTREAM"
            ],
            "stability" : "default"
        },
        "modules" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The set of modules associated with this cache container's configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : ["org.wildfly.clustering.cache.infinispan.embedded"],
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If enabled, statistics will be collected for this cache container",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a cache container from the infinispan subsystem

Raw DMR model


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

        
<feature spec="subsystem.infinispan.cache-container">
  <param name="cache-container" value="{resource name}"/>
  <param name="aliases" value="{value}"/>
  <param name="default-cache" value="{value}"/>
  <param name="marshaller" value="{value}"/>
  <param name="modules" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>