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

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

All Implemented Interfaces:

BaseConfigurationInfo, Builder<ExpirationConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder
```
public class ExpirationConfigurationBuilder
extends Object
implements Builder<ExpirationConfiguration>, ConfigurationBuilderInfo
```
Controls the default expiration settings for entries in the cache.

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()`
`ClusteringConfigurationBuilder`	`clustering()`
`ExpirationConfiguration`	`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
`ExpirationConfigurationBuilder`	`disableReaper()` Disable the background reaper to test entries for expiration.
`ExpirationConfigurationBuilder`	`enableReaper()` Enable the background reaper to test entries for expiration.
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`ElementDefinition`	`getElementDefinition()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`ExpirationConfigurationBuilder`	`lifespan(long l)` Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds.
`ExpirationConfigurationBuilder`	`lifespan(long l, TimeUnit unit)` Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds.
`LockingConfigurationBuilder`	`locking()`
`ExpirationConfigurationBuilder`	`maxIdle(long l)` Maximum idle time a cache entry will be maintained in the cache, in milliseconds.
`ExpirationConfigurationBuilder`	`maxIdle(long l, TimeUnit unit)` Maximum idle time a cache entry will be maintained in the cache, in milliseconds.
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`ExpirationConfigurationBuilder`	`read(ExpirationConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`boolean`	`reaperEnabled()`
`ExpirationConfigurationBuilder`	`reaperEnabled(boolean enabled)` Enable the background reaper to test entries for expiration.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`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)`
`long`	`wakeupInterval()`
`ExpirationConfigurationBuilder`	`wakeUpInterval(long l)` Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores.
`ExpirationConfigurationBuilder`	`wakeUpInterval(long l, TimeUnit unit)` Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores.

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
jmxStatistics

- 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.
  - lifespan
```
public ExpirationConfigurationBuilder lifespan(long l)
```
    Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire. Note that this can be overridden on a per-entry basis by using the Cache API.
  - lifespan
```
public ExpirationConfigurationBuilder lifespan(long l,
                                               TimeUnit unit)
```
    Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire. Note that this can be overridden on a per-entry basis by using the Cache API.
  - maxIdle
```
public ExpirationConfigurationBuilder maxIdle(long l)
```
    Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire. Note that this can be overridden on a per-entry basis by using the Cache API.
  - maxIdle
```
public ExpirationConfigurationBuilder maxIdle(long l,
                                              TimeUnit unit)
```
    Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire. Note that this can be overridden on a per-entry basis by using the Cache API.
  - enableReaper
```
public ExpirationConfigurationBuilder enableReaper()
```
    Enable the background reaper to test entries for expiration. Regardless of whether a reaper is used, entries are tested for expiration lazily when they are touched.
  - reaperEnabled
```
public ExpirationConfigurationBuilder reaperEnabled(boolean enabled)
```
    Enable the background reaper to test entries for expiration. Regardless of whether a reaper is used, entries are tested for expiration lazily when they are touched.
  - disableReaper
```
public ExpirationConfigurationBuilder disableReaper()
```
    Disable the background reaper to test entries for expiration. to test entries for expiration. Regardless of whether a reaper is used, entries are tested for expiration lazily when they are touched.
  - reaperEnabled
```
public boolean reaperEnabled()
```
  - wakeUpInterval
```
public ExpirationConfigurationBuilder wakeUpInterval(long l)
```
    Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.
  - wakeupInterval
```
public long wakeupInterval()
```
  - wakeUpInterval
```
public ExpirationConfigurationBuilder wakeUpInterval(long l,
                                                     TimeUnit unit)
```
    Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.
  - 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<ExpirationConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - create
```
public ExpirationConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<ExpirationConfiguration>
    
    Returns:
  - read
```
public ExpirationConfigurationBuilder read(ExpirationConfiguration 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<ExpirationConfiguration>
    
    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
```
@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 ExpirationConfigurationBuilder

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

lifespan

lifespan

maxIdle

maxIdle

enableReaper

reaperEnabled

disableReaper

reaperEnabled

wakeUpInterval

wakeupInterval

wakeUpInterval

validate

validate

attributes

create

read

toString

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build