Package com.ibm.websphere.cache
Class InvalidationEvent
java.lang.Object
java.util.EventObject
com.ibm.websphere.cache.InvalidationEvent
- All Implemented Interfaces:
Serializable
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
Modifier and TypeFieldDescriptionstatic final int
Define cause of invalidation for CLEAR_ALLstatic final int
Define cause of invalidation for DISK_GARBAGE_COLLECTORstatic final int
Define cause of invalidation for DISK_OVERFLOWstatic final int
Define cause of invalidation for DISK_TIMEOUTstatic final int
Define cause of invalidation for EXPLICITstatic final int
Define cause of invalidation for INACTIVEstatic final int
Define source of invalidation for LOCAL (cache in memory or disk)static final int
Define cause of invalidation for Least Recently Used(LRU)static final int
Define source of invalidation for REMOTEstatic final int
Define cause of invalidation for TIMEOUT -
Constructor Summary
ConstructorDescriptionInvalidationEvent
(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 TypeMethodDescriptionGets the name of the cache being used to invalidateint
Gets the cause of invalidation when this event was generated.getId()
Gets the cache id that was invalidated.int
Gets the source of invalidation when this event was generated.long
Gets the timestamp of when this event was generated.getValue()
Gets the cache value that was invalidated.Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
EXPLICIT
public static final int EXPLICITDefine cause of invalidation for EXPLICIT- See Also:
-
LRU
public static final int LRUDefine cause of invalidation for Least Recently Used(LRU)- See Also:
-
TIMEOUT
public static final int TIMEOUTDefine cause of invalidation for TIMEOUT- See Also:
-
DISK_TIMEOUT
public static final int DISK_TIMEOUTDefine cause of invalidation for DISK_TIMEOUT- See Also:
-
CLEAR_ALL
public static final int CLEAR_ALLDefine cause of invalidation for CLEAR_ALL- See Also:
-
INACTIVE
public static final int INACTIVEDefine cause of invalidation for INACTIVE- See Also:
-
DISK_GARBAGE_COLLECTOR
public static final int DISK_GARBAGE_COLLECTORDefine cause of invalidation for DISK_GARBAGE_COLLECTOR- See Also:
-
DISK_OVERFLOW
public static final int DISK_OVERFLOWDefine cause of invalidation for DISK_OVERFLOW- See Also:
-
LOCAL
public static final int LOCALDefine source of invalidation for LOCAL (cache in memory or disk)- See Also:
-
REMOTE
public static final int REMOTEDefine source of invalidation for REMOTE- See Also:
-
m_cacheName
-
-
Constructor Details
-
Method Details
-
getId
Gets the cache id that was invalidated. Asterisk is defined for all cache Ids.- Returns:
- the cache id that was invalidated.
-
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
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
-