Package org.infinispan.configuration.cache

Class XSiteStateTransferConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.XSiteStateTransferConfigurationBuilder

All Implemented Interfaces:

Builder<XSiteStateTransferConfiguration>, ConfigurationChildBuilder

public class XSiteStateTransferConfigurationBuilder
extends Object
implements Builder<XSiteStateTransferConfiguration>

Configuration Builder to configure the state transfer between sites.

Since:

7.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Constructor Summary

Constructors

Constructor	Description
XSiteStateTransferConfigurationBuilder(ConfigurationBuilder builder, BackupConfigurationBuilder backupConfigurationBuilder)

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
final BackupConfigurationBuilder	backup()
Configuration	build()
final XSiteStateTransferConfigurationBuilder	chunkSize(int chunkSize)	If > 0, the state will be transferred in batches of chunkSize cache entries.
ClusteringConfigurationBuilder	clustering()
XSiteStateTransferConfiguration	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()
protected ConfigurationBuilder	getBuilder()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
final XSiteStateTransferConfigurationBuilder	maxRetries(int maxRetries)	The maximum number of retries when a push state command fails.
MemoryConfigurationBuilder	memory()
final XSiteStateTransferConfigurationBuilder	mode(XSiteStateTransferMode mode)	The cross-site state transfer mode.
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
Builder<XSiteStateTransferConfiguration>	read(XSiteStateTransferConfiguration 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()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
final XSiteStateTransferConfigurationBuilder	timeout(long timeout)	The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied.
String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)
final XSiteStateTransferConfigurationBuilder	waitTime(long waitingTimeBetweenRetries)	The wait time, in milliseconds, between each retry.

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

jmxStatistics

Field Details

builder

protected final ConfigurationBuilder builder

Constructor Details

XSiteStateTransferConfigurationBuilder

public XSiteStateTransferConfigurationBuilder(ConfigurationBuilder builder,
 BackupConfigurationBuilder backupConfigurationBuilder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<XSiteStateTransferConfiguration>

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<XSiteStateTransferConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

chunkSize

public final XSiteStateTransferConfigurationBuilder chunkSize(int chunkSize)

If > 0, the state will be transferred in batches of chunkSize cache entries. If <= 0, the state will be transferred in all at once. Not recommended. Defaults to 512.

timeout

public final XSiteStateTransferConfigurationBuilder timeout(long timeout)

The time (in milliseconds) to wait for the backup site acknowledge the state chunk received and applied. Default value is 20 min.

maxRetries

public final XSiteStateTransferConfigurationBuilder maxRetries(int maxRetries)

The maximum number of retries when a push state command fails. A value ≤ 0 (zero) means that the command does not retry. Default value is 30.

waitTime

public final XSiteStateTransferConfigurationBuilder waitTime(long waitingTimeBetweenRetries)

The wait time, in milliseconds, between each retry. The value should be > 0 (zero). Default value is 2 seconds.

mode

public final XSiteStateTransferConfigurationBuilder mode(XSiteStateTransferMode mode)

The cross-site state transfer mode.

If set to XSiteStateTransferMode.AUTO, Infinispan automatically starts state transfer when it detects a new view for a backup location that was previously offline.

backup

public final BackupConfigurationBuilder backup()

create

public XSiteStateTransferConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<XSiteStateTransferConfiguration>

Returns:

read

public Builder<XSiteStateTransferConfiguration> read(XSiteStateTransferConfiguration 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<XSiteStateTransferConfiguration>

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

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