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

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

All Implemented Interfaces:

BaseConfigurationInfo, Builder<SitesConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder
```
public class SitesConfigurationBuilder
extends Object
implements Builder<SitesConfiguration>, 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

SitesConfigurationBuilder(ConfigurationBuilder builder)

Constructors
Constructor and Description
`SitesConfigurationBuilder(ConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BackupConfigurationBuilder`	`addBackup()`
`SitesConfigurationBuilder`	`addInUseBackupSite(String site)` Defines the site names, from the list of sites names defined within 'backups' element, to which this cache backups its data.
`AttributeSet`	`attributes()`
`BackupForBuilder`	`backupFor()`
`List<BackupConfigurationBuilder>`	`backups()`
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`SitesConfiguration`	`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
`SitesConfigurationBuilder`	`disableBackups(boolean disable)` Returns true if this cache won't backup its data remotely.
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`Collection<ConfigurationBuilderInfo>`	`getChildrenInfo()`
`ElementDefinition`	`getElementDefinition()`
`ConfigurationBuilderInfo`	`getNewBuilderInfo(String name)`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`SitesConfigurationBuilder`	`read(SitesConfiguration template)` 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)`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`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, toString, wait, wait, wait

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

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

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - SitesConfigurationBuilder
```
public SitesConfigurationBuilder(ConfigurationBuilder builder)
```
- Method Detail
  - addBackup
```
public BackupConfigurationBuilder addBackup()
```
  - getNewBuilderInfo
```
public ConfigurationBuilderInfo getNewBuilderInfo(String name)
```
    Specified by:
    
    getNewBuilderInfo in interface ConfigurationBuilderInfo
    
    Returns:
    
    same as ConfigurationBuilderInfo.getBuilderInfo(String, String) but will return a new instance of the builder on every call. This is to create unbounded sub-elements in a builder.
  - getChildrenInfo
```
public Collection<ConfigurationBuilderInfo> getChildrenInfo()
```
    Specified by:
    
    getChildrenInfo in interface ConfigurationBuilderInfo
    
    Returns:
    
    a collection of ConfigurationBuilderInfo for the sub-elements of the builder.
  - 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.
  - backups
```
public List<BackupConfigurationBuilder> backups()
```
  - disableBackups
```
public SitesConfigurationBuilder disableBackups(boolean disable)
```
    Returns true if this cache won't backup its data remotely. It would still accept other sites backing up data on this site.
  - addInUseBackupSite
```
public SitesConfigurationBuilder addInUseBackupSite(String site)
```
    Defines the site names, from the list of sites names defined within 'backups' element, to which this cache backups its data.
  - backupFor
```
public BackupForBuilder backupFor()
```
  - 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<SitesConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public SitesConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<SitesConfiguration>
    
    Returns:
  - read
```
public SitesConfigurationBuilder read(SitesConfiguration 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<SitesConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - 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 SitesConfigurationBuilder

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

SitesConfigurationBuilder

Method Detail

addBackup

getNewBuilderInfo

getChildrenInfo

attributes

getElementDefinition

backups

disableBackups

addInUseBackupSite

backupFor

validate

validate

create

read

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build