AsyncStoreConfigurationBuilder (Infinispan JavaDoc All 9.3.1.Final API)

java.lang.Object
- org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
- - org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder<S>
  - - org.infinispan.configuration.cache.AsyncStoreConfigurationBuilder<S>

All Implemented Interfaces:

Builder<AsyncStoreConfiguration>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationChildBuilder<S>
```
public class AsyncStoreConfigurationBuilder<S>
extends AbstractStoreConfigurationChildBuilder<S>
implements Builder<AsyncStoreConfiguration>
```
Configuration for the async cache store. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.

Author:

pmuir

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`AsyncStoreConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`AsyncStoreConfigurationBuilder<S>`	`disable()`
`AsyncStoreConfigurationBuilder<S>`	`enable()` If true, all modifications to this cache store happen asynchronously, on a separate thread.
`AsyncStoreConfigurationBuilder<S>`	`enabled(boolean enabled)`
`EncodingConfigurationBuilder`	`encoding()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`AsyncStoreConfigurationBuilder<S>`	`failSilently(boolean failSilently)`
`AsyncStoreConfigurationBuilder<S>`	`flushLockTimeout(long l)` Deprecated.
`AsyncStoreConfigurationBuilder<S>`	`flushLockTimeout(long l, TimeUnit unit)` Deprecated.
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`AsyncStoreConfigurationBuilder<S>`	`modificationQueueSize(int i)` Sets the size of the modification queue for the async store.
`PersistenceConfigurationBuilder`	`persistence()`
`AsyncStoreConfigurationBuilder<S>`	`read(AsyncStoreConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`SecurityConfigurationBuilder`	`security()`
`AsyncStoreConfigurationBuilder<S>`	`shutdownTimeout(long l)` Deprecated.
`AsyncStoreConfigurationBuilder<S>`	`shutdownTimeout(long l, TimeUnit unit)` Deprecated.
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()` Deprecated.
`ConfigurationChildBuilder`	`template(boolean template)`
`AsyncStoreConfigurationBuilder<S>`	`threadPoolSize(int i)` Size of the thread pool whose threads are responsible for applying the modifications.
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`
`VersioningConfigurationBuilder`	`versioning()`

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder
addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, shared, singleton, transactional, withProperties

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, compatibility, customInterceptors, dataContainer, deadlockDetection, encoding, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, versioning

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence

- Method Detail
  - enable
```
public AsyncStoreConfigurationBuilder<S> enable()
```
    If true, all modifications to this cache store happen asynchronously, on a separate thread.
  - disable
```
public AsyncStoreConfigurationBuilder<S> disable()
```
  - enabled
```
public AsyncStoreConfigurationBuilder<S> enabled(boolean enabled)
```
  - flushLockTimeout
```
@Deprecated
public AsyncStoreConfigurationBuilder<S> flushLockTimeout(long l)
```
    Deprecated.
    
    Unused.
  - flushLockTimeout
```
@Deprecated
public AsyncStoreConfigurationBuilder<S> flushLockTimeout(long l,
                                                                      TimeUnit unit)
```
    Deprecated.
    
    Unused.
  - modificationQueueSize
```
public AsyncStoreConfigurationBuilder<S> modificationQueueSize(int i)
```
    Sets the size of the modification queue for the async store. If updates are made at a rate that is faster than the underlying cache store can process this queue, then the async store behaves like a synchronous store for that period, blocking until the queue can accept more elements.
  - shutdownTimeout
```
@Deprecated
public AsyncStoreConfigurationBuilder<S> shutdownTimeout(long l)
```
    Deprecated.
    
    Unused.
  - shutdownTimeout
```
@Deprecated
public AsyncStoreConfigurationBuilder<S> shutdownTimeout(long l,
                                                                     TimeUnit unit)
```
    Deprecated.
    
    Unused.
  - threadPoolSize
```
public AsyncStoreConfigurationBuilder<S> threadPoolSize(int i)
```
    Size of the thread pool whose threads are responsible for applying the modifications.
  - failSilently
```
public AsyncStoreConfigurationBuilder<S> failSilently(boolean failSilently)
```
    Parameters:
    
    failSilently - When true, write operations are only attempted `connection-attempts` times by the async store and if all attempts fail the errors are simply ignored and the operations are never executed on the store; where `connection-attempts` is configured in the PersistenceConfiguration. When disabled, failed modifications are not discarded on failure. Instead they are re-attempted when the underlying store becomes available. In the event that the modification-queue becomes full before the underlying store becomes available, an error will be thrown on all future writes to the store until the modification-queue is successfully flushed. In the event that the underlying store does not become available before the Async store is stopped, queued modifications are not persisted.
  - 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<AsyncStoreConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public AsyncStoreConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<AsyncStoreConfiguration>
    
    Returns:
  - read
```
public AsyncStoreConfigurationBuilder<S> read(AsyncStoreConfiguration 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<AsyncStoreConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
```
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
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding 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
```
@Deprecated
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Deprecated.
    
    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
  - 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 AsyncStoreConfigurationBuilder<S>

Method Summary

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder

Methods inherited from class java.lang.Object

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

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

Method Detail

enable

disable

enabled

flushLockTimeout

flushLockTimeout

modificationQueueSize

shutdownTimeout

shutdownTimeout

threadPoolSize

failSilently

validate

validate

create

read

toString

template

simpleCache

simpleCache

clustering

customInterceptors

dataContainer

deadlockDetection

encoding

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

memory

getBuilder

build