infinispan
Root of Infinispan configuration. Infinispan configuration element can optionally have multiple
namedCache child elements. Each namedCache builds up on a template provided by default cache. namedCache has
the exact same XML structure as default cache and is therefore omitted from this reference. Child elements are <global>,<default>.
global
Defines global configuration shared among all cache instances. Parent element is <infinispan>. Child elements are <globalJmxStatistics>,<replicationQueueScheduledExecutor>,<transport>,<asyncTransportExecutor>,<serialization>,<shutdown>,<evictionScheduledExecutor>,<asyncListenerExecutor>.
globalJmxStatistics
Determines global JMX settings for all cache instances. Parent element is <global>.
Attribute | Type | Default | Description |
allowDuplicateDomains |
boolean |
false |
If true, multiple cache manager instances could be configured under the same JMX domain |
enabled |
boolean |
false |
Toggle to enable/disable exposing Infinispan objects to JMX |
mBeanServerLookup |
string |
org.infinispan.jmx.PlatformMBeanServerLookup |
Fully qualified name of class that will attempt to find JMX MBean server |
jmxDomain |
string |
infinispan |
JMX domain name where all relevant JMX exposed objects will be bound |
replicationQueueScheduledExecutor
Executor for listeners.Transport executor.Eviction executor.Executor for replication. Parent element is <global>. Child elements are <properties>.
Attribute | Type | Default | Description |
factory |
string |
|
Executor fully qualified class name |
Property | Description |
maxThreads |
Number of threads for this executor |
threadNamePrefix |
Name prefix for threads created in this executor |
transport
Determines Infinispan transport type and accompanying properties. Parent element is <global>. Child elements are <properties>.
Attribute | Type | Default | Description |
clusterName |
string |
Infinispan-Cluster |
Cluster name where all cache instances defined are connected |
nodeName |
string |
null |
Node name for the underlying transport channel |
distributedSyncTimeout |
long |
60000 |
todo |
transportClass |
string |
org.infinispan.remoting.transport.jgroups.JGroupsTransport |
Fully qualified name of a class that implements network transport |
asyncTransportExecutor
Executor for listeners.Transport executor.Eviction executor.Executor for replication. Parent element is <global>. Child elements are <properties>.
Attribute | Type | Default | Description |
factory |
string |
|
Executor fully qualified class name |
Property | Description |
maxThreads |
Number of threads for this executor |
threadNamePrefix |
Name prefix for threads created in this executor |
serialization
Serialization and marshalling settings. Parent element is <global>.
Attribute | Type | Default | Description |
marshallerClass |
string |
org.infinispan.marshall.VersionAwareMarshaller |
Fully qualified name of a class that marshalls objects between cache nodes |
version |
string |
4.0 |
Marshalling serialization version |
shutdown
Determines shutdown hook settings.
By default a shutdown hook is registered even if no MBean server (apart from the JDK default) is detected. Parent element is <global>.
Attribute | Type | Default | Description |
hookBehavior |
shutdownHookBehavior * (DEFAULT|REGISTER|DONT_REGISTER) |
DEFAULT |
Behavior of the JVM shutdown hook registered by the cache |
evictionScheduledExecutor
Executor for listeners.Transport executor.Eviction executor.Executor for replication. Parent element is <global>. Child elements are <properties>.
Attribute | Type | Default | Description |
factory |
string |
|
Executor fully qualified class name |
Property | Description |
maxThreads |
Number of threads for this executor |
threadNamePrefix |
Name prefix for threads created in this executor |
asyncListenerExecutor
Executor for listeners.Transport executor.Eviction executor.Executor for replication. Parent element is <global>. Child elements are <properties>.
Attribute | Type | Default | Description |
factory |
string |
|
Executor fully qualified class name |
Property | Description |
maxThreads |
Number of threads for this executor |
threadNamePrefix |
Name prefix for threads created in this executor |
default
Configures the default cache and acts as a template for other named caches defined.Configures a named cache that builds up on template provided by default cache. Parent element is <infinispan>. Child elements are <transaction>,<invocationBatching>,<loaders>,<unsafe>,<jmxStatistics>,<clustering>,<deadlockDetection>,<lazyDeserialization>,<locking>,<expiration>,<eviction>,<customInterceptors>.
Attribute | Type | Default | Description |
name |
string |
null |
Cache name if this is a namedCache |
transaction
Defines transactional (JTA) characteristics of the cache. Parent element is <default>.
Attribute | Type | Default | Description |
useEagerLocking |
boolean |
false |
If true, eagerly lock cache keys across cluster instead of during two-phase prepare/commit phase |
syncRollbackPhase |
boolean |
false |
If true, rollback phase will be done as a synchronous call |
syncCommitPhase |
boolean |
false |
If true, commit phase will be done as a synchronous call |
transactionManagerLookupClass |
string |
org.infinispan.transaction.lookup.GenericTransactionManagerLookup |
Fully qualified class name of a class that is supposed to obtain reference to a transaction manager |
invocationBatching
Defines whether invocation batching is allowed in this cache instance. Parent element is <default>.
Attribute | Type | Default | Description |
enabled |
boolean |
false |
Toggle switch |
loaders
Holds the configuration of the cache loader chain. Parent element is <default>. Child elements are <loader>.
Attribute | Type | Default | Description |
preload |
boolean |
false |
If true, performs a preload on the cache loader |
passivation |
boolean |
false |
If true, activates entries that have been passivated to a store by loading
them into memory as well as writes evicted entries back to the store |
shared |
boolean |
false |
If true, the node that makes a modification is the only one who writes it to
the store using the relevant cache loader. |
loader
Responsible for loading/storing cache data from/to an external source. Parent element is <loaders>. Child elements are <async>,<properties>,<singletonStore>.
Attribute | Type | Default | Description |
class |
string |
N/A |
Fully qualified name of a cache loader class |
purgeOnStartup |
boolean |
false |
If true, purge node state on startup |
ignoreModifications |
boolean |
false |
If true, any operation that modifies the cache store (remove, clear, store...etc) won't be applied to it |
purgeSynchronously |
boolean |
false |
If true, CacheStore#purgeExpired() call will be done synchronously |
fetchPersistentState |
boolean |
false |
If true, fetch persistent state on state transfer |
async
Configuration for the async cache loader. Parent element is <loader>.
Attribute | Type | Default | Description |
enabled |
boolean |
false |
If true, modifications are stored in the cache store asynchronously. |
threadPoolSize |
int |
1 |
Size of the thread pool whose threads are responsible for applying the modifications. |
mapLockTimeout |
long |
5000 |
Lock timeout for access to map containing latest state. |
singletonStore
SingletonStore is a delegating cache store used for situations when only one
instance should interact with the underlying store. The coordinator of the cluster will be responsible for
the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always
delegates reads to the real CacheStore. Parent element is <loader>.
Attribute | Type | Default | Description |
pushStateTimeout |
long |
10000 |
If pushStateWhenCoordinator is true, the in-memory state transfer to cache store timeout |
pushStateWhenCoordinator |
boolean |
true |
If true and the node becomes the coordinator, the in-memory state transfer
to the underlying cache store is initiated |
enabled |
boolean |
false |
If true, the relevant cache store is turned into singleton store |
unsafe
Allows you to tune various unsafe or non-standard characteristics. Certain operations
such as Cache.put() that are supposed to return the previous value associated with the specified key according
to the java.util.Map contract will not fulfill this contract if unsafe toggle is turned on. Use with care.
See details at http://www.jboss.org/community/wiki/infinispantechnicalfaqs Parent element is <default>.
Attribute | Type | Default | Description |
unreliableReturnValues |
boolean |
false |
Toggle to enable/disable return value fetching |
jmxStatistics
Defines how JMX components are bound to an MBean server. Parent element is <default>.
Attribute | Type | Default | Description |
enabled |
boolean |
false |
Toggle switch |
clustering
Defines clustering characteristics of the cache. Parent element is <default>. Child elements are <sync>,<l1>,<stateRetrieval>,<async>,<hash>.
Attribute | Type | Default | Description |
mode |
string |
LOCAL |
Cache replication mode (LOCAL|INVALIDATION|REPLICATION|DISTRIBUTION) |
sync
Specifies that network communications are synchronous.
Characteristics of this can be tuned here. Parent element is <clustering>.
Attribute | Type | Default | Description |
replTimeout |
long |
15000 |
Timeout for synchronous requests |
l1
Enables and defines details of the L1 cache.
Only used with the 'distributed' cache mode, and otherwise ignored. Parent element is <clustering>.
Attribute | Type | Default | Description |
enabled |
boolean |
true |
Toggle to enable/disable L1 cache |
onRehash |
boolean |
true |
Toggle to enable/disable populating L1 cache after rehash |
lifespan |
long |
600000 |
Maximum lifespan of an entry in L1 cache |
stateRetrieval
Configures how state retrieval is performed on new caches in a cluster. Parent element is <clustering>.
Attribute | Type | Default | Description |
initialRetryWaitTime |
long |
500 |
Initial wait time when backing off before retrying state transfer retrieval |
retryWaitTimeIncreaseFactor |
int |
2 |
Wait time increase factor over successive state retrieval backoffs |
numRetries |
int |
5 |
Number of state retrieval retries |
timeout |
long |
10000 |
Timeout for state transfer |
fetchInMemoryState |
boolean |
false |
If true, a new cache node with initiate a state transfer upon join |
async
Specifies that network communications are asynchronous.
Characteristics of this can be tuned here. Parent element is <clustering>.
Attribute | Type | Default | Description |
replQueueInterval |
long |
5000 |
Interval to take requests of the queue |
useReplQueue |
boolean |
false |
Toggle to enable/disable queue |
asyncMarshalling |
boolean |
true |
Toggle to enable/disable asynchronous marshalling |
replQueueMaxElements |
int |
1000 |
Maximum allowed number of requests in a queue |
hash
Allows fine-tuning of rehashing characteristics.
Only used with the 'distributed' cache mode, and otherwise ignored. Parent element is <clustering>.
Attribute | Type | Default | Description |
rehashWait |
long |
60000 |
Maximum rehash time |
rehashRpcTimeout |
long |
600000 |
Rehashing timeout |
class |
string |
N/A |
Class name of a hashing algorithm |
numOwners |
int |
2 |
Number of neighbour nodes in rehash task |
deadlockDetection
Enables or disables, and tunes, deadlock detection. Parent element is <default>.
Attribute | Type | Default | Description |
spinDuration |
long |
100 |
Time period that determines how often is lock acquisition attempted
within maximum time allowed to acquire a particular lock |
enabled |
boolean |
false |
Toggle to enable/disable deadlock detection |
lazyDeserialization
Defines lazy deserialization characteristics of the cache. Parent element is <default>.
Attribute | Type | Default | Description |
enabled |
boolean |
false |
Toggle switch |
locking
Defines locking characteristics of the cache. Parent element is <default>.
Attribute | Type | Default | Description |
useLockStriping |
boolean |
true |
Toggle to enable/disable shared locks across all
elements that need to be locked |
concurrencyLevel |
int |
500 |
Concurrency level for number of stripes to create in lock striping |
isolationLevel |
isolationLevel * (NONE|SERIALIZABLE|REPEATABLE_READ|READ_COMMITTED|READ_UNCOMMITTED) |
READ_COMMITTED |
Isolation level |
lockAcquisitionTimeout |
long |
10000 |
Maximum time to attempt particular lock acquisition |
writeSkewCheck |
boolean |
false |
If true, write skews are tested and exceptions
are thrown if detected (only for IsolationLevel#REPEATABLE_READ) |
expiration
Enables or disables expiration, and configures characteristics accordingly. Parent element is <default>.
Attribute | Type | Default | Description |
lifespan |
long |
-1 |
Maximum lifespan of a cache entry |
maxIdle |
long |
-1 |
Maximum time between two subsequent accesses to a particular cache entry |
eviction
Enables or disables eviction, and configures characteristics accordingly. Parent element is <default>.
Attribute | Type | Default | Description |
strategy |
evictionStrategy * (NONE|FIFO|LRU) |
NONE |
Eviction strategy |
wakeUpInterval |
long |
5000 |
Interval between subsequent eviction runs |
maxEntries |
int |
-1 |
Maximum number of entries in a cache instance |
customInterceptors
Configures custom interceptors to be added to the cache. Parent element is <default>. Child elements are <interceptor>.
interceptor
Holds information about the custom interceptors defined in the configuration file. Parent element is <customInterceptors>. Child elements are <properties>.
Attribute | Type | Default | Description |
after |
string |
null |
Position this interceptor after the inteceptor specified by intereceptor's fully qualified class name |
class |
string |
N/A |
Fully qualified intereceptor class name |
position |
position * (FIRST|LAST) |
null |
Position this interceptor as either FIRST or LAST intereceptor |
before |
string |
null |
Position this interceptor before the inteceptor specified by intereceptor's fully qualified class name |
index |
int |
-1 |
Position this interceptor at the specified valid index of the interceptor chain |
Copyright © 2009
JBoss, a division of Red Hat. All Rights Reserved.