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

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

All Implemented Interfaces:

BaseConfigurationInfo, Builder<ClusteringConfiguration>, ConfigurationBuilderInfo, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder
```
public class ClusteringConfigurationBuilder
extends Object
implements ClusteringConfigurationChildBuilder, Builder<ClusteringConfiguration>, ConfigurationBuilderInfo
```
Defines clustered characteristics of the cache.

Author:

pmuir

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`ClusteringConfigurationBuilder`	`biasAcquisition(BiasAcquisition biasAcquisition)` Used in scattered cache.
`ClusteringConfigurationBuilder`	`biasLifespan(long l, TimeUnit unit)` Used in scattered cache.
`Configuration`	`build()`
`CacheMode`	`cacheMode()`
`ClusteringConfigurationBuilder`	`cacheMode(CacheMode cacheMode)` Cache mode.
`ClusteringConfigurationBuilder`	`clustering()`
`ClusteringConfiguration`	`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
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`Collection<ConfigurationBuilderInfo>`	`getChildrenInfo()`
`ElementDefinition<? extends ConfigurationInfo>`	`getElementDefinition()`
`HashConfigurationBuilder`	`hash()` Configure hash sub element
`IndexingConfigurationBuilder`	`indexing()`
`ClusteringConfigurationBuilder`	`invalidationBatchSize(int size)` For scattered cache, the threshold after which batched invalidations are sent
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`L1ConfigurationBuilder`	`l1()` This method allows configuration of the L1 cache for distributed caches.
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PartitionHandlingConfigurationBuilder`	`partitionHandling()` Configures how the cache will react to cluster partitions.
`PersistenceConfigurationBuilder`	`persistence()`
`ClusteringConfigurationBuilder`	`read(ClusteringConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`ClusteringConfigurationBuilder`	`remoteTimeout(long l)` This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
`ClusteringConfigurationBuilder`	`remoteTimeout(long l, TimeUnit unit)` This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StateTransferConfigurationBuilder`	`stateTransfer()` Configure the `stateTransfer` sub element for distributed and replicated caches.
`StatisticsConfigurationBuilder`	`statistics()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`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, wait, wait, wait

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

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

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Method Detail
  - getElementDefinition
```
public ElementDefinition<? extends ConfigurationInfo> 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.
  - cacheMode
```
public ClusteringConfigurationBuilder cacheMode(CacheMode cacheMode)
```
    Cache mode. See CacheMode for information on the various cache modes available.
  - cacheMode
```
public CacheMode cacheMode()
```
  - remoteTimeout
```
public ClusteringConfigurationBuilder remoteTimeout(long l)
```
    This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
  - remoteTimeout
```
public ClusteringConfigurationBuilder remoteTimeout(long l,
                                                    TimeUnit unit)
```
    This is the timeout used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.
  - invalidationBatchSize
```
public ClusteringConfigurationBuilder invalidationBatchSize(int size)
```
    For scattered cache, the threshold after which batched invalidations are sent
  - biasAcquisition
```
public ClusteringConfigurationBuilder biasAcquisition(BiasAcquisition biasAcquisition)
```
    Used in scattered cache. Acquired bias allows reading data on non-owner, but slows down further writes from other nodes.
  - biasLifespan
```
public ClusteringConfigurationBuilder biasLifespan(long l,
                                                   TimeUnit unit)
```
    Used in scattered cache. Specifies how long can be the acquired bias held; while the reads will never be stale, tracking that information consumes memory on primary owner.
  - hash
```
public HashConfigurationBuilder hash()
```
    Configure hash sub element
    
    Specified by:
    
    hash in interface ClusteringConfigurationChildBuilder
  - l1
```
public L1ConfigurationBuilder l1()
```
    This method allows configuration of the L1 cache for distributed caches. L1 should be explicitly enabled by calling L1ConfigurationBuilder.enable()
    
    Specified by:
    
    l1 in interface ClusteringConfigurationChildBuilder
  - stateTransfer
```
public StateTransferConfigurationBuilder stateTransfer()
```
    Configure the stateTransfer sub element for distributed and replicated caches. It doesn't have any effect on LOCAL or INVALIDATION-mode caches.
    
    Specified by:
    
    stateTransfer in interface ClusteringConfigurationChildBuilder
  - partitionHandling
```
public PartitionHandlingConfigurationBuilder partitionHandling()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures how the cache will react to cluster partitions.
    
    Specified by:
    
    partitionHandling in interface ClusteringConfigurationChildBuilder
  - 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<ClusteringConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public ClusteringConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<ClusteringConfiguration>
    
    Returns:
  - read
```
public ClusteringConfigurationBuilder read(ClusteringConfiguration 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<ClusteringConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - 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 ClusteringConfigurationBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

builder

Method Detail

getElementDefinition

getChildrenInfo

cacheMode

cacheMode

remoteTimeout

remoteTimeout

invalidationBatchSize

biasAcquisition

biasLifespan

hash

l1

stateTransfer

partitionHandling

validate

validate

create

read

toString

attributes

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build