Class TimeToLiveCacheInvalidationPolicy

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class TimeToLiveCacheInvalidationPolicy
    extends CacheInvalidationPolicy
    PUBLIC: A CacheInvalidationPolicy which allows objects to live for a specific amount of time after they are read. A TimeToLiveCacheInvalidationPolicy is instantiated with a specific number of milliseconds. This represents how long after an object is read it will expire.
    See Also:
    CacheInvalidationPolicy, Serialized Form
    • Field Detail

      • timeToLive

        protected long timeToLive
        Number of milliseconds before invalidation.
    • Constructor Detail

      • TimeToLiveCacheInvalidationPolicy

        public TimeToLiveCacheInvalidationPolicy()
        INTERNAL: Default Constructor for Project XML Unless the timeToLive is set by method, objects will expire immediately
      • TimeToLiveCacheInvalidationPolicy

        public TimeToLiveCacheInvalidationPolicy​(long timeToLive)
        PUBLIC: Construct a TimeToLiveCacheInvalidationPolicy
        timeToLive - the number of milliseconds an object affected by this policy will live.
    • Method Detail

      • getExpiryTimeInMillis

        public long getExpiryTimeInMillis​(org.eclipse.persistence.internal.identitymaps.CacheKey key)
        INTERNAL: Return the next expiry time.
        Specified by:
        getExpiryTimeInMillis in class CacheInvalidationPolicy
      • getTimeToLive

        public long getTimeToLive()
        PUBLIC: Return the time-to-live specified for this policy.
      • isInvalidated

        public boolean isInvalidated​(org.eclipse.persistence.internal.identitymaps.CacheKey key,
                                     long currentTimeMillis)
        INTERNAL: Return true if this object is set as invalid or has expired.
        Specified by:
        isInvalidated in class CacheInvalidationPolicy
      • setTimeToLive

        public void setTimeToLive​(long timeToLive)
        PUBLIC: Set the time-to-live specified by this policy.