com.bea.wlcp.wlng.api.plugin
Interface PluginHolder

public interface PluginHolder

Holder for a plug-in type and the plug-in instance.

Method Summary

abstract java.lang.String	getId() Returns the plug-in id.
abstract Plugin	getPlugin() Returns the plug-in.
abstract PluginInstance	getPluginInstance() Returns the PluginInstance.
abstract PluginService	getPluginService() Returns the PluginService.
abstract boolean	isRequired() Returns true if the plug-in is required, false if it is optional.
abstract void	setRequired(boolean required) Sets the plug-in as required or optional.

Method Detail

getId

public java.lang.String getId()

Returns the plug-in id.

Returns:

The plug-in id.

getPlugin

public Plugin getPlugin()

Returns the plug-in.

Returns:

The plug-in.

getPluginInstance

public PluginInstance getPluginInstance()

Returns the PluginInstance.

Returns:

The plug-in instance.

getPluginService

public PluginService getPluginService()

Returns the PluginService.

Returns:

The plug-in service.

isRequired

public boolean isRequired()

Returns true if the plug-in is required, false if it is optional. A typical use case of this flag is the following scenario: - a request is part of an ongoing conversation and therefore must continue to be routed to the same plug-in that is has been routed at the start of the conversation. Note: it is discouraged to use this flag as a substitute for a "stateless" plug-in. That is, this flag should not be used to "broadcast" a request to all plug-ins in the case that the plug-in lacks the state to indicate which request it can handle.

Returns:

true if required, false if optional.

setRequired

public void setRequired(boolean required)

Sets the plug-in as required or optional.

Parameters:

required - True if the plug-in is required, false if it is optional.