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

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

All Implemented Interfaces:

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

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`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()`
`L1Configuration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()` Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
`L1ConfigurationBuilder`	`disable()`
`L1ConfigurationBuilder`	`enable()`
`L1ConfigurationBuilder`	`enabled(boolean enabled)`
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`protected ClusteringConfigurationBuilder`	`getClusteringBuilder()`
`ElementDefinition`	`getElementDefinition()`
`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()`
`L1ConfigurationBuilder`	`l1()` Configures the L1 cache behavior in 'distributed' caches instances.
`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()`
`MemoryConfigurationBuilder`	`memory()`
`PartitionHandlingConfigurationBuilder`	`partitionHandling()` Configures how the cache will react to cluster partitions.
`PersistenceConfigurationBuilder`	`persistence()`
`L1ConfigurationBuilder`	`read(L1Configuration template)` Reads the configuration from an already created configuration bean into this builder.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StateTransferConfigurationBuilder`	`stateTransfer()` Configures how state is transferred when a new cache joins the cluster.
`StatisticsConfigurationBuilder`	`statistics()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`

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

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo
getBuilderInfo, getChildrenInfo, getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Method Detail
  - getElementDefinition
```
public ElementDefinition getElementDefinition()
```
    Specified by:
    
    getElementDefinition in interface BaseConfigurationInfo
    
    Returns:
    
    the ElementDefinition of the configuration.
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - 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
  - 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>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - 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
  - 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
  - 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()
```
  - 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
```
@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
    
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding 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
  - statistics
```
public StatisticsConfigurationBuilder statistics()
```
    Specified by:
    
    statistics 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
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites 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 L1ConfigurationBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

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

Field Detail

builder

Method Detail

getElementDefinition

attributes

invalidationThreshold

lifespan

lifespan

cleanupTaskFrequency

cleanupTaskFrequency

enable

disable

enabled

validate

validate

create

read

toString

hash

l1

stateTransfer

partitionHandling

getClusteringBuilder

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build