com.ibm.websphere.objectgrid.config
Interface Plugin

All Superinterfaces:

Serializable

public interface Plugin
extends Serializable

This interface represents an ObjectGrid or BackingMap plugin. An ObjectGridConfiguration object supports the following Plugins:

• PluginType#OBJECTGRID_EVENT_LISTENER
• PluginType#TRANSACTION_CALLBACK

A BackingMapConfiguration object supports the following Plugins:

• PluginType#EVICTOR
• PluginType#MAP_EVENT_LISTENER

A Plugin object has following attributes:

• pluginType: the support PluginTypes are listed above
• className: the plugin implementation class name. This class name will be used to construct the class object. A default constructor must be implemented.
• configProperties: the JavaBean properties for this plugin implementation object.

A plugin object can be created by using ObjectGridConfigFactory.createPlugin(PluginType, String) method. Please refer to ObjectGridConfigFactory for detailed example.

Since:

WAS XD 6.0.1.2, XC10

Method Summary

void	addConfigProperty(ConfigProperty configProp) Add a ConfigProperty to this object.
String	getClassName() Get the String representation of the class name of this Plugin
List	getConfigProperties() Get the ConfigProperty objects that have been set on this object.
String	getOSGiService() Get the OSGi service name configured for this Plugin.
PluginType	getPluginType() Get the PluginType for this Plugin.
void	setClassName(String className) The class name that is set must be an implementor of the PluginTypeImpl for this Plugin.
void	setConfigProperties(List configPropList) Set the ConfigProperties for this object
void	setOSGiService(String osgiService) Set the OSGi service name configured for this Plugin.
void	setPluginType(PluginType pluginType) Set the PluginType for this Plugin.

Method Detail

addConfigProperty

void addConfigProperty(ConfigProperty configProp)

Add a ConfigProperty to this object.

Parameters:

configProp - - ConfigProperty to add to this object

setConfigProperties

void setConfigProperties(List configPropList)

Set the ConfigProperties for this object

Parameters:

configPropList -

getConfigProperties

List getConfigProperties()

Get the ConfigProperty objects that have been set on this object.

Returns:

a List of the ConfigProperty objects that have been added to this object.

See Also:

ConfigProperty

getPluginType

PluginType getPluginType()

Get the PluginType for this Plugin.

Returns:

the PluginType for this Plugin

setPluginType

void setPluginType(PluginType pluginType)

Set the PluginType for this Plugin.

The ObjectGridConfiguration plugins include

• PluginType.TRANSACTION_CALLBACK
• PluginType.OBJECTGRID_EVENT_LISTENER

The BackingMapConfiguration plugins include

• PluginType.EVICTOR
• PluginType.MAP_EVENT_LISTENER

Parameters:

pluginType -

getClassName

String getClassName()

Get the String representation of the class name of this Plugin

Returns:

the String representation of the class name

setClassName

void setClassName(String className)

The class name that is set must be an implementor of the PluginTypeImpl for this Plugin. For example, if the type of this Plugin is PluginType.EVICTOR, then the className must be an implementor of the com.ibm.websphere.objectgrid.plugins.Evictor interface.

Parameters:

className - - the class name of the Class that implements the PluginType

getOSGiService

String getOSGiService()

Get the OSGi service name configured for this Plugin. If an OSGi service name is configured for this Plugin, the className configured for this Plugin is ignored.

Returns:

the OSGi service name configured for this Plugin.

Since:

7.1.1

setOSGiService

void setOSGiService(String osgiService)

Set the OSGi service name configured for this Plugin. If an OSGi service name is configured for this Plugin, the className configured for this Plugin is ignored.

Parameters:

osgiService - the OSGi service name configured for this Plugin.

Since:

7.1.1