IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.cache
Interface EventSource


public interface EventSource

Runtime objects implement this when they are an event source Java objects can be registered with an EventSource. The listeners are called when the fireEvent, cacheEntryChanged, or shouldInvalidate methods is called.

Here are the functions for the interface:

Since:
WAS7.0

Method Summary
 void addListener(com.ibm.websphere.cache.ChangeListener listener)
          Invokes this method when a change listener is being added.
 void addListener(com.ibm.websphere.cache.InvalidationListener listener)
          Invokes this method when an invalidation listener is being added.
 void addListener(com.ibm.websphere.cache.PreInvalidationListener listener)
          Invokes this method when a pre-invalidation listener is being added.
 void cacheEntryChanged(com.ibm.websphere.cache.ChangeEvent event)
          Invokes this method when the change event is being fired.
 void fireEvent(com.ibm.websphere.cache.InvalidationEvent event)
          Invokes this method when the invalidation event is being fired.
 int getChangeListenerCount()
          Returns mumber of change listeners registered.
 int getInvalidationListenerCount()
          Returns number of invalidation listeners registered.
 int getPreInvalidationListenerCount()
          Returns number of pre-invalidation listener registered.
 void removeListener(com.ibm.websphere.cache.ChangeListener listener)
          Invokes this method when a change listener is being removed.
 void removeListener(com.ibm.websphere.cache.InvalidationListener listener)
          Invokes this method when an invalidation listener is being removed.
 void removeListener(com.ibm.websphere.cache.PreInvalidationListener listener)
          Invokes this method when a pre-invalidation listener is being removed.
 boolean shouldInvalidate(java.lang.Object id, int source, int cause)
          Invokes this method prior to the invalidation event occuring and is used to provide a callback that allows the listener to approve/deny an invalidation from occuring.
 

Method Detail

getInvalidationListenerCount

int getInvalidationListenerCount()
Returns number of invalidation listeners registered.

Returns:
invalidation listener count

getPreInvalidationListenerCount

int getPreInvalidationListenerCount()
Returns number of pre-invalidation listener registered. It should be 0 or 1.

Returns:
pre-invalidation listener count

getChangeListenerCount

int getChangeListenerCount()
Returns mumber of change listeners registered.

Returns:
change listener count

fireEvent

void fireEvent(com.ibm.websphere.cache.InvalidationEvent event)
Invokes this method when the invalidation event is being fired.


shouldInvalidate

boolean shouldInvalidate(java.lang.Object id,
                         int source,
                         int cause)
Invokes this method prior to the invalidation event occuring and is used to provide a callback that allows the listener to approve/deny an invalidation from occuring.


cacheEntryChanged

void cacheEntryChanged(com.ibm.websphere.cache.ChangeEvent event)
Invokes this method when the change event is being fired.


addListener

void addListener(com.ibm.websphere.cache.InvalidationListener listener)
Invokes this method when an invalidation listener is being added.

Parameters:
listener - the invalidation listener object
See Also:
removeListener(com.ibm.websphere.cache.InvalidationListener)

removeListener

void removeListener(com.ibm.websphere.cache.InvalidationListener listener)
Invokes this method when an invalidation listener is being removed.

Parameters:
listener - the invalidation listener object
See Also:
addListener(com.ibm.websphere.cache.InvalidationListener)

addListener

void addListener(com.ibm.websphere.cache.ChangeListener listener)
Invokes this method when a change listener is being added.

Parameters:
listener - the invalidation listener object
See Also:
removeListener(com.ibm.websphere.cache.ChangeListener)

removeListener

void removeListener(com.ibm.websphere.cache.ChangeListener listener)
Invokes this method when a change listener is being removed.

Parameters:
listener - the change listener object
See Also:
addListener(com.ibm.websphere.cache.ChangeListener)

addListener

void addListener(com.ibm.websphere.cache.PreInvalidationListener listener)
Invokes this method when a pre-invalidation listener is being added.

Parameters:
listener - the pre-invalidation listener object
See Also:
removeListener(com.ibm.websphere.cache.PreInvalidationListener)

removeListener

void removeListener(com.ibm.websphere.cache.PreInvalidationListener listener)
Invokes this method when a pre-invalidation listener is being removed.

Parameters:
listener - the pre-invalidation listener object
See Also:
addListener(com.ibm.websphere.cache.PreInvalidationListener)

IBM WebSphere Application ServerTM
Release 7