StateTransferConfigurationBuilder (JBoss Application Server: Build 7.1.2.Final API)

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

All Implemented Interfaces:

ClusteringConfigurationChildBuilder, ConfigurationChildBuilder
```
public class StateTransferConfigurationBuilder
extends Object
```
Configures how state is transferred when a cache joins or leaves the cluster. Used in distributed and replication clustered modes.

Since:

5.1

Method Summary

Methods
Modifier and Type	Method and Description
`AsyncConfigurationBuilder`	`async()` If configured all communications are asynchronous, in that whenever a thread sends a message sent over the wire, it does not wait for an acknowledgment before returning.
`Configuration`	`build()`
`StateTransferConfigurationBuilder`	`chunkSize(int i)` If > 0, the state will be transferred in batches of `chunkSize` cache entries.
`ClusteringConfigurationBuilder`	`clustering()`
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`StateTransferConfigurationBuilder`	`fetchInMemoryState(boolean b)` If `true`, the cache will fetch data from the neighboring caches when it starts up, so the cache starts 'warm', although it will impact startup time.
`protected ConfigurationBuilder`	`getBuilder()`
`protected ClusteringConfigurationBuilder`	`getClusteringBuilder()`
`HashConfigurationBuilder`	`hash()` Allows fine-tuning of rehashing characteristics.
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`L1ConfigurationBuilder`	`l1()` Configures the L1 cache behavior in 'distributed' caches instances.
`LoadersConfigurationBuilder`	`loaders()`
`LockingConfigurationBuilder`	`locking()`
`StateTransferConfigurationBuilder`	`read(StateTransferConfiguration template)`
`StateTransferConfigurationBuilder`	`stateTransfer()` Configures how state is transferred when a new cache joins the cluster.
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`SyncConfigurationBuilder`	`sync()` If configured all communications are synchronous, in that whenever a thread sends a message sent over the wire, it blocks until it receives an acknowledgment from the recipient.
`StateTransferConfigurationBuilder`	`timeout(long l)` This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`VersioningConfigurationBuilder`	`versioning()`

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, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, loaders, locking, storeAsBinary, transaction, unsafe, versioning

- Method Detail
  - fetchInMemoryState
```
public StateTransferConfigurationBuilder fetchInMemoryState(boolean b)
```
    If true, the cache will fetch data from the neighboring caches when it starts up, so the cache starts 'warm', although it will impact startup time.
    In distributed mode, state is transferred between running caches as well, as the ownership of keys changes (e.g. because a cache left the cluster). Disabling this setting means a key will sometimes have less than numOwner owners.
  - chunkSize
```
public StateTransferConfigurationBuilder chunkSize(int i)
```
    If > 0, the state will be transferred in batches of chunkSize cache entries. If <= 0, the state will be transferred in all at once. Not recommended.
  - timeout
```
public StateTransferConfigurationBuilder timeout(long l)
```
    This is the maximum amount of time - in milliseconds - to wait for state from neighboring caches, before throwing an exception and aborting startup.
  - read
```
public StateTransferConfigurationBuilder read(StateTransferConfiguration template)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - async
```
public AsyncConfigurationBuilder async()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    If configured all communications are asynchronous, in that whenever a thread sends a message sent over the wire, it does not wait for an acknowledgment before returning. Asynchronous configuration is mutually exclusive with synchronous configuration.
    
    Specified by:
    
    async in interface ClusteringConfigurationChildBuilder
  - hash
```
public HashConfigurationBuilder hash()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.
    
    Specified by:
    
    hash in interface ClusteringConfigurationChildBuilder
  - l1
```
public L1ConfigurationBuilder l1()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.
    
    Specified by:
    
    l1 in interface ClusteringConfigurationChildBuilder
  - stateTransfer
```
public StateTransferConfigurationBuilder stateTransfer()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures how state is transferred when a new cache joins the cluster. Used with distribution and replication clustered modes.
    
    Specified by:
    
    stateTransfer in interface ClusteringConfigurationChildBuilder
  - sync
```
public SyncConfigurationBuilder sync()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    If configured all communications are synchronous, in that whenever a thread sends a message sent over the wire, it blocks until it receives an acknowledgment from the recipient. SyncConfig is mutually exclusive with the AsyncConfig.
    
    Specified by:
    
    sync in interface ClusteringConfigurationChildBuilder
  - getClusteringBuilder
```
protected ClusteringConfigurationBuilder getClusteringBuilder()
```
  - 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
  - loaders
```
public LoadersConfigurationBuilder loaders()
```
    Specified by:
    
    loaders in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking 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
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class StateTransferConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fetchInMemoryState

chunkSize

timeout

read

toString

async

hash

l1

stateTransfer

sync

getClusteringBuilder

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

loaders

locking

storeAsBinary

transaction

versioning

unsafe

getBuilder

build