JBoss EAP 7.1 Model Reference

Children (2)

component A configuration component of a cache.

backup-for A cache for which this cache acts as a backup (for use with cross site replication).
backups The remote backups for this cache.
eviction The cache eviction configuration.
expiration The cache expiration configuration.
locking The locking configuration of the cache.
partition-handling The partition handling configuration for distributed and replicated caches.
state-transfer The state transfer configuration for distributed and replicated caches.
transaction The cache transaction configuration.

store A persistent store for a cache.

binary-jdbc The cache JDBC store configuration.
custom The cache store configuration.
file The cache file store configuration.
jdbc The cache JDBC store configuration.
mixed-jdbc The cache JDBC store configuration.
none A store-less configuration.
remote The cache remote store configuration.

Provided capabilities(10)

Name	Dynamic	Other provider points
org.wildfly.clustering.cache.service-provider-registry	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.registry	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.infinispan.cache-container.cache.transport	true	/subsystem=infinispan/cache-container=/replicated-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=/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=/invalidation-cache=
org.wildfly.clustering.infinispan.cache	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.node-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.group	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.registry-entry	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=
org.wildfly.clustering.cache.registry-factory	true	/subsystem=infinispan/cache-container=/local-cache= /subsystem=infinispan/cache-container=/replicated-cache= /subsystem=infinispan/cache-container=/invalidation-cache=

Attributes (37)

activations The number of cache node activations (bringing a node into memory from a cache store) . May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

async-marshalling If enabled, this will cause marshalling of entries to be performed asynchronously.

Deprecated Since 4.0.0

Deprecated. Asynchronous marshalling is no longer supported.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

average-read-time Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

average-replication-time The average time taken to replicate data around the cluster. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

average-write-time Average time (in ms) for cache writes. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

batching If enabled, the invocation batching API will be made available for this cache.

Deprecated Since 3.0.0

Deprecated. Replaced by BATCH transaction mode.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

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

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

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

Attribute	Value
Default Value	1.0
Type	DOUBLE
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

consistent-hash-strategy Defines the consistent hash strategy for the cache.

Attribute	Value
Default Value	INTER_CACHE
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Allowed Values	INTER_CACHE INTRA_CACHE

elapsed-time Time (in secs) since cache started. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

hit-ratio The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.

Attribute	Value
Type	DOUBLE
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

hits The number of cache attribute hits. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

indexing If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

Deprecated Since 4.0.0

Deprecated. Has no effect.

Attribute	Value
Default Value	NONE
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Allowed Values	NONE LOCAL ALL

indexing-properties Properties to control indexing behaviour

Deprecated Since 4.0.0

Deprecated. Has no effect.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	resource-services

invalidations The number of cache invalidations. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

jndi-name The jndi-name to which to bind this cache instance.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

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.

Attribute	Value
Default Value	0
Type	LONG
Nillable	true
Expressions Allowed	true
Min	0
Max	-1
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	resource-services

misses The number of cache attribute misses. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

mode Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

Attribute	Value
Default Value	SYNC
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Allowed Values	SYNC ASYNC

module The module whose class loader should be used when building this cache's configuration.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

number-of-entries The current number of entries in the cache. May return null if the cache is not started.

Attribute	Value
Type	INT
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

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

Attribute	Value
Default Value	2
Type	INT
Nillable	true
Expressions Allowed	true
Min	1
Max	2,147,483,647
Storage	configuration
Access Type	read-write
Restart Required	resource-services

passivations The number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

queue-flush-interval In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

Deprecated Since 4.1.0

Deprecated. This attribute will be ignored.

Attribute	Value
Default Value	10
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	resource-services

queue-size In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

Deprecated Since 4.1.0

Deprecated. This attribute will be ignored.

Attribute	Value
Default Value	0
Type	INT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

read-write-ratio The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.

Attribute	Value
Type	DOUBLE
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

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.

Attribute	Value
Default Value	10000
Type	LONG
Nillable	true
Expressions Allowed	true
Unit	MILLISECONDS
Storage	configuration
Access Type	read-write
Restart Required	resource-services

remove-hits The number of cache attribute remove hits. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

remove-misses The number of cache attribute remove misses. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

replication-count The number of times data was replicated around the cluster. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

replication-failures The number of data replication failures. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

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

Attribute	Value
Default Value	256
Type	INT
Nillable	true
Expressions Allowed	true
Min	1
Max	2,147,483,647
Storage	configuration
Access Type	read-write
Restart Required	resource-services

start The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

Deprecated Since 3.0.0

Deprecated. Only LAZY mode is supported.

Attribute	Value
Default Value	LAZY
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Allowed Values	LAZY

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

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

stores The number of cache attribute put operations. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

success-ratio The data replication success ratio (successes/successes+failures). May return null if the cache is not started.

Attribute	Value
Type	DOUBLE
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

time-since-reset Time (in secs) since cache statistics were reset. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

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.
consistent-hash-strategy	STRING	false	true	INTER_CACHE	Defines the consistent hash strategy for the cache.
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.
owners	INT	false	true	2	Number of cluster-wide replicas for each cache entry.
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.
mode	STRING	false	true	SYNC	Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.
remote-timeout	LONG	false	true	10000	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.
async-marshalling	BOOLEAN	false	true	false	If enabled, this will cause marshalling of entries to be performed asynchronously.
queue-flush-interval	LONG	false	true	10	In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.
queue-size	INT	false	true	0	In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
module	STRING	false	true		The module whose class loader should be used when building this cache's configuration.
jndi-name	STRING	false	true		The jndi-name to which to bind this cache instance.
statistics-enabled	BOOLEAN	false	true	false	If enabled, statistics will be collected for this cache
batching	BOOLEAN	false	true	false	If enabled, the invocation batching API will be made available for this cache.
indexing	STRING	false	true	NONE	If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.
indexing-properties	OBJECT	false	false		Properties to control indexing behaviour
start	STRING	false	true	LAZY	The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

remove Remove a distributed cache from this cache container