Package org.infinispan.configuration.cache

Class ExpirationConfiguration

  • All Implemented Interfaces:
    org.infinispan.commons.configuration.attributes.Matchable<ExpirationConfiguration>, org.infinispan.commons.configuration.attributes.Updatable<ExpirationConfiguration>
    public class ExpirationConfiguration
extends org.infinispan.commons.configuration.attributes.ConfigurationElement<ExpirationConfiguration>
    Controls the default expiration settings for entries in the cache.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> LIFESPAN  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> MAX_IDLE  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> REAPER_ENABLED  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<TouchMode> TOUCH  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> WAKEUP_INTERVAL  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long lifespan()
      Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds.
      long maxIdle()
      Maximum idle time a cache entry will be maintained in the cache, in milliseconds.
      boolean reaperEnabled()
      Determines whether the background reaper thread is enabled to test entries for expiration.
      TouchMode touch()
      Control how the timestamp of read keys are updated on all the key owners in a cluster.
      long wakeUpInterval()
      Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores.

    • Field Detail

      • LIFESPAN

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> LIFESPAN

      • MAX_IDLE

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> MAX_IDLE

      • REAPER_ENABLED

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> REAPER_ENABLED

      • WAKEUP_INTERVAL

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Long> WAKEUP_INTERVAL

      • TOUCH

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<TouchMode> TOUCH

    • Method Detail

      • lifespan

        public long lifespan()
        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 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. Note that this can be overridden on a per-entry basis by using the Cache API.

      • reaperEnabled

        public boolean reaperEnabled()
        Determines whether the background reaper thread is enabled to test entries for expiration. Regardless of whether a reaper is used, entries are tested for expiration lazily when they are touched.

      • wakeUpInterval

        public long wakeUpInterval()
        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 TouchMode touch()
        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.