Class BackupConfiguration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<BackupConfiguration>

org.infinispan.configuration.cache.BackupConfiguration

All Implemented Interfaces:

Matchable<BackupConfiguration>, Updatable<BackupConfiguration>

public class BackupConfiguration
extends ConfigurationElement<BackupConfiguration>

Since:

5.2

Author:

Mircea.Markus@jboss.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BackupConfiguration.BackupStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<BackupFailurePolicy>	FAILURE_POLICY
static final AttributeDefinition<String>	FAILURE_POLICY_CLASS
static final AttributeDefinition<TimeQuantity>	REPLICATION_TIMEOUT
static final AttributeDefinition<String>	SITE
static final AttributeDefinition<BackupConfiguration.BackupStrategy>	STRATEGY
static final AttributeDefinition<Boolean>	USE_TWO_PHASE_COMMIT

Fields inherited from class ConfigurationElement

attributes, CHILDLESS, children, element, repeated, sinceMajor, sinceMinor

Constructor Summary

Constructors

Constructor	Description
BackupConfiguration(AttributeSet attributes, TakeOfflineConfiguration takeOfflineConfiguration, XSiteStateTransferConfiguration xSiteStateTransferConfiguration)

Method Summary

Modifier and Type	Method	Description
BackupFailurePolicy	backupFailurePolicy()
boolean	enabled()	Deprecated, for removal: This API element is subject to removal in a future version. Since 14.0.
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
boolean	isAsyncBackup()
boolean	isSyncBackup()
boolean	isTwoPhaseCommit()
long	replicationTimeout()
BackupConfiguration	replicationTimeout(long timeout)	Deprecated, for removal: This API element is subject to removal in a future version. Since 14.0.
String	site()	Returns the name of the site where this cache backups its data.
XSiteStateTransferConfiguration	stateTransfer()
BackupConfiguration.BackupStrategy	strategy()	How does the backup happen: sync or async.
TakeOfflineConfiguration	takeOffline()

Methods inherited from class ConfigurationElement

attributes, child, children, children, collectMutableAttributes, elementName, equals, extractAttributes, findAttribute, hashCode, isModified, isSince, list, matches, matches, matches, toString, update, update, update, validateUpdate, validateUpdate, validateUpdate, write

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SITE

public static final AttributeDefinition<String> SITE

STRATEGY

public static final AttributeDefinition<BackupConfiguration.BackupStrategy> STRATEGY

REPLICATION_TIMEOUT

public static final AttributeDefinition<TimeQuantity> REPLICATION_TIMEOUT

FAILURE_POLICY

public static final AttributeDefinition<BackupFailurePolicy> FAILURE_POLICY

FAILURE_POLICY_CLASS

public static final AttributeDefinition<String> FAILURE_POLICY_CLASS

USE_TWO_PHASE_COMMIT

public static final AttributeDefinition<Boolean> USE_TWO_PHASE_COMMIT

Constructor Details

BackupConfiguration

public BackupConfiguration(AttributeSet attributes,
 TakeOfflineConfiguration takeOfflineConfiguration,
 XSiteStateTransferConfiguration xSiteStateTransferConfiguration)

Method Details

site

public String site()

Returns the name of the site where this cache backups its data.

strategy

public BackupConfiguration.BackupStrategy strategy()

How does the backup happen: sync or async.

takeOffline

public TakeOfflineConfiguration takeOffline()

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

isAsyncBackup

public boolean isAsyncBackup()

isSyncBackup

public boolean isSyncBackup()

replicationTimeout

public long replicationTimeout()

replicationTimeout

@Deprecated(forRemoval=true,
            since="14.0")
public BackupConfiguration replicationTimeout(long timeout)

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

Since 14.0. To be removed without replacement

backupFailurePolicy

public BackupFailurePolicy backupFailurePolicy()

isTwoPhaseCommit

public boolean isTwoPhaseCommit()

enabled

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

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

Since 14.0. To be removed without replacement.

See Also:

• BackupConfigurationBuilder.enabled(boolean)

stateTransfer

public XSiteStateTransferConfiguration stateTransfer()