IBM®
Skip to main content
    Country/region [select]      Terms of use
 
 
    
     Home      Products      Services & solutions      Support & downloads      My account     
 
developerworks > My developerWorks >  Dashboard > WebSphere eXtreme Scale V6.1 User Guide > ... > ObjectGrid system programming API > Introduction to plug-ins
developerWorks
Log In   View a printable version of the current page.
Overview Connect Spaces Forums Wikis
Introduction to plug-ins
Added by Chris.D.Johnson, last edited by saif.patel@us.ibm.com on Jan 05, 2009  (view change)
Labels: 
(None)

Getting Started Examples Reference API documentation

See the WebSphere eXtreme Scale Wiki for links to eXtreme Scale Version 7.0 documentation.
If you log in with your developerWorks ID, you can leave comments and feedback for the development team.

A plug-in in ObjectGrid is a component that provides a certain type of function to the pluggable ObjectGrid components that include ObjectGrid and BackingMap.
The ObjectGrid provides several plug points to allow applications and cache providers to integrate with various data stores, alternative client APIs and to improve overall performance of the cache. The ObjectGrid ships with several default, pre-built plugins, but you can also build custom plug-ins with the application.

ObjectGrid plug-ins are concrete classes that implement one or more ObjectGrid plug-in interfaces. These classes are then instantiated and invoked by the ObjectGrid at appropriate times.

The ObjectGrid and BackingMaps each allow custom plug-ins to be registered.

ObjectGrid plug-ins

The following plug-ins are available for an ObjectGrid:

BackingMap plug-ins

The following plug-ins are available for a BackingMap:

  • Evictor - ObjectGrid provides a default mechanism for evicting cache entries and a plug-in for creating custom evictors.
  • Loader - With an ObjectGrid Loader plug-in, an ObjectGrid map can behave as a memory cache for data that is typically kept in a persistent store on either the same system or some other system.
  • ObjectTransformer - With the ObjectTransformer plug-in, you can serialize, deserialize, and copy objects in the cache.
  • OptimisticCallback - Use the OptimisticCallback plug-in to customize versioning and comparision operations of cache objects when using the optimistic lock strategy.
  • MapEventListener - A MapEventListener plug-in provides callback notifications and significant cache state changes that occur for a BackingMap.
  • MapIndexPlugin - Use the indexing feature, which is represented by the MapIndexPlugin plug-in, to build an index or several indices on a BackingMap map to support non-key data access.

Common ObjectGrid plug-in requirements

The ObjectGrid instantiates plug-in instances and initializes them using JavaBeans conventions. All of the previous plug-in implementations have the following requirements:

  • The plug-in class must be a top-level public class.
  • The plug-in class must provide a public, no-argument constructor.
  • The plug-in class must be available in the class path for both servers and clients (as appropriate).
  • Attributes must be set using the JavaBean style property methods.
  • Plug-ins, unless specifically noted, are registered before ObjectGrid initializes and cannot be changed after the ObjectGrid is initialized.
Wiki Disclaimer and License
© Copyright IBM Corporation 2007,2009. All Rights Reserved.
Docs Evictors (WebSphere eXtreme Scale V6.1 User Guide)
Docs Indexing (WebSphere eXtreme Scale V6.1 User Guide)
Docs Introduction to plug-in slots (WebSphere eXtreme Scale V6.1 User Guide)
Docs Loaders (WebSphere eXtreme Scale V6.1 User Guide)
Docs MapEventListener plug-in (WebSphere eXtreme Scale V6.1 User Guide)
Docs ObjectGridEventListener plug-in (WebSphere eXtreme Scale V6.1 User Guide)
Docs ObjectTransformer plug-in (WebSphere eXtreme Scale V6.1 User Guide)
Docs OptimisticCallback plug-in (WebSphere eXtreme Scale V6.1 User Guide)
Docs TransactionCallback plug-in (WebSphere eXtreme Scale V6.1 User Guide)


 
    About IBM Privacy Contact