BackupConfigurationBuilder (Infinispan Distribution 7.0.3.Final API)

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

Constructor Summary

Constructors
Constructor and Description

BackupConfigurationBuilder(ConfigurationBuilder builder)

Constructors
Constructor and Description
`BackupConfigurationBuilder(ConfigurationBuilder builder)`

Method Summary

Methods
Modifier and Type	Method and Description
`BackupFailurePolicy`	`backupFailurePolicy()`
`BackupConfigurationBuilder`	`backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)` Configures how the system behaves when the backup call fails.
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`BackupConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`BackupConfigurationBuilder`	`enabled(boolean isEnabled)` Configures whether this site is used for backing up data or not (defaults to true).
`boolean`	`equals(Object o)`
`EvictionConfigurationBuilder`	`eviction()`
`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()`
`int`	`hashCode()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LockingConfigurationBuilder`	`locking()`
`PersistenceConfigurationBuilder`	`persistence()`
`Builder`	`read(BackupConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`long`	`replicationTimeout()`
`BackupConfigurationBuilder`	`replicationTimeout(long replicationTimeout)` Timeout(millis) used for replicating calls to other sites.
`SecurityConfigurationBuilder`	`security()`
`String`	`site()`
`BackupConfigurationBuilder`	`site(String site)`
`SitesConfigurationBuilder`	`sites()`
`XSiteStateTransferConfigurationBuilder`	`stateTransfer()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`BackupConfiguration.BackupStrategy`	`strategy()`
`BackupConfigurationBuilder`	`strategy(BackupConfiguration.BackupStrategy strategy)` Sets the strategy used for backing up data: sync or async.
`TakeOfflineConfigurationBuilder`	`takeOffline()`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`BackupConfigurationBuilder`	`useTwoPhaseCommit(boolean useTwoPhaseCommit)` Configures whether the replication happens in a 1PC or 2PC for sync backups.
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`
`VersioningConfigurationBuilder`	`versioning()`

- Constructor Detail
  - BackupConfigurationBuilder
```
public BackupConfigurationBuilder(ConfigurationBuilder builder)
```
- Method Detail
  - site
```
public BackupConfigurationBuilder site(String site)
```
    Parameters:
    site - The name of the site where this cache backups. Must be a valid name, i.e. a site defined in the global config.
  - site
```
public String site()
```
    See Also:
    BackupConfigurationBuilder.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:
    BackupConfigurationBuilder.failurePolicyClass()
  - replicationTimeout
```
public BackupConfigurationBuilder replicationTimeout(long replicationTimeout)
```
    Timeout(millis) used for replicating calls to other sites.
  - replicationTimeout
```
public long replicationTimeout()
```
    See Also:
    #replicationTimeout(long)}
  - strategy
```
public BackupConfigurationBuilder strategy(BackupConfiguration.BackupStrategy strategy)
```
    Sets the strategy used for backing up data: sync or async. If not specified defaults to BackupConfiguration.BackupStrategy.ASYNC.
  - strategy
```
public BackupConfiguration.BackupStrategy strategy()
```
    See Also:
    BackupConfigurationBuilder.strategy()
  - takeOffline
```
public TakeOfflineConfigurationBuilder takeOffline()
```
  - backupFailurePolicy
```
public BackupConfigurationBuilder backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)
```
    Configures how the system behaves when the backup call fails. Only applies to sync backups. The default values is BackupFailurePolicy.WARN
  - backupFailurePolicy
```
public BackupFailurePolicy backupFailurePolicy()
```
    See Also:
    #backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)}
  - useTwoPhaseCommit
```
public BackupConfigurationBuilder useTwoPhaseCommit(boolean useTwoPhaseCommit)
```
    Configures whether the replication happens in a 1PC or 2PC for sync backups. The default value is "false"
  - enabled
```
public BackupConfigurationBuilder enabled(boolean isEnabled)
```
    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 Builder read(BackupConfiguration template)
```
    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.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - dataContainer
```
public DataContainerConfigurationBuilder dataContainer()
```
    Specified by:
    
    dataContainer in interface ConfigurationChildBuilder
  - deadlockDetection
```
public DeadlockDetectionConfigurationBuilder deadlockDetection()
```
    Specified by:
    
    deadlockDetection in interface ConfigurationChildBuilder
  - eviction
```
public EvictionConfigurationBuilder eviction()
```
    Specified by:
    
    eviction in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - jmxStatistics
```
public JMXStatisticsConfigurationBuilder jmxStatistics()
```
    Specified by:
    
    jmxStatistics 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
  - storeAsBinary
```
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Specified by:
    
    storeAsBinary in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - versioning
```
public VersioningConfigurationBuilder versioning()
```
    Specified by:
    
    versioning in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class BackupConfigurationBuilder

Constructor Summary

Method Summary

Constructor Detail

BackupConfigurationBuilder

Method Detail

site

site

failurePolicyClass

failurePolicyClass

replicationTimeout

replicationTimeout

strategy

strategy

takeOffline

backupFailurePolicy

backupFailurePolicy

useTwoPhaseCommit

enabled

stateTransfer

validate

validate

create

read

equals

hashCode

toString

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build