Plug-ins for providing event listeners

You can use the ObjectGridEventListener, MapEventListener, ObjectGridLifecycleListener and BackingMapLifecycleListener plug-ins to configure notifications for various events in the eXtreme Scale cache. Listener plug-ins are registered with an ObjectGrid or BackingMap instance like other eXtreme Scale plug-ins and add integration and customization points for applications and cache providers.

ObjectGridEventListener plug-in

An ObjectGridEventListener plug-in provides eXtreme Scale life cycle events for the ObjectGrid instance, shards, and transactions. Use the ObjectGridEventListener plug-in to receive notifications when significant events occur on an ObjectGrid. These events include ObjectGrid initialization, the beginning of a transaction, the ending a transaction, and destroying an ObjectGrid. To listen for these events, create a class that implements the ObjectGridEventListener interface and add it to the eXtreme Scale.

For more information about writing an ObjectGridEventListener plug-in, see ObjectGridEventListener plug-in. You can also refer to the API documentation for more information.

Adding and removing ObjectGridEventListener instances

An ObjectGrid can have multiple ObjectGridEventListener listeners. Add and remove the listeners using the addEventListener, and removeEventListener methods on the ObjectGrid interface. You can also declaratively registerObjectGridEventListener plug-ins with the ObjectGrid descriptor file. For examples, see ObjectGridEventListener plug-in.

MapEventListener plug-in

A MapEventListener plug-in provides callback notifications and significant cache state changes that occur for a BackingMap instance. For details on writing a MapEventListener plug-in, see MapEventListener plug-in. You can also refer to the API documentation for more information.

Adding and removing MapEventListener instances

An eXtreme Scale can have multiple MapEventListener listeners. Add and remove listeners with the addMapEventListener, and removeMapEventListener methods on the BackingMap interface. You can also declaratively register MapEventListener listeners with the ObjectGrid descriptor file. For examples, see MapEventListener plug-in.

BackingMapLifecycleListener plug-in

A BackingMapLifecycleListener plug-in provides callback notifications for life cycle state changes that occur for a BackingMap instance. The BackingMap instance proceeds through a predefined set of states during its life time.

Adding and removing BackingMapLifecycleListener instances

An eXtreme Scale server can have multiple BackingMapLifecycleListener listeners. Add and remove listeners with the addMapEventListener and removeMapEventListener methods on the BackingMap interface. Any BackingMap plug-ins that implement the BackingMapLifecycleListener interface are also automatically added as a BackingMapLifecycleListener for the ObjectGrid instance they are registered with. You can also declaratively register BackingMapLifecycleListener listeners with the ObjectGrid descriptor file. For examples, see BackingMapLifecycleListener plug-in.

ObjectGridLifecycleListener plug-in

An ObjectGridLifecycleListener plug-in provides callback notifications for life cycle state changes that occur for an ObjectGrid instance. The ObjectGrid instance proceeds through a predefined set of states during its life time.

Adding and removing ObjectGridLifecycleListener instances

An eXtreme Scale can have multiple ObjectGridLifecycleListener listeners. Add and remove listeners with the addEventListener and removeEventListener methods on the ObjectGrid interface. Any ObjectGrid plug-ins that implement the ObjectGridLifecycleListener interface are automatically added as an ObjectGridLifecycleListener for the ObjectGrid instance that they are registered with. You can also declaratively register ObjectGridLifecycleListener listeners with the ObjectGrid deployment descriptor file. For examples, see ObjectGridLifecycleListener plug-in.