urn:infinispan:config:9.1

Name	Type	Default	Description
transport	string	org.infinispan.remoting.transport.jgroups.JGroupsTransport	Class that represents a network transport. Must implement org.infinispan.remoting.transport.Transport.

Name	Type	Default	Description
name	string		Name of the stack, to be referenced by transport's stack attribute.
path	string		Path of JGroups configuration file containing stack definition.

Name	Type	Default	Description
name	string
group-name	string
thread-name-pattern	string
priority	string

Name	Type	Default	Description
name	string
thread-factory	string
max-threads	int
core-threads	int
keepalive-time	string
queue-length	string

Name	Type	Default	Description
name	string
thread-factory	string

Name	Type	Default	Description
name	string
thread-factory	string

transport?

Overrides the transport characteristics for this cache container.

Name	Type	Default	Description
stack	string		Defines the jgroups stack used by the transport.
cluster	string		Defines the name for the underlying group communication cluster.
executor	string		Defines the executor used for asynchronous transport communication.
remote-command-executor	string		Configuration for the executor service used to execute remote commands. Use org.infinispan.executors.WithinThreadExecutorFactory to disable.
lock-timeout	long	240000	Infinispan uses a distributed lock to maintain a coherent transaction log during state transfer or rehashing, which means that only one cache can be doing state transfer or rehashing at the same time. This constraint is in place because more than one cache could be involved in a transaction. This timeout controls the time to wait to acquire a distributed lock.
node-name	string		Name of the current node. This is a friendly name to make logs, etc. make more sense. Defaults to a combination of host name and a random number (to differentiate multiple nodes on the same host)
machine	string		The id of the machine where this node runs.
rack	string		The id of the rack where this node runs.
site	string		The id of the site where this node runs.
initial-cluster-size	int		The minimum number of nodes that must join the cluster for the cache manager to start
initial-cluster-timeout	long		The amount of time in milliseconds to wait for a cluster with sufficient nodes to form. Defaults to 60000

security?

Configures security for this cache container.

authorization?

Configures the global authorization role to permission mapping. The presence of this element in the configuration implicitly enables authorization.

Name	Type	Default	Description
audit-logger	string		Class of the audit logger.

identity-role-mapper

Uses the identity role mapper where principal names are converted as-is into role names.

common-name-role-mapper

Uses the common name role mapper which assumes principal names are in Distinguished Name format and extracts the Common Name to use as a role

cluster-role-mapper

Uses the cluster role mapper which stores the principal to role mappings within the cluster registry.

custom-role-mapper

Uses a custom role mapper.

Name	Type	Default	Description
class	string		Class of the custom principal to role mapper

role*

Defines a new role name and assigns permissions to it.

Name

Type

Default

Description

name

string

Defines the name of the role.

permissions

LIFECYCLE	Allows control of a cache's lifecycle (i.e. starting and stopping a cache)
READ	Allows reading data from a cache
WRITE	Allows writing data to a cache
EXEC	Allows performing task execution (e.g. distributed executors, map/reduce) on a cache
LISTEN	Allows attaching listeners to a cache
BULK_READ	Allows bulk-read operations (e.g. obtaining all the keys in a cache)
BULK_WRITE	Allows bulk-write operations (e.g. clearing a cache)
ADMIN	Allows performing "administrative" operations on a cache
ALL	Aggregate permission which implies all of the others
ALL_READ	Aggregate permission which implies all read permissions (READ and BULK_READ)
ALL_WRITE	Aggregate permission which implies all write permissions (WRITE and BULK_WRITE)
NONE	Permission which means no permissions

Defines the list of permissions for the role.

serialization?

Specifies how data serialization will be performed by the cache container.

Name	Type	Default	Description
marshaller	string		Fully qualified name of the marshaller to use. It must implement org.infinispan.marshall.StreamingMarshaller
version	string	71	Largest allowable version to use when marshalling internal state. Set this to the lowest version cache instance in your cluster to ensure compatibility of communications. However, setting this too low will mean you lose out on the benefit of improvements in newer versions of the marshaller.

advanced-externalizer*

AdvancedExternalizer provides an alternative way to provide externalizers for marshalling/unmarshalling user defined classes that overcome the deficiencies of the more user-friendly externalizer definition model explained in Externalizer.

Name	Type	Default	Description
class	string		Class of the custom externalizer
id	int		Id of the custom externalizer

jmx?

Defines JMX management details.

Name	Type	Default	Description
domain	string	org.infinispan	If JMX statistics are enabled then all 'published' JMX objects will appear under this name. This is optional, if not specified an object name will be created for you by default.
mbean-server-lookup	string	org.infinispan.jmx.PlatformMBeanServerLookup	Class that will attempt to locate a JMX MBean server to bind to. Defaults to using the platform MBean server.
duplicate-domains	boolean	false	If true, multiple cache manager instances could be configured under the same configured JMX domain. Each cache manager will in practice use a different JMX domain that has been calculated based on the configured one by adding an incrementing index to it.

property*

A jmx property with name and value to be passed to the MBean Server lookup instance.

global-state?

Defines the global state persistence configuration. If this element is not present, global state persistence will be disabled.

persistent-location

Defines the filesystem path where persistent state data which needs to survive container restarts should be stored. The data stored at this location is required for graceful shutdown and restore. Defaults to the user.dir system property which usually is where the application was started. This value should be overridden to a more appropriate location.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	Ignored in embedded mode.
path	string		Defines the path where global state for this cache-container will be stored.

temporary-location?

Defines the filesystem path where temporary state should be stored. Defaults to the value of the java.io.tmpdir system property.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	Ignored in embedded mode.
path	string		Defines the path where global state for this cache-container will be stored.

local-cache

Defines a LOCAL mode cache.

Name	Type	Default	Description
simple-cache	FIXME	false	This cache will be using optimized (faster) implementation that does not support transactions/invocation batching, persistence, custom interceptors, indexing, store-as-binary or compatibility. Also, this type of cache does not support Map-Reduce jobs or Distributed Executor framework.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

local-cache-configuration

Defines a LOCAL mode cache configuration.

Name	Type	Default	Description
simple-cache	FIXME	false	This cache will be using optimized (faster) implementation that does not support transactions/invocation batching, persistence, custom interceptors, indexing, store-as-binary or compatibility. Also, this type of cache does not support Map-Reduce jobs or Distributed Executor framework.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

replicated-cache

Defines a REPL_* mode cache.

Name	Type	Default	Description
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

replicated-cache-configuration

Defines a REPL_* mode cache configuration.

Name	Type	Default	Description
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

invalidation-cache

Defines an INVALIDATION_* mode cache.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

invalidation-cache-configuration

Defines an INVALIDATION_* mode cache configuration.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

distributed-cache

Defines a DIST_* mode cache.

Name	Type	Default	Description
owners	int	2	Number of cluster-wide replicas for each cache entry.
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
capacity-factor	double	1.0	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. Value must be positive. The default is 1
l1-lifespan	long		Maximum lifespan in milliseconds of an entry placed in the L1 cache. By default L1 is disabled unless a positive value is configured for this attribute. If the attribute is not present, L1 is disabled.
l1-cleanup-interval	long	60000	Controls how often a cleanup task to prune L1 tracking data is run. Defaults to 10 minutes.
capacity	float	1.0	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. This is just a suggestion, there is no guarantee that a node with a capacity factor of 2 will have twice as many entries as a node with a capacity factor of 1.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

groups?

Configures grouping of data.

Name	Type	Default	Description
enabled	boolean		Enables or disables grouping.

grouper*

Name	Type	Default	Description
class	string		The class to use to group keys. Must implement org.infinispan.distribution.group.Grouper.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

distributed-cache-configuration

Defines a DIST_* mode cache configuration.

Name	Type	Default	Description
owners	int	2	Number of cluster-wide replicas for each cache entry.
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
capacity-factor	double	1.0	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. Value must be positive. The default is 1
l1-lifespan	long		Maximum lifespan in milliseconds of an entry placed in the L1 cache. By default L1 is disabled unless a positive value is configured for this attribute. If the attribute is not present, L1 is disabled.
l1-cleanup-interval	long	60000	Controls how often a cleanup task to prune L1 tracking data is run. Defaults to 10 minutes.
capacity	float	1.0	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. This is just a suggestion, there is no guarantee that a node with a capacity factor of 2 will have twice as many entries as a node with a capacity factor of 1.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

groups?

Configures grouping of data.

Name	Type	Default	Description
enabled	boolean		Enables or disables grouping.

grouper*

Name	Type	Default	Description
class	string		The class to use to group keys. Must implement org.infinispan.distribution.group.Grouper.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

scattered-cache

Defines a SCATTERED_* mode cache. Since 9.0.

Name	Type	Default	Description
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
capacity	float	1	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. This is just a suggestion, there is no guarantee that a node with a capacity factor of 2 will have twice as many entries as a node with a capacity factor of 1.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.
invalidation-batch-size	integer	128	Threshold for sending batch invalidations. Once a node registers more updated keys, it sends a batch invalidation to all nodes requesting to remove old versions of the entries. The threshold is also used for second batch invalidation of tombstones for removed entries.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

groups?

Configures grouping of data.

Name	Type	Default	Description
enabled	boolean		Enables or disables grouping.

grouper*

Name	Type	Default	Description
class	string		The class to use to group keys. Must implement org.infinispan.distribution.group.Grouper.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

scattered-cache-configuration

Defines a SCATTERED_* mode cache configuration. Since 9.0.

Name	Type	Default	Description
segments	int	256	Number of hash space segments (per cluster). The default value is 256, and should be at least 20 * cluster size.
capacity	float	1	Controls the proportion of entries that will reside on the local node, compared to the other nodes in the cluster. This is just a suggestion, there is no guarantee that a node with a capacity factor of 2 will have twice as many entries as a node with a capacity factor of 1.
consistent-hash-factory	string		The factory to use for generating the consistent hash. Must implement `org.infinispan.distribution.ch.ConsistentHashFactory`. E.g. `org.infinispan.distribution.ch.impl.SyncConsistentHashFactory` can be used to guarantee that multiple distributed caches use exactly the same consistent hash, which for performance reasons is not guaranteed by the default consistent hash factory instance used.
key-partitioner	string		The name of the key partitioner class. Must implement `org.infinispan.distribution.ch.KeyPartitioner`. A custom key partitioner can be used as an alternative to grouping, to guarantee that some keys are located in the same segment (and thus their primary owner is the same node). Since 8.2.
invalidation-batch-size	integer	128	Threshold for sending batch invalidations. Once a node registers more updated keys, it sends a batch invalidation to all nodes requesting to remove old versions of the entries. The threshold is also used for second batch invalidation of tombstones for removed entries.

state-transfer?

The state transfer configuration for distribution and replicated caches.

Name	Type	Default	Description
enabled	boolean	true	If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.
timeout	long	240000	The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.
chunk-size	integer	512	The number of cache entries to batch in each transfer.
await-initial-transfer	boolean	true	If enabled, this will cause the cache to wait for initial state transfer to complete before responding to requests.

groups?

Configures grouping of data.

Name	Type	Default	Description
enabled	boolean		Enables or disables grouping.

grouper*

Name	Type	Default	Description
class	string		The class to use to group keys. Must implement org.infinispan.distribution.group.Grouper.

Name

Type

Default

Description

mode

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

SYNC

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

remote-timeout

long

15000

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.

partition-handling?

Configures the way this cache reacts to node crashes and split brains.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. Enable/disable the partition handling functionality. Defaults to false.

when-split

DENY_READ_WRITES	If the partition does not have all owners for a given segment, both reads and writes are denied for all keys in that segment.
ALLOW_READS	Allows reads for a given key if it exists in this partition, but only allows writes if this partition contains all owners of a segment.
ALLOW_READ_WRITES	Allow entries on each partition to diverge, with conflicts resolved during merge.

ALLOW_READ_WRITES

The type of actions that are possible when a split brain scenario is encountered.

merge-policy

org.infinispan.conflict.MergePolicies$$Lambda$65/456223916

The entry merge policy which should be applied on partition merges.

Name	Type	Default	Description
name	ID		Uniquely identifies this cache within its cache container.
configuration	IDREF		The name of the cache configuration which this configuration inherits from.
start	FIXME		Unused XML attribute
jndi-name	string		Unused XML attribute
module	string		Unused XML attribute
statistics	boolean	false	Determines whether or not the cache should collect statistics. Keep disabled for optimal performance.
statistics-available	boolean	true	If set to false, statistics gathering cannot be enabled during runtime. Keep disabled for optimal performance.
deadlock-detection-spin	long	-1	Deprecated since 9.0, deadlock detection is always disabled.
unreliable-return-values	boolean	false	Specifies whether Infinispan is allowed to disregard the Map contract when providing return values for org.infinispan.Cache#put(Object, Object) and org.infinispan.Cache#remove(Object) methods.

backups?

The state transfer configuration for distribution and replicated caches.

backup*

Configures a specific site where this cache backups data.

Name

Type

Default

Description

site

string

Name of the remote site where this cache backups data.

strategy

ASYNC	Enables asynchronous mode.
SYNC	Enables synchronous mode.

ASYNC

The strategy used for backing up data: "SYNC" or "ASYNC". Defaults to "ASYNC"

failure-policy

IGNORE	Ignore backup failures.
WARN	Warn of backup failures.
FAIL	Fail local operations when a backup failure occurs.
CUSTOM	Invoke a user-specified failure policy (set via the failure-policy-class attribute)

WARN

Decides what the system would do in case of failure during backup. Defaults to "WARN"

timeout

long

10000

The timeout(millis) to be used when backing up data remotely. Defaults to 10 secs.

enabled

boolean

true

If 'false' then no data is backed up to this site. Defaults to 'true'.

two-phase-commit

boolean

false

Configures whether the replication happens in a 1PC or 2PC when using SYNC backup strategy. Defaults to "false". CacheConfigurationException is thrown when used with ASYNC backup strategy.

failure-policy-class

string

If the 'backupFailurePolicy' is set to 'CUSTOM' then this attribute is required and should contain the fully qualified name of a class implementing org.infinispan.xsite.CustomFailurePolicy.

take-offline?

Determines whether this backup is taken offline (ignored) after a certain number of tries.

Name	Type	Default	Description
after-failures	int	0	The number of failed request operations after which this site should be taken offline. Defaults to 0 (never). A negative value would mean that the site will be taken offline after 'min-wait'.
min-wait	long	0	The minimal number of millis to wait before taking this site offline, even in the case 'after-failures' is reached. If smaller or equal to 0, then only 'after-failures' is considered.

state-transfer?

Configures the properties needed to transfer the state for this site.

Name	Type	Default	Description
chunk-size	int	512	If > 0, the state will be transferred in batches of {@code chunkSize} cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.
timeout	long	1200000	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.
max-retries	int	30	The maximum number of retries when a push state command fails. A value <= 0 (zero) mean that the command will not retry. Default value is 30.
wait-time	long	2000	The waiting time (in milliseconds) between each retry. The value should be > 0 (zero). Default value is 2 seconds.

backup-for?

Configures this cache as a backup for a remote cache.

Name	Type	Default	Description
remote-cache	string		The name of the remote cache that backups data here.
remote-site	string		The name of the remote site containing the cache that backups data here.

locking?

The locking configuration of the cache.

Name

Type

Default

Description

isolation

NONE	No locking isolation will be performed. This is only valid in local mode. In clustered mode, READ_COMMITTED will be used instead.
READ_UNCOMMITTED	Unsupported. Actually configures READ_COMMITTED
READ_COMMITTED	Read committed is an isolation level that guarantees that any data read is committed at the moment it is read. However, depending on the outcome of other transactions, successive reads may return different results
REPEATABLE_READ	Repeatable read is an isolation level that guarantees that any data read is committed at the moment it is read and that, within a transaction, successive reads will always return the same data.
SERIALIZABLE	Unsupported. Actually configures REPEATABLE_READ

REPEATABLE_READ

Sets the cache locking isolation level. Infinispan only supports READ_COMMITTED or REPEATABLE_READ isolation level.

striping

boolean

false

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

long

10000

Maximum time to attempt a particular lock acquisition.

concurrency-level

int

32

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

write-skew

boolean

true

(Deprecated) This setting is only applicable in the case of REPEATABLE_READ. When write skew check is set to false, if the writer at commit time discovers that the working entry and the underlying entry have different versions, the working entry will overwrite the underlying entry. If true, such version conflict - known as a write-skew - will throw an Exception. Defaults to false.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
BATCH	Uses batching to group cache operations together.
NON_XA	Cache will enlist within transactions as a javax.transaction.Synchronization
NON_DURABLE_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, without recovery.
FULL_XA	Cache will enlist within transactions as a javax.transaction.xa.XAResource, with recovery.

NONE

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

stop-timeout

long

30000

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.

locking

OPTIMISTIC	Enables Optimistic locking.
PESSIMISTIC	Enables Pessimistic locking.

OPTIMISTIC

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

transaction-manager-lookup

string

org.infinispan.transaction.lookup.GenericTransactionManagerLookup

Configure Transaction manager lookup directly using an instance of TransactionManagerLookup. Calling this method marks the cache as transactional.

complete-timeout

long

60000

The duration (millis) in which to keep information about the completion of a transaction. Defaults to 60000.

reaper-interval

long

30000

The time interval (millis) at which the thread that cleans up transaction completion information kicks in. Defaults to 30000.

auto-commit

boolean

true

If the cache is transactional and transactionAutoCommit is enabled then for single operation transactions the user doesn't need to manually start a transaction, but a transactions is injected by the system. Defaults to true.

protocol

DEFAULT
TOTAL_ORDER

Configures the commit protocol to use.

recovery-cache

string

__recoveryInfoCacheName__

Sets the name of the cache where recovery related information is held. The cache's default name is "__recoveryInfoCacheName__"

notifications

boolean

true

Enables or disables triggering transactional notifications on cache listeners. By default is enabled.

eviction?

The cache eviction configuration.

DEPRECATED: please use memory element instead

Name

Type

Default

Description

strategy

NONE	Never evict entries. This is the default.
UNORDERED	Actually activates LRU.
FIFO	Deprecated. Actually activates LRU.
LRU	Least-Recently Used policy.
LIRS	Low Inter-reference Recency Set. An improved version of LRU which uses cache-locality access information to better decide which data to evict.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.

NONE

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

long

-1

Deprecated since 8.1. Use the size attribute instead.

thread-policy

PIGGYBACK	Fires the eviction events from the same thread which is performing the eviction
DEFAULT	Use the default eviction listener thread policy (PIGGYBACK)

DEFAULT

Threading policy for eviction. Defaults to using the DEFAULT eviction policy.

type

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

COUNT

Specifies whether to use entry count or memory-based approximation to decide when to evict entries.

size

long

-1

Maximum size to use for eviction. When using the COUNT type, this is the maximum number of entries in a cache instance. When using the MEMORY threshold policy, this is the maximum number of allocated bytes used by a cache's datacontainer. A value of -1 means no limit. This is currently limited to 2^48 - 1 in size.

expiration?

The cache expiration configuration.

Name	Type	Default	Description
max-idle	long	-1	Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.
lifespan	long	-1	Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.
interval	long	60000	Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set interval to -1.

compatibility?

The cache compatibility mode configuration.

Name	Type	Default	Description
marshaller	string		A marshaller to use for compatibility conversions.

store-as-binary?

Configures the cache to store data in binary format.

Controls whether when stored in memory, keys and values are stored as references to their original objects, or in a serialized, binary format. There are benefits to both approaches, but often if used in a clustered mode, storing objects as binary means that the cost of serialization happens early on, and can be amortized. Further, deserialization costs are incurred lazily which improves throughput. It is possible to control this on a fine-grained basis: you can choose to just store keys or values as binary, or both. DEPRECATED: please use memory element instead

Name	Type	Default	Description
keys	boolean	true	Specify whether keys are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.
values	boolean	true	Specify whether values are stored as binary or not. Enabled by default if the "enabled" attribute is set to true.

persistence?

Configures the cache's persistence layer.

Name	Type	Default	Description
passivation	boolean	false	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. This gives you the ability to 'overflow' to disk, similar to swapping in an operating system. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration. Defaults to false.

cluster-loader

Defines a cluster cache loader.

Name	Type	Default	Description
remote-timeout	long	15000	The timeout when performing remote calls.

Name	Type	Default	Description
name	string		Unused XML attribute.
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

property*

A cache loader property with name and value.

store

Defines a custom cache store.

Name	Type	Default	Description
class	string		The class name of the cache store implementation.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

file-store

Defines a file-based cache store.

Name	Type	Description
max-entries	int	Sets the maximum number of in-memory mappings between keys and their position in the store. Normally this is unlimited, but to avoid excess memory usage, an upper bound can be configured. If this limit is exceeded, entries are removed permanently using the LRU algorithm both from the in-memory index and the underlying file based cache store. Warning: setting this value may cause data loss.
relative-to	string	Unused XML attribute
path	string	The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.

Name	Type	Default	Description
shared	boolean	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
transactional	boolean	false	This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback.
preload	boolean	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
fetch-state	boolean	false	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
purge	boolean	false	If true, purges this cache store when it starts up.
singleton	boolean	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key
read-only	boolean	false	If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store.
max-batch-size	int	100	The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.

write-behind?

Configures a cache store as write-behind instead of write-through.

Name	Type	Default	Description
modification-queue-size	int	1024	Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries
thread-pool-size	int	1	Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

property*

A cache store property with name and value.

versioning?

Controls whether entries are versioned. Versioning is necessary, for example, when using optimistic transactions in a clustered environment, to be able to perform write-skew checks.

Name

Type

Default

Description

scheme

SIMPLE	A simple versioning scheme that is cluster-aware
NONE	Don't version entries

SIMPLE

(Deprecated) The scheme to use when versioning entries. Can be either SIMPLE or NONE. Defaults to NONE

data-container?

Controls the data container for the cache.

Name	Type	Description
class	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the data container to use
key-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for keys stored in the cache, which provides with custom ways to compare cached keys
value-equivalence	string	DEPRECATED: this is to be removed in a future release Fully qualified class name of the Equivalence class to use for values stored in the cache, which provides with custom ways to compare cached values

property*

Properties passed to the data container

memory?

Controls how the entries are stored in memory

object

Store keys and values as instance variables. Instances of byte[] will be wrapped to ensure equality.

Name	Type	Default	Description
size	long	-1	The size of the eviction cache as a long. Limits the cache to this normal by the amount of entries in the cache.

binary

Store keys and values as byte[] instances. Key and value will be serialized to binary representations.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

off-heap

Store keys and values as byte[] off of the Java heap. Key and value will be serialized to binary representations and stored in native memory as to not take up Java heap. Temporary objects will be put onto Java heap temporarily until processing is completed.

Name

Type

Default

Description

size

long

-1

The size of the eviction cache as a long. If the configured type is COUNT, this will be how many entries can be stored. If the configured type is MEMORY, this will be how much memory in bytes can be stored.

eviction

COUNT	Evicts entries from the cache when a specified count has been set
MEMORY	Evicts entries from the cache when a specified memory usage has been reached. Memory usage is computed using an approximation which is tailored for the HotSpot VM. This can only be used when both key and values are stored as byte arrays. To guarantee only byte arrays are stored it is recommended to run with store as binary for both keys and values

The eviction type to use whether it is COUNT or MEMORY. COUNT will limit the cache based on the number of entries. MEMORY will limit the cache by how much memory the entries use

address-count

int

1048576

How many address pointers to use. This number will be rounded up to a power of two. For optimal performance you will want more address pointers than you expect to have entries. This is similar to the size of an array backing a hash map. Without collisions lookups and writes will be constant time. Each pointer will take up 8 bytes of memory thus the default will use 8 MB of off-heap memory.

indexing?

Defines indexing options for cache

Name

Type

Default

Description

index

NONE	Do not index data. This is the default.
LOCAL	Only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
ALL	Index all data
PRIMARY_OWNER	Only index changes on the primary owner, regardless of it's local or remote.

NONE

The indexing mode of the cache. Defaults to NONE.

auto-config

boolean

false

Whether or not to apply automatic index configuration based on cache type

indexed-entities?

Defines the indexed entity classes

indexed-entity*

Indexed entity class name

property*

Property to pass on to the indexing system

custom-interceptors?

Configures custom interceptors to be added to the cache.

interceptor*

Name	Type	Description
after	string	Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
before	string	Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a ConfigurationException will be thrown when the cache starts.
class	string	A fully qualified class name of the new custom interceptor to add to the configuration.
index	int	Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. A ConfigurationException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
position	string	Specifies a position where to place the new interceptor. Allowed values are FIRST, LAST, and OTHER_THAN_FIRST_OR_LAST

property?

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	false	Enables authorization checks for this cache. Defaults to true if the authorization element is present.
roles			Sets the valid roles required to access this cache.

urn:infinispan:config:9.1

infinispan

jgroups?

stack-file+

threads?

thread-factory*

blocking-bounded-queue-thread-pool*

cached-thread-pool*

scheduled-thread-pool*

cache-container

transport?

security?

authorization?

identity-role-mapper

common-name-role-mapper

cluster-role-mapper

custom-role-mapper

role*

serialization?

advanced-externalizer*

jmx?

property*

global-state?

persistent-location

temporary-location?

local-cache

backups?

backup*

take-offline?

state-transfer?

backup-for?

locking?

transaction?

eviction?

expiration?

compatibility?

store-as-binary?

persistence?

cluster-loader

property*

store

write-behind?

property*

file-store

write-behind?

property*

versioning?

data-container?

property*

memory?

object

binary

off-heap

indexing?

indexed-entities?

indexed-entity*

property*

custom-interceptors?

interceptor*

property?

security?

authorization?

local-cache-configuration

backups?

backup*

take-offline?

state-transfer?

backup-for?

locking?

transaction?

eviction?

expiration?

compatibility?

store-as-binary?

persistence?

cluster-loader

property*

store

write-behind?

property*