Package org.infinispan.configuration.cache

Class ExpirationConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.ExpirationConfigurationBuilder

All Implemented Interfaces:

Builder<ExpirationConfiguration>, ConfigurationChildBuilder

public class ExpirationConfigurationBuilder
extends Object
implements Builder<ExpirationConfiguration>

Controls the default expiration settings for entries in the cache.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
ExpirationConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. 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()
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()
long	maxIdle()	Maximum idle time a cache entry will be maintained in the cache, in milliseconds.
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()
QueryConfigurationBuilder	query()
ExpirationConfigurationBuilder	read(ExpirationConfiguration template, Combine combine)	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()
ExpirationConfigurationBuilder	touch(TouchMode touchMode)	Control how the timestamp of read keys are updated on all the key owners in a cluster.
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.Builder

read, reset

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

jmxStatistics

Field Details

builder

protected final ConfigurationBuilder builder

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<ExpirationConfiguration>

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.

maxIdle

public long maxIdle()

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.

Returns:

the max idle setting, default is -1 for disabled

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.

touch

public ExpirationConfigurationBuilder touch(TouchMode touchMode)

Control how the timestamp of read keys are updated on all the key owners in a cluster. Default is TouchMode.SYNC. If the cache mode is ASYNC this attribute is ignored, and timestamps are updated asynchronously.

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

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,
 Combine combine)

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.

combine - the way attributes and children of this instance and the template should be combined.

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(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated, for removal: This API element is subject to removal in a future version.

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

query

public QueryConfigurationBuilder query()

Specified by:

query 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