Package org.infinispan.configuration.cache

Class StateTransferConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.StateTransferConfigurationBuilder

All Implemented Interfaces:

Builder<StateTransferConfiguration>, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder

public class StateTransferConfigurationBuilder
extends Object
implements Builder<StateTransferConfiguration>

Configures how state is transferred when a cache joins or leaves the cluster. Used in distributed and replication clustered modes.

Since:

5.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
StateTransferConfigurationBuilder	awaitInitialTransfer(boolean b)	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).
Configuration	build()
StateTransferConfigurationBuilder	chunkSize(int i)	The state will be transferred in batches of chunkSize cache entries.
ClusteringConfigurationBuilder	clustering()
StateTransferConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
StateTransferConfigurationBuilder	fetchInMemoryState(boolean b)	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.
protected ConfigurationBuilder	getBuilder()
protected ClusteringConfigurationBuilder	getClusteringBuilder()
HashConfigurationBuilder	hash()	Allows fine-tuning of rehashing characteristics.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
L1ConfigurationBuilder	l1()	Configures the L1 cache behavior in 'distributed' caches instances.
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PartitionHandlingConfigurationBuilder	partitionHandling()	Configures how the cache will react to cluster partitions.
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
StateTransferConfigurationBuilder	read(StateTransferConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StateTransferConfigurationBuilder	stateTransfer()	Configures how state is transferred when a new cache joins the cluster.
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
StateTransferConfigurationBuilder	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.
StateTransferConfigurationBuilder	timeout(long l, TimeUnit unit)	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()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

read, reset

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, query, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

Field Details

builder

protected final ConfigurationBuilder builder

Method Details

fetchInMemoryState

public StateTransferConfigurationBuilder fetchInMemoryState(boolean b)

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.

awaitInitialTransfer

public StateTransferConfigurationBuilder awaitInitialTransfer(boolean b)

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.

chunkSize

public StateTransferConfigurationBuilder chunkSize(int i)

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.

timeout

public StateTransferConfigurationBuilder 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. Must be greater than or equal to 'remote-timeout' in the clustering configuration.

timeout

public StateTransferConfigurationBuilder timeout(long l,
 TimeUnit unit)

This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup. Must be greater than or equal to 'remote-timeout' in the clustering configuration.

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<StateTransferConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public StateTransferConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<StateTransferConfiguration>

Returns:

read

public StateTransferConfigurationBuilder read(StateTransferConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<StateTransferConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

toString

public String toString()

Overrides:

toString in class Object

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<StateTransferConfiguration>

hash

public HashConfigurationBuilder hash()

Description copied from interface: ClusteringConfigurationChildBuilder

Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.

Specified by:

hash in interface ClusteringConfigurationChildBuilder

l1

public L1ConfigurationBuilder l1()

Description copied from interface: ClusteringConfigurationChildBuilder

Configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Specified by:

l1 in interface ClusteringConfigurationChildBuilder

stateTransfer

public StateTransferConfigurationBuilder stateTransfer()

Description copied from interface: ClusteringConfigurationChildBuilder

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

Specified by:

stateTransfer in interface ClusteringConfigurationChildBuilder

partitionHandling

public PartitionHandlingConfigurationBuilder partitionHandling()

Description copied from interface: ClusteringConfigurationChildBuilder

Configures how the cache will react to cluster partitions.

Specified by:

partitionHandling in interface ClusteringConfigurationChildBuilder

getClusteringBuilder

protected ClusteringConfigurationBuilder getClusteringBuilder()

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

@Deprecated(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

query

public QueryConfigurationBuilder query()

Specified by:

query in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder