L1ConfigurationBuilder (Infinispan Distribution 6.0.2.Final API)

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

All Implemented Interfaces:

Builder<L1Configuration>, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder
```
public class L1ConfigurationBuilder
extends Object
implements Builder<L1Configuration>
```
Configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Method Summary

All Methods Instance Methods Concrete 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()`
`L1ConfigurationBuilder`	`cleanupTaskFrequency(long frequencyMillis)` How often the L1 requestors map is cleaned up of stale items
`L1ConfigurationBuilder`	`cleanupTaskFrequency(long frequencyMillis, TimeUnit unit)` How often the L1 requestors map is cleaned up of stale items
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`L1Configuration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`L1ConfigurationBuilder`	`disable()`
`L1ConfigurationBuilder`	`disableOnRehash()` Entries removed due to a rehash will be removed altogether rather than bring moved to L1.
`L1ConfigurationBuilder`	`enable()`
`L1ConfigurationBuilder`	`enabled(boolean enabled)`
`L1ConfigurationBuilder`	`enableOnRehash()` Entries removed due to a rehash will be moved to L1 rather than being removed altogether.
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`protected ClusteringConfigurationBuilder`	`getClusteringBuilder()`
`HashConfigurationBuilder`	`hash()` Allows fine-tuning of rehashing characteristics.
`IndexingConfigurationBuilder`	`indexing()`
`L1ConfigurationBuilder`	`invalidationThreshold(int invalidationThreshold)` Determines whether a multicast or a web of unicasts are used when performing L1 invalidations.
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`L1ConfigurationBuilder`	`l1()` Configures the L1 cache behavior in 'distributed' caches instances.
`L1ConfigurationBuilder`	`l1OnRehash(boolean l1OnRehash)`
`L1ConfigurationBuilder`	`lifespan(long lifespan)` Maximum lifespan of an entry placed in the L1 cache.
`L1ConfigurationBuilder`	`lifespan(long lifespan, TimeUnit unit)` Maximum lifespan of an entry placed in the L1 cache.
`LockingConfigurationBuilder`	`locking()`
`L1ConfigurationBuilder`	`onRehash(boolean enabled)` Entries removed due to a rehash will be moved to L1 rather than being removed altogether.
`PersistenceConfigurationBuilder`	`persistence()`
`L1ConfigurationBuilder`	`read(L1Configuration template)` Reads the configuration from an already created configuration bean into this builder.
`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.
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`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, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, sites, storeAsBinary, transaction, unsafe, versioning

- Method Detail
  - invalidationThreshold
```
public L1ConfigurationBuilder invalidationThreshold(int invalidationThreshold)
```
    Determines whether a multicast or a web of unicasts are used when performing L1 invalidations.
    
    By default multicast will be used.
    
    If the threshold is set to -1, then unicasts will always be used. If the threshold is set to 0, then multicast will be always be used.
    
    Parameters:
    
    invalidationThreshold - the threshold over which to use a multicast
  - lifespan
```
public L1ConfigurationBuilder lifespan(long lifespan)
```
    Maximum lifespan of an entry placed in the L1 cache.
  - lifespan
```
public L1ConfigurationBuilder lifespan(long lifespan,
                                       TimeUnit unit)
```
    Maximum lifespan of an entry placed in the L1 cache.
  - cleanupTaskFrequency
```
public L1ConfigurationBuilder cleanupTaskFrequency(long frequencyMillis)
```
    How often the L1 requestors map is cleaned up of stale items
  - cleanupTaskFrequency
```
public L1ConfigurationBuilder cleanupTaskFrequency(long frequencyMillis,
                                                   TimeUnit unit)
```
    How often the L1 requestors map is cleaned up of stale items
  - enableOnRehash
```
public L1ConfigurationBuilder enableOnRehash()
```
    Entries removed due to a rehash will be moved to L1 rather than being removed altogether.
  - onRehash
```
public L1ConfigurationBuilder onRehash(boolean enabled)
```
    Entries removed due to a rehash will be moved to L1 rather than being removed altogether.
  - disableOnRehash
```
public L1ConfigurationBuilder disableOnRehash()
```
    Entries removed due to a rehash will be removed altogether rather than bring moved to L1.
  - l1OnRehash
```
public L1ConfigurationBuilder l1OnRehash(boolean l1OnRehash)
```
  - enable
```
public L1ConfigurationBuilder enable()
```
  - disable
```
public L1ConfigurationBuilder disable()
```
  - enabled
```
public L1ConfigurationBuilder enabled(boolean enabled)
```
  - 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<L1Configuration>
  - create
```
public L1Configuration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<L1Configuration>
    
    Returns:
  - read
```
public L1ConfigurationBuilder read(L1Configuration 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<L1Configuration>
    
    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
  - 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
  - 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 L1ConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

invalidationThreshold

lifespan

lifespan

cleanupTaskFrequency

cleanupTaskFrequency

enableOnRehash

onRehash

disableOnRehash

l1OnRehash

enable

disable

enabled

validate

create

read

toString

async

hash

l1

stateTransfer

sync

getClusteringBuilder

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build