com.ibm.websphere.objectgrid.plugins
Interface BackingMapLifecycleListener

All Superinterfaces:

EventListener

public interface BackingMapLifecycleListener
extends EventListener

Listener for BackingMap life cycle events. The lifecycle listener can indicate a fatal error condition using the LifecycleFailedException for a lifecycle event associated with the INITIALIZING, INITIALIZED, OFFLINE, STARTING, and PRELOAD states. The LifecycleFailedException will cause an abort and destruction of the shard.

A BackingMapLifecycleListener implementation may also implement the BackingMapPlugin interface in order to receive enhanced BackingMap plug-in lifecycle method calls. The plug-in is also required to correctly implement each of the bean methods related to introspection of its state (for example isInitialized(), isDestroyed(), etc).

Since:

7.1.1

See Also:

BackingMap.addMapEventListener(EventListener), EventListener

Nested Class Summary

static interface	BackingMapLifecycleListener.LifecycleEvent The LifecycleEvent describes the situation that caused a change in the lifecycle of the BackingMap.
static class	BackingMapLifecycleListener.State The state of a BackingMap's life cycle.

Method Summary

void	backingMapStateChanged(BackingMapLifecycleListener.LifecycleEvent event) Invoked when there is a change to the BackingMap's life cycle.

Method Detail

backingMapStateChanged

void backingMapStateChanged(BackingMapLifecycleListener.LifecycleEvent event)
                            throws LifecycleFailedException

Invoked when there is a change to the BackingMap's life cycle. When LifecycleFailedExceptions are thrown for the following lifecycle states, the BackingMap instance will abort the state change and be destroyed: INITIALIZING, INITIALIZED, STARTING, and PRELOAD. Exceptions thrown during other phases will be logged as error conditions.

Parameters:

event - contextual data for the event.

Throws:

LifecycleFailedException - thrown when there is a fatal exception. For some states, the BackingMap instance will abort the state change and be destroyed.