Name Type Default Description
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
balancing-strategy string org.infinispan.client.hotrod.impl.transport.tcp.RoundRobinBalancingStrategy For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
connection-timeout int 60000 This property defines the maximum socket connect timeout before giving up connecting to the server.
force-return-values boolean false Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
key-size-estimate int 64 The class name of the driver used for connecting to the database.
marshaller string Allows you to specify a custom {@link org.infinispan.marshall.Marshaller} implementation to serialize and deserialize user objects.
ping-on-start boolean true If true, a ping request is sent to a back end server in order to fetch cluster's topology.
protocol-version string 1.1 This property defines the protocol version that this client should use. Defaults to 1.1. Other valid values include 1.0.
cache string The name of the remote cache in the remote infinispan cluster, to which to connect to. If unspecified, the default cache will be used
transport-factory string Controls which transport to use. Currently only the TcpTransport is supported.
value-size-estimate int 512 This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.



Configuration of the connection pool

Name Type Default Description
EXCEPTION An exception will be thrown to the calling user
WAIT The caller will block (invoke waits until a new or idle connections is available.
CREATE_NEW A new persistent connection will be created and returned (essentially making maxActive meaningless.)
WAIT Specifies what happens when asking for a connection from a server's pool, and that pool is exhausted.
max-active int -1 Controls the maximum number of connections per server that are allocated (checked out to client threads, or idle in the pool) at one time. When non-positive, there is no limit to the number of connections per server. When maxActive is reached, the connection pool for that server is said to be exhausted. The default setting for this parameter is -1, i.e. there is no limit.
max-idle int -1 Controls the maximum number of idle persistent connections, per server, at any time. When negative, there is no limit to the number of connections that may be idle per server. The default setting for this parameter is -1.
max-total int -1 Sets a global limit on the number persistent connections that can be in circulation within the combined set of servers. When non-positive, there is no limit to the total number of persistent connections in circulation. When maxTotal is exceeded, all connections pools are exhausted. The default setting for this parameter is -1 (no limit).
min-idle int 1 Sets a target value for the minimum number of idle connections (per server) that should always be available. If this parameter is set to a positive number and timeBetweenEvictionRunsMillis > 0, each time the idle connection eviction thread runs, it will try to create enough idle instances so that there will be minIdle idle instances available for each server. The default setting for this parameter is 1.
time-between-eviction-runs long 120000 Indicates how long the eviction thread should sleep before "runs" of examining idle connections. When non-positive, no eviction thread will be launched. The default setting for this parameter is 2 minutes.
min-evictable-idle-time long 1800000 Specifies the minimum amount of time that an connection may sit idle in the pool before it is eligible for eviction due to idle time. When non-positive, no connection will be dropped from the pool due to idle time alone. This setting has no effect unless timeBetweenEvictionRunsMillis > 0. The default setting for this parameter is 1800000(30 minutes).
test-while-idle boolean true Indicates whether or not idle connections should be validated by sending an TCP packet to the server, during idle connection eviction runs. Connections that fail to validate will be dropped from the pool. This setting has no effect unless timeBetweenEvictionRunsMillis > 0. The default setting for this parameter is true.


Configuration for the executor service used for asynchronous work on the Transport, including asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().

Name Type Default Description
factory string Fully qualified class name of the ExecutorFactory to use. Must implement org.infinispan.executors.ExecutorFactory


Add key/value property pair to this factory configuration. Example properties include "maxThreads" which sets the maximum number of threads for this executor and "threadNamePrefix" which sets the thread name prefix for threads created by this executor ( default values can be found at https://docs.jboss.org/author/display/ISPN/Default+Values+For+Property+Based+Attributes ).

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


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

Name Type Default Description
flush-lock-timeout int 1 Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.
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
shutdown-timeout int 25000 Timeout in milliseconds to stop the cache store.
thread-pool-size int 1 Size of the thread pool whose threads are responsible for applying the modifications to the cache store.


A cache store property with name and value.

Expand/Collapse All