| 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. |
| connect-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 | This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing. It defaults to 64. |
| marshaller | string | Allows you to specify a custom {@link org.infinispan.marshall.Marshaller} implementation to serialize and deserialize user objects. | |
| protocol-version | string | 2.9 | 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. |
remote-server+
connection-pool?
Configuration of the connection pool
| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| exhausted-action |
| 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-time | 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. | ||||||
| eviction-interval | 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-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. |
async-executor?
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 |
property*
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 ).
security?
Hot Rod Security configuration.
authentication?
Hot Rod authentication configuration
| Name | Type | Default | Description |
|---|---|---|---|
| server-name | string | The SASL server name |
plain
| Name | Type | Default | Description |
|---|---|---|---|
| username | string | The username to use when connecting | |
| password | string | The password to use when connecting |
digest
| Name | Type | Default | Description |
|---|---|---|---|
| username | string | The username to use when connecting | |
| password | string | The password to use when connecting | |
| realm | string | The realm to use when connecting |
external
encryption?
Hot Rod encryption configuration
| Name | Type | Default | Description |
|---|---|---|---|
| protocol | string | TLSv1.2 | The TLS/SSL protocol to use. Defaults to TLSv1.2 |
| sni-hostname | string | The SNI hostname to use when connecting. |
keystore?
| Name | Type | Default | Description |
|---|---|---|---|
| certificate-password | string | The password to use when obtaining the certificate from the key store. If not specified, the password will be used. | |
| key-alias | string | If the key store contains multiple keys, use the one with the specified alias |
| Name | Type | Default | Description |
|---|---|---|---|
| filename | string | The path to the key store. | |
| password | string | The password to use to access the key store. | |
| type | string | JKS | The key store type (JKS, JCEKS). |
truststore?
| Name | Type | Default | Description |
|---|---|---|---|
| filename | string | The path to the key store. | |
| password | string | The password to use to access the key store. | |
| type | string | JKS | The key store type (JKS, JCEKS). |
| Name | Type | Default | Description |
|---|---|---|---|
| shared | boolean | false | This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store. |
| transactional | boolean | false | This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and cache's transactions rollingback. |
| preload | boolean | false | If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process. |
| fetch-state | boolean | false | If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. |
| purge | boolean | false | If true, purges this cache store when it starts up. |
| singleton | boolean | false | If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. Deprecated: A shared store should be used instead, as this limits store writes to the primary owner of a key |
| read-only | boolean | false | If true, the cache store will only be used to load entries. Any modifications made to the caches will not be applied to the store. |
| max-batch-size | int | 100 | The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch. |
write-behind?
Configures a cache store as write-behind instead of write-through.
| Name | Type | Default | Description |
|---|---|---|---|
| modification-queue-size | int | 1024 | Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through. until it can accept new entries |
| thread-pool-size | int | 1 | Size of the thread pool whose threads are responsible for applying the modifications to the cache store. |
| fail-silently | boolean | false | If true, the async store attempts to perform write operations only as many times as configured with `connection-attempts` in the PersistenceConfiguration. If all attempts fail, the errors are ignored and the write operations are not executed on the store. If false, write operations that fail are attempted again when the underlying store becomes available. If the modification queue becomes full before the underlying store becomes available, an error is thrown on all future write operations to the store until the modification queue is flushed. The modification queue is not persisted. If the underlying store does not become available before the Async store is stopped, queued modifications are lost. |
property*
A cache store property with name and value.