AsyncConfigurationBuilder (Infinispan Distribution 7.0.3.Final API)

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

All Implemented Interfaces:

Builder<AsyncConfiguration>, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder
```
public class AsyncConfigurationBuilder
extends Object
implements Builder<AsyncConfiguration>
```
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.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AsyncConfigurationBuilder(ClusteringConfigurationBuilder builder)

Constructors
Modifier	Constructor and Description
`protected`	`AsyncConfigurationBuilder(ClusteringConfigurationBuilder builder)`

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.
`AsyncConfigurationBuilder`	`asyncMarshalling()` Enable asynchronous marshalling.
`AsyncConfigurationBuilder`	`asyncMarshalling(boolean async)`
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`AsyncConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`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.
`LockingConfigurationBuilder`	`locking()`
`PartitionHandlingConfigurationBuilder`	`partitionHandling()` Configures how the cache will react to cluster partitions.
`PersistenceConfigurationBuilder`	`persistence()`
`AsyncConfigurationBuilder`	`read(AsyncConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`AsyncConfigurationBuilder`	`replQueue(ReplicationQueue replicationQueue)` The replication queue in use, by default `ReplicationQueueImpl`.
`AsyncConfigurationBuilder`	`replQueueInterval(long interval)` If useReplQueue is set to true, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
`AsyncConfigurationBuilder`	`replQueueInterval(long interval, TimeUnit unit)` If useReplQueue is set to true, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
`AsyncConfigurationBuilder`	`replQueueMaxElements(int elements)` If useReplQueue is set to true, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
`SecurityConfigurationBuilder`	`security()`
`SitesConfigurationBuilder`	`sites()`
`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.
`AsyncConfigurationBuilder`	`syncMarshalling()` Enables synchronous marshalling.
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`AsyncConfigurationBuilder`	`useReplQueue(boolean use)` If true, forces all async communications to be queued up and sent out periodically as a batch.
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`
`VersioningConfigurationBuilder`	`versioning()`

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, security, sites, storeAsBinary, transaction, unsafe, versioning

- Constructor Detail
  - AsyncConfigurationBuilder
```
protected AsyncConfigurationBuilder(ClusteringConfigurationBuilder builder)
```
- Method Detail
  - asyncMarshalling
```
public AsyncConfigurationBuilder asyncMarshalling()
```
    Enable asynchronous marshalling. This allows the caller to return even quicker, but it can suffer from reordering of operations. You can find more information at https://docs.jboss.org/author/display/ISPN/Asynchronous+Options.
  - asyncMarshalling
```
public AsyncConfigurationBuilder asyncMarshalling(boolean async)
```
  - syncMarshalling
```
public AsyncConfigurationBuilder syncMarshalling()
```
    Enables synchronous marshalling. You can find more information at https://docs.jboss.org/author/display/ISPN/Asynchronous+Options.
  - replQueue
```
public AsyncConfigurationBuilder replQueue(ReplicationQueue replicationQueue)
```
    The replication queue in use, by default ReplicationQueueImpl. NOTE: Currently Infinispan will not use the object instance, but instead instantiate a new instance of the class. Therefore, do not expect any state to survive, and provide a no-args constructor to any instance. This will be resolved in Infinispan 5.2.0
  - replQueueInterval
```
public AsyncConfigurationBuilder replQueueInterval(long interval)
```
    If useReplQueue is set to true, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
  - replQueueInterval
```
public AsyncConfigurationBuilder replQueueInterval(long interval,
                                          TimeUnit unit)
```
    If useReplQueue is set to true, this attribute controls how often the asynchronous thread used to flush the replication queue runs.
  - replQueueMaxElements
```
public AsyncConfigurationBuilder replQueueMaxElements(int elements)
```
    If useReplQueue is set to true, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.
  - useReplQueue
```
public AsyncConfigurationBuilder useReplQueue(boolean use)
```
    If true, forces all async communications to be queued up and sent out periodically as a batch.
  - 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<AsyncConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public AsyncConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<AsyncConfiguration>
    
    Returns:
  - read
```
public AsyncConfigurationBuilder read(AsyncConfiguration 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<AsyncConfiguration>
    
    Parameters:
    template - the configuration from which to "clone" this config if needed.
  - 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
  - partitionHandling
```
public PartitionHandlingConfigurationBuilder partitionHandling()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures how the cache will react to cluster partitions.
    
    Specified by:
    
    partitionHandling 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
  - 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
  - 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
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class AsyncConfigurationBuilder

Constructor Summary

Method Summary

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

Constructor Detail

AsyncConfigurationBuilder

Method Detail

asyncMarshalling

asyncMarshalling

syncMarshalling

replQueue

replQueueInterval

replQueueInterval

replQueueMaxElements

useReplQueue

validate

validate

create

read

toString

async

hash

l1

stateTransfer

sync

partitionHandling

getClusteringBuilder

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build