Package org.infinispan.configuration.cache

Class StateTransferConfiguration

java.lang.Object

org.infinispan.configuration.cache.StateTransferConfiguration

All Implemented Interfaces:

org.infinispan.commons.configuration.attributes.Matchable<StateTransferConfiguration>, BaseConfigurationInfo, ConfigurationInfo

public class StateTransferConfiguration
extends Object
implements org.infinispan.commons.configuration.attributes.Matchable<StateTransferConfiguration>, ConfigurationInfo

Configures how state is retrieved when a new cache joins the cluster. Used with distribution, replication and scattered clustered modes.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field	Description
static org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean>	AWAIT_INITIAL_TRANSFER
static org.infinispan.commons.configuration.attributes.AttributeDefinition<Integer>	CHUNK_SIZE
static org.infinispan.commons.configuration.elements.ElementDefinition	ELEMENT_DEFINITION
static org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean>	FETCH_IN_MEMORY_STATE
static org.infinispan.commons.configuration.attributes.AttributeDefinition<Long>	TIMEOUT

Method Summary

Modifier and Type	Method	Description
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
boolean	awaitInitialTransfer()	If true, this will cause the first call to method CacheManager.getCache() on the joiner node to block and wait until the joining is complete and the cache has finished receiving state from neighboring caches (if fetchInMemoryState is enabled).
int	chunkSize()	The state will be transferred in batches of chunkSize cache entries.
boolean	equals(Object obj)
boolean	fetchInMemoryState()	If true, the cache will fetch data from the neighboring caches when it starts up, so the cache starts 'warm', although it will impact startup time.
org.infinispan.commons.configuration.elements.ElementDefinition	getElementDefinition()
int	hashCode()
long	timeout()	This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.
StateTransferConfiguration	timeout(long l)	This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.
String	toString()

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationInfo

subElements

Field Detail

AWAIT_INITIAL_TRANSFER

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> AWAIT_INITIAL_TRANSFER

FETCH_IN_MEMORY_STATE

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> FETCH_IN_MEMORY_STATE

TIMEOUT

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> TIMEOUT

CHUNK_SIZE

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Integer> CHUNK_SIZE

ELEMENT_DEFINITION

public static final org.infinispan.commons.configuration.elements.ElementDefinition ELEMENT_DEFINITION

Method Detail

fetchInMemoryState

public boolean fetchInMemoryState()

If true, the cache will fetch data from the neighboring caches when it starts up, so the cache starts 'warm', although it will impact startup time.

In distributed mode, state is transferred between running caches as well, as the ownership of keys changes (e.g. because a cache left the cluster). Disabling this setting means a key will sometimes have less than numOwner owners.

timeout

public long timeout()

This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.

timeout

public StateTransferConfiguration timeout(long l)

This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.

chunkSize

public int chunkSize()

The state will be transferred in batches of chunkSize cache entries. If chunkSize is equal to Integer.MAX_VALUE, the state will be transferred in all at once. Not recommended.

awaitInitialTransfer

public boolean awaitInitialTransfer()

If true, this will cause the first call to method CacheManager.getCache() on the joiner node to block and wait until the joining is complete and the cache has finished receiving state from neighboring caches (if fetchInMemoryState is enabled). This option applies to distributed and replicated caches only and is enabled by default. Please note that setting this to false will make the cache object available immediately but any access to keys that should be available locally but are not yet transferred will actually cause a (transparent) remote access. While this will not have any impact on the logic of your application it might impact performance.

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

toString

public String toString()

equals

public boolean equals(Object obj)

hashCode

public int hashCode()