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

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

All Implemented Interfaces:

Matchable<ClusteringConfiguration>, BaseConfigurationInfo, ConfigurationInfo
```
public class ClusteringConfiguration
extends Object
implements Matchable<ClusteringConfiguration>, ConfigurationInfo
```
Defines clustered characteristics of the cache.

Author:

pmuir

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeDefinition<BiasAcquisition>`	`BIAS_ACQUISITION`
`static AttributeDefinition<Long>`	`BIAS_LIFESPAN`
`static AttributeDefinition<CacheMode>`	`CACHE_MODE`
`static ElementDefinition`	`ELEMENT_DEFINITION`
`static AttributeDefinition<Integer>`	`INVALIDATION_BATCH_SIZE`
`static AttributeDefinition<Long>`	`REMOTE_TIMEOUT`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`BiasAcquisition`	`biasAcquisition()` For scattered cache, specifies if the nodes is allowed to cache the entry, serving reads locally.
`long`	`biasLifespan()` For scattered cache, specifies how long is the node allowed to read the cached entry locally.
`CacheMode`	`cacheMode()` Cache mode.
`String`	`cacheModeString()`
`boolean`	`equals(Object obj)`
`ElementDefinition`	`getElementDefinition()`
`HashConfiguration`	`hash()` Configure hash sub element
`int`	`hashCode()`
`int`	`invalidationBatchSize()` For scattered cache, the threshold after which batched invalidations are sent
`L1Configuration`	`l1()` This method allows configuration of the L1 cache for distributed caches.
`boolean`	`matches(ClusteringConfiguration other)`
`PartitionHandlingConfiguration`	`partitionHandling()` Configures cluster's behaviour in the presence of partitions or node failures.
`long`	`remoteTimeout()` 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.
`void`	`remoteTimeout(long timeoutMillis)` 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.
`StateTransferConfiguration`	`stateTransfer()`
`List<ConfigurationInfo>`	`subElements()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CACHE_MODE
```
public static final AttributeDefinition<CacheMode> CACHE_MODE
```
  - REMOTE_TIMEOUT
```
public static final AttributeDefinition<Long> REMOTE_TIMEOUT
```
  - INVALIDATION_BATCH_SIZE
```
public static final AttributeDefinition<Integer> INVALIDATION_BATCH_SIZE
```
  - BIAS_ACQUISITION
```
public static final AttributeDefinition<BiasAcquisition> BIAS_ACQUISITION
```
  - BIAS_LIFESPAN
```
public static final AttributeDefinition<Long> BIAS_LIFESPAN
```
  - ELEMENT_DEFINITION
```
public static final ElementDefinition ELEMENT_DEFINITION
```
- Method Detail
  - cacheMode
```
public CacheMode cacheMode()
```
    Cache mode. See CacheMode for information on the various cache modes available.
  - remoteTimeout
```
public long remoteTimeout()
```
    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 void remoteTimeout(long timeoutMillis)
```
    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.
  - partitionHandling
```
public PartitionHandlingConfiguration partitionHandling()
```
    Configures cluster's behaviour in the presence of partitions or node failures.
  - cacheModeString
```
public String cacheModeString()
```
  - invalidationBatchSize
```
public int invalidationBatchSize()
```
    For scattered cache, the threshold after which batched invalidations are sent
  - biasAcquisition
```
public BiasAcquisition biasAcquisition()
```
    For scattered cache, specifies if the nodes is allowed to cache the entry, serving reads locally.
  - biasLifespan
```
public long biasLifespan()
```
    For scattered cache, specifies how long is the node allowed to read the cached entry locally.
  - hash
```
public HashConfiguration hash()
```
    Configure hash sub element
  - l1
```
public L1Configuration l1()
```
    This method allows configuration of the L1 cache for distributed caches. When this method is called, it automatically enables L1. So, if you want it to be disabled, make sure you call L1ConfigurationBuilder.disable()
  - stateTransfer
```
public StateTransferConfiguration stateTransfer()
```
  - 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.
  - subElements
```
public List<ConfigurationInfo> subElements()
```
    Specified by:
    
    subElements in interface ConfigurationInfo
    
    Returns:
    
    the list of sub elements.
  - matches
```
public boolean matches(ClusteringConfiguration other)
```
    Specified by:
    
    matches in interface Matchable<ClusteringConfiguration>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ClusteringConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CACHE_MODE

REMOTE_TIMEOUT

INVALIDATION_BATCH_SIZE

BIAS_ACQUISITION

BIAS_LIFESPAN

ELEMENT_DEFINITION

Method Detail

cacheMode

remoteTimeout

remoteTimeout

partitionHandling

cacheModeString

invalidationBatchSize

biasAcquisition

biasLifespan

hash

l1

stateTransfer

attributes

getElementDefinition

subElements

matches

toString

equals

hashCode