Package com.ibm.websphere.cache

Class InvalidationEvent

java.lang.Object
java.util.EventObject
com.ibm.websphere.cache.InvalidationEvent
All Implemented Interfaces:
Serializable
public class InvalidationEvent extends EventObject
An event object that provides information about the source of cache-related event. InvalidationEvent objects are generated when cache entry is removed from the cache based on cache id, dependency id or template. The InvalidationEvent object contains six kinds of information:
  • id - the id that was invalidated
  • value - the value that was invalidated
  • causeOfInvaliation - the cause of invalidation that generated this event (defined as EXPLICIT, LRU, TIMEOUT or CLEAR_ALL)
  • sourceOfInvalidation - the source of invalidation that generated this event (defined as LOCAL or REMOTE)
  • cacheName - the name of the cache being used to invalidate.
  • timestamp - the timestamp of when this event was generated
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLEAR_ALL
    Define cause of invalidation for CLEAR_ALL
    static final int
    DISK_GARBAGE_COLLECTOR
    Define cause of invalidation for DISK_GARBAGE_COLLECTOR
    static final int
    DISK_OVERFLOW
    Define cause of invalidation for DISK_OVERFLOW
    static final int
    DISK_TIMEOUT
    Define cause of invalidation for DISK_TIMEOUT
    static final int
    EXPLICIT
    Define cause of invalidation for EXPLICIT
    static final int
    INACTIVE
    Define cause of invalidation for INACTIVE
    static final int
    LOCAL
    Define source of invalidation for LOCAL (cache in memory or disk)
    static final int
    LRU
    Define cause of invalidation for Least Recently Used(LRU)
    String
    m_cacheName
     
    static final int
    REMOTE
    Define source of invalidation for REMOTE
    static final int
    TIMEOUT
    Define cause of invalidation for TIMEOUT

  • Constructor Summary

    Constructors
    Constructor
    Description
    InvalidationEvent(Object id, Object value, int causeOfInvalidation, int sourceOfInvalidation, String cacheName)
    Create a new InvalidationEvent from id, cause of invalidation and source of invalidation

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCacheName()
    Gets the name of the cache being used to invalidate
    int
    getCauseOfInvalidation()
    Gets the cause of invalidation when this event was generated.
    Object
    getId()
    Gets the cache id that was invalidated.
    int
    getSourceOfInvalidation()
    Gets the source of invalidation when this event was generated.
    long
    getTimeStamp()
    Gets the timestamp of when this event was generated.
    Object
    getValue()
    Gets the cache value that was invalidated.

    Methods inherited from class java.util.EventObject

    getSource, toString

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • EXPLICIT

      public static final int EXPLICIT
      Define cause of invalidation for EXPLICIT
      See Also:

    • LRU

      public static final int LRU
      Define cause of invalidation for Least Recently Used(LRU)
      See Also:

    • TIMEOUT

      public static final int TIMEOUT
      Define cause of invalidation for TIMEOUT
      See Also:

    • DISK_TIMEOUT

      public static final int DISK_TIMEOUT
      Define cause of invalidation for DISK_TIMEOUT
      See Also:

    • CLEAR_ALL

      public static final int CLEAR_ALL
      Define cause of invalidation for CLEAR_ALL
      See Also:

    • INACTIVE

      public static final int INACTIVE
      Define cause of invalidation for INACTIVE
      See Also:

    • DISK_GARBAGE_COLLECTOR

      public static final int DISK_GARBAGE_COLLECTOR
      Define cause of invalidation for DISK_GARBAGE_COLLECTOR
      See Also:

    • DISK_OVERFLOW

      public static final int DISK_OVERFLOW
      Define cause of invalidation for DISK_OVERFLOW
      See Also:

    • LOCAL

      public static final int LOCAL
      Define source of invalidation for LOCAL (cache in memory or disk)
      See Also:

    • REMOTE

      public static final int REMOTE
      Define source of invalidation for REMOTE
      See Also:

    • m_cacheName

      public String m_cacheName

  • Constructor Details

    • InvalidationEvent

      public InvalidationEvent(Object id, Object value, int causeOfInvalidation, int sourceOfInvalidation, String cacheName)
      Create a new InvalidationEvent from id, cause of invalidation and source of invalidation

  • Method Details

    • getId

      public Object getId()
      Gets the cache id that was invalidated. Asterisk is defined for all cache Ids.
      Returns:
      the cache id that was invalidated.

    • getValue

      public Object getValue()
      Gets the cache value that was invalidated. If cache id is asterisk, the value will be returned as NULL. The value might be serialized in a byte array format. In this case, you must deserialize the returned value.
      Returns:
      the cache value that was invalidated.

    • getCauseOfInvalidation

      public int getCauseOfInvalidation()
      Gets the cause of invalidation when this event was generated. Use defined constants: EXPLICIT, LRU, TIMEOUT, DISK_TIMEOUT and CLEAR_ALL
      Returns:
      the cause of invalidation

    • getSourceOfInvalidation

      public int getSourceOfInvalidation()
      Gets the source of invalidation when this event was generated. Use defined constants: LOCAL and REMOTE
      Returns:
      the cause of invalidation

    • getCacheName

      public String getCacheName()
      Gets the name of the cache being used to invalidate
      Returns:
      the name of cache

    • getTimeStamp

      public long getTimeStamp()
      Gets the timestamp of when this event was generated.
      Returns:
      the timestamp