Package org.infinispan.configuration.cache

Class BackupConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.BackupConfigurationBuilder

All Implemented Interfaces:

Builder<BackupConfiguration>, ConfigurationChildBuilder

public class BackupConfigurationBuilder
extends Object
implements Builder<BackupConfiguration>

Since:

5.2

Author:

Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Constructor Summary

Constructors

Constructor	Description
BackupConfigurationBuilder(ConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
ConfigurationBuilder	aliases(String... aliases)
AttributeSet	attributes()
BackupConfigurationBuilder	backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)	Configures the policy for handling failed requests.
Configuration	build()
ClusteringConfigurationBuilder	clustering()
BackupConfiguration	create()	Create the configuration bean
BackupConfigurationBuilder	enabled(boolean isEnabled)	Deprecated, for removal: This API element is subject to removal in a future version. Since 14.0.
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
String	failurePolicyClass()	If the failure policy is set to BackupFailurePolicy.CUSTOM then the failurePolicyClass is required and should return the fully qualified name of a class implementing CustomFailurePolicy
BackupConfigurationBuilder	failurePolicyClass(String failurePolicy)
protected ConfigurationBuilder	getBuilder()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
QueryConfigurationBuilder	query()
BackupConfigurationBuilder	read(BackupConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
BackupConfigurationBuilder	replicationTimeout(long replicationTimeout)	Timeout(millis) used for replicating calls to other sites.
BackupConfigurationBuilder	replicationTimeout(String replicationTimeout)	Same as replicationTimeout(long) but supporting time units.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
String	site()
BackupConfigurationBuilder	site(String site)
SitesConfigurationBuilder	sites()
XSiteStateTransferConfigurationBuilder	stateTransfer()
StatisticsConfigurationBuilder	statistics()
BackupConfiguration.BackupStrategy	strategy()
BackupConfigurationBuilder	strategy(BackupConfiguration.BackupStrategy strategy)	Sets the strategy used for backing up data: sync or async.
TakeOfflineConfigurationBuilder	takeOffline()
ConfigurationChildBuilder	template(boolean template)
String	toString()
TracingConfigurationBuilder	tracing()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
BackupConfigurationBuilder	useTwoPhaseCommit(boolean useTwoPhaseCommit)	Controls if replication happens in a two phase commit (2PC) for synchronous backups.
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

Field Details

builder

protected final ConfigurationBuilder builder

Constructor Details

BackupConfigurationBuilder

public BackupConfigurationBuilder(ConfigurationBuilder builder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<BackupConfiguration>

site

public BackupConfigurationBuilder site(String site)

Parameters:

site - Specifies the name of the backup location for this cache. The name must match a site defined in the global configuration.

site

public String site()

See Also:

• site(String)

failurePolicyClass

public String failurePolicyClass()

If the failure policy is set to BackupFailurePolicy.CUSTOM then the failurePolicyClass is required and should return the fully qualified name of a class implementing CustomFailurePolicy

failurePolicyClass

public BackupConfigurationBuilder failurePolicyClass(String failurePolicy)

See Also:

• failurePolicyClass()

replicationTimeout

public BackupConfigurationBuilder replicationTimeout(long replicationTimeout)

Timeout(millis) used for replicating calls to other sites.

replicationTimeout

public BackupConfigurationBuilder replicationTimeout(String replicationTimeout)

Same as replicationTimeout(long) but supporting time units.

strategy

public BackupConfigurationBuilder strategy(BackupConfiguration.BackupStrategy strategy)

Sets the strategy used for backing up data: sync or async. Defaults to BackupConfiguration.BackupStrategy.ASYNC.

strategy

public BackupConfiguration.BackupStrategy strategy()

See Also:

• strategy()

takeOffline

public TakeOfflineConfigurationBuilder takeOffline()

backupFailurePolicy

public BackupConfigurationBuilder backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)

Configures the policy for handling failed requests. Defaults to BackupFailurePolicy.WARN

useTwoPhaseCommit

public BackupConfigurationBuilder useTwoPhaseCommit(boolean useTwoPhaseCommit)

Controls if replication happens in a two phase commit (2PC) for synchronous backups. The default value is false, which means replication happens in a one phase commit (1PC).

enabled

@Deprecated(forRemoval=true,
            since="14.0")
public BackupConfigurationBuilder enabled(boolean isEnabled)

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

Since 14.0. To be removed without replacement.

Configures whether this site is used for backing up data or not (defaults to true).

stateTransfer

public XSiteStateTransferConfigurationBuilder stateTransfer()

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

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public BackupConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<BackupConfiguration>

Returns:

read

public BackupConfigurationBuilder read(BackupConfiguration 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<BackupConfiguration>

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

aliases

public ConfigurationBuilder aliases(String... aliases)

Specified by:

aliases in interface ConfigurationChildBuilder

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

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

tracing

public TracingConfigurationBuilder tracing()

Specified by:

tracing 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