Package com.ibm.websphere.cache

Class ChangeEvent

java.lang.Object

java.util.EventObject

com.ibm.websphere.cache.ChangeEvent

All Implemented Interfaces:

Serializable

public class ChangeEvent
extends EventObject

An event object that provides information about the source of cache-related events. ChangeEvent objects are generated when cache entries are changed in the cache. The ChangeEvent object contains six pieces of information:

• id - the id that was changed
• value - the new value
• causeOfChange - the cause of change that generated this event (defined as EXISTING_VALUE_CHANGED or NEW_ENTRY_ADDED)
• sourceOfChange - the source of change that generated this event (defined as LOCAL or REMOTE)
• cacheName - the name of the cache
• timestamp - the timestamp of when this event was generated

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXISTING_VALUE_CHANGED	Defines the cause of change for type EXISTING_VALUE_CHANGED
static final int	EXPIRATION_TIMES_CHANGED	Defines the cause of change for type EXPIRATION_TIMES_CHANGED.
static final int	LOCAL	Define source of change for LOCAL (cache in memory or disk)
String	m_cacheName
static final int	NEW_ENTRY_ADDED	Defines the cause of change for type NEW_ENTRY_ADDED
static final int	REMOTE	Defines the source of change for type REMOTE

Constructor Summary

Constructors

Constructor	Description
ChangeEvent(Object id, Object value, int causeOfChange, int sourceOfChange, String cacheName)	Create a new ChangeEvent from id, value, cause of change, source of change and cache name

Method Summary

Modifier and Type	Method	Description
String	getCacheName()	Gets the name of the cache
int	getCauseOfChange()	Gets the cause of change when this event was generated.
Object	getId()	Gets the cache id that was changed.
int	getSourceOfChange()	Gets the source of change when this event was generated.
long	getTimeStamp()	Gets the timestamp of when this event was generated.
Object	getValue()	Gets new value.

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

EXISTING_VALUE_CHANGED

public static final int EXISTING_VALUE_CHANGED

Defines the cause of change for type EXISTING_VALUE_CHANGED

See Also:

• Constant Field Values

NEW_ENTRY_ADDED

public static final int NEW_ENTRY_ADDED

Defines the cause of change for type NEW_ENTRY_ADDED

See Also:

• Constant Field Values

EXPIRATION_TIMES_CHANGED

public static final int EXPIRATION_TIMES_CHANGED

Defines the cause of change for type EXPIRATION_TIMES_CHANGED. This constant is used by Validation Based Cache feature.

See Also:

• Constant Field Values

LOCAL

public static final int LOCAL

Define source of change for LOCAL (cache in memory or disk)

See Also:

• Constant Field Values

REMOTE

public static final int REMOTE

Defines the source of change for type REMOTE

See Also:

• Constant Field Values

m_cacheName

public String m_cacheName

Constructor Details

ChangeEvent

public ChangeEvent(Object id,
 Object value,
 int causeOfChange,
 int sourceOfChange,
 String cacheName)

Create a new ChangeEvent from id, value, cause of change, source of change and cache name

Method Details

getId

public Object getId()

Gets the cache id that was changed.

Returns:

the cache id that was changed.

getValue

public Object getValue()

Gets new value. The value might be serialized in a byte array format. In this case, you must deserialize the returned value.

Returns:

the new value.

getCauseOfChange

public int getCauseOfChange()

Gets the cause of change when this event was generated. Use defined constants: EXISTING_VALUE_CHANGED or NEW_ENTRY_ADDED

Returns:

the cause of change

getSourceOfChange

public int getSourceOfChange()

Gets the source of change when this event was generated. Use defined constants: LOCAL and REMOTE

Returns:

the cause of change

getCacheName

public String getCacheName()

Gets the name of the cache

Returns:

the name of cache

getTimeStamp

public long getTimeStamp()

Gets the timestamp of when this event was generated.

Returns:

the timestamp