urn:infinispan:server:core:9.3

transport?

Overrides the transport characteristics for this cache container.

Name	Type	Default	Description
channel	string		Defines the channel used for this transport.
stack	string		Defines the jgroups stack used by the transport. Deprecated: please use the channel attribute instead.
cluster	string		Defines the name for the underlying group communication cluster. Deprecated: please use the channel attribute instead.
executor	string		Defines the executor used for asynchronous transport communication. Deprecated: please use the transport-thread-pool element instead.
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.
remote-command-executor	string		Defines the executor used for processing remote (non-total order) commands. Deprecated: please use the remote-command-thread-pool element instead.
strict-peer-to-peer	boolean	false	Makes clustered operations fail with NamedCacheNotFoundException if the named cache does not exist on remote nodes. If set to false, operations will succeed but it will be logged on the caller that the operation did not succeed on certain nodes due to the named cache not being available. This behaviour is applicable only to replicated caches. Defaults to false.
total-order-executor	string		Defines the executor used for processing remote total order commands. Deprecated.
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.

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.

global-state?

Defines the global state configuration.

persistent-location?

Defines the path where global state for this cache-container will be stored. The data stored at this location is required for graceful shutdown and restore. This path must NOT be shared among multiple containers.

Name	Type	Default	Description
relative-to	string	jboss.server.temp.dir	The base directory in which to store the state
path	string		Defines the path where state for this cache-container will be stored.

shared-persistent-location?

Defines the path where shared global state for this cache-container will be stored. This path may be shared across multiple containers.

Name	Type	Default	Description
relative-to	string	jboss.server.temp.dir	The base directory in which to store the state
path	string		Defines the path where state for this cache-container will be stored.

temporary-location?

Defines the path which will be used to store temporary data.

Name	Type	Default	Description
relative-to	string	jboss.server.temp.dir	The base directory in which to store the state
path	string		Defines the path where state for this cache-container will be stored.

immutable-configuration-storage

An immutable configuration storage.

volatile-configuration-storage

A non-persistent configuration storage.

overlay-configuration-storage

A persistent configuration storage which saves runtime configurations to the persistent-location.

managed-configuration-storage

A configuration storage which uses the server configuration model for configuration persistence. Currently only implemented for standalone deployments.

custom-configuration-storage

Uses a custom configuration storage implementation.

Name	Type	Default	Description
class	string		Class of the custom configuration storage implementation.

async-operations-thread-pool?

Defines a thread pool used for asynchronous operations.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

expiration-thread-pool?

Defines a thread pool used for expiration.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

listener-thread-pool?

Defines a thread pool used for asynchronous cache listener notifications.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

persistence-thread-pool?

Defines a thread pool used for interacting with the persistent store.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

remote-command-thread-pool?

Defines a thread pool used for executing remote commands.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

state-transfer-thread-pool?

Defines a thread pool used for state transfer.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

transport-thread-pool?

Defines a thread pool used for asynchronous transport communication.

Name	Type	Description
min-threads	int	Minimum thread pool size for the thread pool.
max-threads	int	Maximum thread pool size for the thread pool.
queue-length	int	Maximum queue length for the thread pool.
keepalive-time	long	Timeout in milliseconds to remove idle thread from the pool.

modules?

A list of zero or more module dependencies to make available to the global ClassLoader of the cache container.

module

A module dependency specification.

Name	Type	Default	Description
name			The dependency module name (required), which consists of one or more dot (.)-separated segments. Each segment must begin and end with an alphanumeric or underscore (_), and may otherwise contain alphanumerics, underscores, and hyphens (-).
slot		main	The dependency module version slot (optional). A slot may consist of one or more alphanumerics, hyphens (-), underscores (_), plus signs (+), asterisks (*), or dots (.).

local-cache-configuration

Defines a LOCAL mode cache configuration.

Name	Type	Default	Description
simple-cache	boolean	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

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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

Defines a LOCAL mode cache.

Name	Type	Default	Description
simple-cache	boolean	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

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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.

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.

partition-handling?

The partition handling configuration for distribution and replicated caches.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. If enabled, the cache will enter degraded mode when it loses too many nodes.

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

NONE

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

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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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.

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.

partition-handling?

The partition handling configuration for distribution and replicated caches.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. If enabled, the cache will enter degraded mode when it loses too many nodes.

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

NONE

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

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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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 recommended value is 10 * cluster size. The default value is 80
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	0	Maximum lifespan in milliseconds of an entry placed in the L1 cache. Defaults to 0 which means L1 is disabled.

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.

partition-handling?

The partition handling configuration for distribution and replicated caches.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. If enabled, the cache will enter degraded mode when it loses too many nodes.

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

NONE

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

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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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 recommended value is 10 * cluster size. The default value is 80
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	0	Maximum lifespan in milliseconds of an entry placed in the L1 cache. Defaults to 0 which means L1 is disabled.

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.

partition-handling?

The partition handling configuration for distribution and replicated caches.

Name

Type

Default

Description

enabled

boolean

Deprecated, use type instead. If enabled, the cache will enter degraded mode when it loses too many nodes.

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

NONE

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

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.

Name

Type

Default

Description

name

string

Uniquely identifies this cache within its cache container.

configuration

string

The name of the cache configuration which this configuration inherits from.

start

EAGER	Whether to start the component on initialization.
LAZY	Whether to start the component on-demand.

LAZY

Should this cache be started on server startup, or lazily when requested by a service or deployment.

batching

boolean

false

Enables invocation batching for this cache. Defaults to false.

jndi-name

string

The jndi name to which to bind this cache. If undefined, the cache will be bound to: java:jboss/infinispan/cache/container-name/cache-name

module

string

Defines the module whose class loader should be used when building this cache, if different from the enclosing cache container. Deprecated: This attribute is currently ignored and usages will cause a warning to be logged. It will be removed in next major version.

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.

backups?

The cross-site backup configuration.

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.

WARN

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

timeout

long

15000

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'.

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.

encoding?

The cache encoding configuration.

Defines encoding for keys and values of the cache.

key?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

value?

Describes the content-type and encoding.

Name	Type	Default	Description
media-type	string

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. Defaults to READ_COMMITTED. When using REPEATABLE_READ with optimistic locking, write skew checking will be enabled.

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.

transaction?

The cache transaction configuration.

Name

Type

Default

Description

mode

NONE	Cache will not enlist within transactions.
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, 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.

notifications

boolean

true

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

memory?

The cache memory configuration.

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.

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

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

FIXME

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

strategy

NONE	Never evict entries. This is the default.
MANUAL	Eviction will be performed manually. Equivalent internally to NONE.
REMOVE	Eviction will be performed automatically to ensure that "older" entries are removed to make room for new entries.
EXCEPTION	Eviction is not performed and instead when the container is full exceptions will prevent new entries from being written to the container. This cache must be transactional and now allow for commit optimizations that would prevent it from performing a two phase commit.
UNORDERED	Deprecated. Activates REMOVE policy.
FIFO	Deprecated. Activates REMOVE policy.
LRU	Deprecated. Activates REMOVE policy.
LIRS	Deprecated. Activates REMOVE policy.

The eviction strategy to use. This determines if eviction is even enabled or if it has a different variant.

address-count

int

1048576

How many address pointers to use. 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.

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
enabled	boolean	false	Enables compatibility mode for this cache. Disabled by default.
marshaller	string		A marshaller to use for compatibility conversions.

cluster-loader

Defines a cluster cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

loader

Defines a custom cache loader.

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

Name	Type	Default	Description
name	string		Uniquely identifies this loader.
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.

file-store

Defines a file-based cache store.

Name	Type	Default	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	jboss.server.data.dir	The base directory in which to store the cache state.
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
name	string		Uniquely identifies this store.
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.
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. 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.
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.

string-keyed-jdbc-store

Defines a database cache store accessed via JDBC using string-based keys.

string-keyed-table?

Defines the table used to store cache entries.

Name	Type	Default	Description
prefix	string	ispn_entry	Defines the prefix prepended to the cache name used when composing the name of the cache entry table.

Name	Type	Default	Description
fetch-size	int	100	The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batch-size	int	100	The statement batch size used when modifying this table.
create-on-start	boolean	true	Determines whether database tables should be created by the store on startup.
drop-on-exit	boolean	false	Determines whether database tables should be dropped by the store on shutdown.

id-column?

Defines the column in which to store the cache key or bucket id.

Name	Type	Default	Description
name	string	id	The name of the column used to store the cache key or bucket id.
type	string	VARCHAR	The type of the column used to store the cache key or bucket id.

data-column?

Defines the column in which to store the cache entry or bucket.

Name	Type	Default	Description
name	string	datum	The name of the column used to store the cache entry or bucket.
type	string	BINARY	The type of the column used to store the cache entry or bucket.

timestamp-column?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name	Type	Default	Description
name	string	version	The name of the column used to store the cache entry or bucket timestamp.
type	string	BIGINT	The type of the column used to store the cache entry or bucket timestamp.

Name

Type

Default

Description

datasource

string

Defines the jndi name of the datasource.

dialect

ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE

Defines the JDBC dialect.

db-major-version

nonNegativeInteger

Defines the major version of the database.

db-minor-version

nonNegativeInteger

Defines the minor version of the database.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rocksdb-store

Defines a RocksDB cache store.

Name	Type	Default	Description
relative-to	string	jboss.server.data.dir	The base directory in which to store the cache state.
path	string		The path within "relative-to" in which to store the cache state. If undefined, the path defaults to the cache container name.
block-size	integer		Cache store block size.
cache-size	long		Cache size for the cache store.
clear-threshold	integer		Cache store cache clear threshold.

expiration?

Defines the expiration settings for the RocksDB cache store.

Name	Type	Default	Description
path	string		The base directory in which to store expired cache state.
queue-size	integer	10000	Expired entry queue size.

compression?

Defines the data compression to use in the RocksDB store.

Name

Type

Default

Description

type

NONE	No compression.
SNAPPY	Snappy compression.
ZLIB	ZLib compression.
BZLIB2	BZLib 2 compression.
LZ4	LZ4 compression.
LZ4HC	LZ4HC compression.

NONE

The type of compression to be used by RocksDB store.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

remote-store

Defines a remote cache store accessed via HotRod.

Name	Type	Default	Description
cache	string		The name of the remote cache. If undefined, the default cache will be used.
socket-timeout	long	60000	Enable/disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.
hotrod-wrapping	boolean	false	Ensures that, when entries are retrieved from the remote store, they will be wrapped in a format suitable for serving via HotRod. This flag must be enabled when performing a rolling upgrade
raw-values	boolean	false	Enables the storage of data on the remote server in "raw" format as opposed to wrapping the entries in InternalCacheEntry. This will make the remote cache interoperable between direct RemoteCacheManager clients and RemoteCacheStore stores
protocol-version	string		This property defines the protocol version that this client should use.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

authentication?

plain

Uses PLAIN authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string

digest

Uses DIGEST-MD5 authentication with the supplied credentials.

Name	Type	Default	Description
username	string
password	string
realm	string

external

Uses EXTERNAL authentication, with credentials supplied by the encrypted transport client certificate.

encryption?

Name	Type	Default	Description
security-realm	FIXME		A security realm which supplies a truststore for identifying the remote servers. If client authentication is required, then the security realm must also provide an identity keystore.
sni-hostname	FIXME		An optional SNI hostname for identifying the remote server.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

rest-store

Defines a remote cache store accessed via REST.

Name	Type	Default	Description
append-cache-name-to-path	boolean	false	Whether to append the name of the cache to the path.
path	string	/rest/___defaultcache	The path portion of the URI of the remote REST endpoint.
max-content-length	int	10485760	The maximum allowed content length of a POST/PUT request.

remote-server+

Name	Type	Default	Description
outbound-socket-binding	string		An outbound socket binding for a remote server.

connection-pool+

Name	Type	Default	Description
buffer-size	int	8192	The size of the socket buffer.
connection-timeout	int	60000	A connection timeout for remote cache communication.
max-connections-per-host	int	4	The maximum number of connections per host.
max-total-connections	int	20	The maximum number of total connections.
socket-timeout	int	60000	A socket timeout for remote cache communication.
tcp-no-delay	boolean	true	Enable/disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Name	Type	Default	Description
name	string		Uniquely identifies this store.
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.
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. 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.
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.

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

security?

Configures cache-level security.

authorization?

Configures authorization for this cache.

Name	Type	Default	Description
enabled	boolean	true	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.

counters?

Defines counters.

Name

Type

Default

Description

num-owners

int

2

Sets the number of counter’s copies to keep cluster-wide. It must be positive and its default value is 2.

reliability

AVAILABLE	All partitions are able to read and update the counter’s value.
CONSISTENT	Only the primary partition (majority of nodes) will be able to read and update the counter’s value. The remaining partitions can only read its value.

AVAILABLE

Sets the counter’s update behavior in a network partition. Default value is AVAILABLE

strong-counter*

Defines strong counter

lower-bound?

The lower bound for this strong counter

Name	Type	Default	Description
value	long		Counter lower bound

upper-bound?

The upper bound for this strong counter

Name	Type	Default	Description
value	long		Counter upper bound

Name

Type

Default

Description

name

string

Counter name

initial-value

long

0

Counter initial value. Default is 0 (zero)

storage

VOLATILE	The counter’s value is only available in memory. The value will be lost when a cluster is shutdown.
PERSISTENT	The counter’s value is stored in a private and local persistent store. The value is kept when the cluster is shutdown and restored after a restart.

VOLATILE

Sets the counter’s behavior when the cluster is shutdown and restarted. Default value is VOLATILE.

weak-counter*

Defines strong counter

Name	Type	Default	Description
concurrency-level	long	64	Sets the number of concurrent updates. Its value must be positive and the default value is 64.

Name

Type

Default

Description

name

string

Counter name

initial-value

long

0

Counter initial value. Default is 0 (zero)

storage

VOLATILE	The counter’s value is only available in memory. The value will be lost when a cluster is shutdown.
PERSISTENT	The counter’s value is stored in a private and local persistent store. The value is kept when the cluster is shutdown and restored after a restart.

VOLATILE

Sets the counter’s behavior when the cluster is shutdown and restarted. Default value is VOLATILE.

urn:infinispan:server:core:9.3

subsystem

cache-container

transport?

security?

authorization?

identity-role-mapper

common-name-role-mapper

cluster-role-mapper

custom-role-mapper

role*

global-state?

persistent-location?

shared-persistent-location?

temporary-location?

immutable-configuration-storage

volatile-configuration-storage

overlay-configuration-storage

managed-configuration-storage

custom-configuration-storage

async-operations-thread-pool?

expiration-thread-pool?

listener-thread-pool?

persistence-thread-pool?

remote-command-thread-pool?

state-transfer-thread-pool?

transport-thread-pool?

modules?

module

local-cache-configuration

backups?

backup+

take-offline?

state-transfer?

backup-for?

encoding?

key?

value?

locking?

transaction?

memory?

object

binary

off-heap

expiration?

compatibility?

cluster-loader

property*

store

write-behind?

property*

loader

property*

file-store

write-behind?

property*

string-keyed-jdbc-store

string-keyed-table?

id-column?

data-column?

timestamp-column?

write-behind?

property*

rocksdb-store

expiration?

compression?

write-behind?

property*

remote-store

remote-server+

authentication?

plain

digest

external

encryption?

write-behind?

property*

rest-store

remote-server+

connection-pool+