BackupConfigurationBuilder (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- org.infinispan.configuration.cache.BackupConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<BackupConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder
```
public class BackupConfigurationBuilder
extends Object
implements Builder<BackupConfiguration>, ConfigurationBuilderInfo
```
Since:

5.2

Author:

Mircea.Markus@jboss.com

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Constructor Summary

Constructors
Constructor and Description

BackupConfigurationBuilder(ConfigurationBuilder builder)

Constructors
Constructor and Description
`BackupConfigurationBuilder(ConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`BackupConfigurationBuilder`	`backupFailurePolicy(BackupFailurePolicy backupFailurePolicy)` Configures how the system behaves when the backup call fails.
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`BackupConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()` Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
`BackupConfigurationBuilder`	`enabled(boolean isEnabled)` Configures whether this site is used for backing up data or not (defaults to true).
`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()`
`Collection<ConfigurationBuilderInfo>`	`getChildrenInfo()`
`ElementDefinition`	`getElementDefinition()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`BackupConfigurationBuilder`	`read(BackupConfiguration template)` 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.
`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()`
`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)`

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.ConfigurationBuilderInfo
getBuilderInfo, getNewBuilderInfo

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

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - BackupConfigurationBuilder
```
public BackupConfigurationBuilder(ConfigurationBuilder builder)
```
- Method Detail
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - getElementDefinition
```
public ElementDefinition getElementDefinition()
```
    Specified by:
    
    getElementDefinition in interface BaseConfigurationInfo
    
    Returns:
    
    the ElementDefinition of the configuration.
  - getChildrenInfo
```
public Collection<ConfigurationBuilderInfo> getChildrenInfo()
```
    Specified by:
    
    getChildrenInfo in interface ConfigurationBuilderInfo
    
    Returns:
    
    a collection of ConfigurationBuilderInfo for the sub-elements of the builder.
  - 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:
    
    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.
  - 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:
    
    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
  - 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 BackupConfigurationBuilder 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.
  - 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
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Deprecated. 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
  - 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

Class BackupConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

builder

Constructor Detail

BackupConfigurationBuilder

Method Detail

attributes

getElementDefinition

getChildrenInfo

site

site

failurePolicyClass

failurePolicyClass

replicationTimeout

strategy

strategy

takeOffline

backupFailurePolicy

useTwoPhaseCommit

enabled

stateTransfer

validate

validate

create

read

toString

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build