IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.cache
Class InvalidationEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.ibm.websphere.cache.InvalidationEvent
All Implemented Interfaces:
java.io.Serializable

public class InvalidationEvent
extends java.util.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:

See Also:
Serialized Form

Field Summary
static int CLEAR_ALL
          Define cause of invalidation for CLEAR_ALL
static int DISK_GARBAGE_COLLECTOR
          Define cause of invalidation for DISK_GARBAGE_COLLECTOR
static int DISK_OVERFLOW
          Define cause of invalidation for DISK_OVERFLOW
static int DISK_TIMEOUT
          Define cause of invalidation for DISK_TIMEOUT
static int EXPLICIT
          Define cause of invalidation for EXPLICIT
static int INACTIVE
          Define cause of invalidation for INACTIVE
static int LOCAL
          Define source of invalidation for LOCAL (cache in memory or disk)
static int LRU
          Define cause of invalidation for Least Recently Used(LRU)
 java.lang.String m_cacheName
           
static int REMOTE
          Define source of invalidation for REMOTE
static int TIMEOUT
          Define cause of invalidation for TIMEOUT
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
InvalidationEvent(java.lang.Object id, java.lang.Object value, int causeOfInvalidation, int sourceOfInvalidation, java.lang.String cacheName)
          Create a new InvalidationEvent from id, cause of invalidation and source of invalidation
 
Method Summary
 java.lang.String getCacheName()
          Gets the name of the cache being used to invalidate
 int getCauseOfInvalidation()
          Gets the cause of invalidation when this event was generated.
 java.lang.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.
 java.lang.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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXPLICIT

public static final int EXPLICIT
Define cause of invalidation for EXPLICIT

See Also:
Constant Field Values

LRU

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

See Also:
Constant Field Values

TIMEOUT

public static final int TIMEOUT
Define cause of invalidation for TIMEOUT

See Also:
Constant Field Values

DISK_TIMEOUT

public static final int DISK_TIMEOUT
Define cause of invalidation for DISK_TIMEOUT

See Also:
Constant Field Values

CLEAR_ALL

public static final int CLEAR_ALL
Define cause of invalidation for CLEAR_ALL

See Also:
Constant Field Values

INACTIVE

public static final int INACTIVE
Define cause of invalidation for INACTIVE

See Also:
Constant Field Values

DISK_GARBAGE_COLLECTOR

public static final int DISK_GARBAGE_COLLECTOR
Define cause of invalidation for DISK_GARBAGE_COLLECTOR

See Also:
Constant Field Values

DISK_OVERFLOW

public static final int DISK_OVERFLOW
Define cause of invalidation for DISK_OVERFLOW

See Also:
Constant Field Values

LOCAL

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

See Also:
Constant Field Values

REMOTE

public static final int REMOTE
Define source of invalidation for REMOTE

See Also:
Constant Field Values

m_cacheName

public java.lang.String m_cacheName
Constructor Detail

InvalidationEvent

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

Method Detail

getId

public java.lang.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 java.lang.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 java.lang.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

IBM WebSphere Application ServerTM
Release 7