Infinispan Distribution 5.2.6.Final-redhat-2

org.infinispan.configuration.cache
Class ExpirationConfigurationBuilder

java.lang.Object
  extended by 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.


Method Summary
 Configuration build()
           
 ClusteringConfigurationBuilder clustering()
           
 ExpirationConfiguration create()
          Create the configuration bean
 CustomInterceptorsConfigurationBuilder customInterceptors()
           
 DataContainerConfigurationBuilder dataContainer()
           
 DeadlockDetectionConfigurationBuilder deadlockDetection()
           
 ExpirationConfigurationBuilder disableReaper()
          Disable the background reaper to test entries for expiration.
 ExpirationConfigurationBuilder enableReaper()
          Enable the background reaper to test entries for expiration.
 EvictionConfigurationBuilder eviction()
           
 ExpirationConfigurationBuilder expiration()
           
protected  ConfigurationBuilder getBuilder()
           
 IndexingConfigurationBuilder indexing()
           
 InvocationBatchingConfigurationBuilder invocationBatching()
           
 JMXStatisticsConfigurationBuilder jmxStatistics()
           
 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.
 LoadersConfigurationBuilder loaders()
           
 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.
 ExpirationConfigurationBuilder read(ExpirationConfiguration template)
          Reads the configuration from an already created configuration bean into this builder.
 ExpirationConfigurationBuilder reaperEnabled(boolean enabled)
          Enable the background reaper to test entries for expiration.
 SitesConfigurationBuilder sites()
           
 StoreAsBinaryConfigurationBuilder storeAsBinary()
           
 String toString()
           
 TransactionConfigurationBuilder transaction()
           
 UnsafeConfigurationBuilder unsafe()
           
 void validate()
          Validate the data in this builder before building the configuration bean
 VersioningConfigurationBuilder versioning()
           
 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
 

Method Detail

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.


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 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>

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

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

loaders

public LoadersConfigurationBuilder loaders()
Specified by:
loaders 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

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()
Specified by:
build in interface ConfigurationChildBuilder

Infinispan Distribution 5.2.6.Final-redhat-2

Copyright © 2013 JBoss, a division of Red Hat. All Rights Reserved.