com.bea.wlpi.server.plugin
Interface PluginManager

All Known Subinterfaces:

PluginManagerCfg

public interface PluginManager

extends javax.ejb.EJBObject

Manages WebLogic Process Integrator plugins. The plugin manager provides design-time and run-time support to the design client and workflow enactment service. It is responsible for providing meta-data about the combined capabilities of all deployed plugins, access to plugin-supplied design-time and run-time components, and handling event notifications to and from plugins.

Since:

WebLogic Process Integrator version 2.0

Author:

Copyright © 2000, 2001 BEA Systems, Inc. All Rights Reserved.

See Also:

PluginManagerCfg

Method Summary

void	addInstanceListener(Plugin plugin, int mask) Deprecated. Call PluginManagerCfg.addInstanceListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	addTaskListener(Plugin plugin, int mask) Deprecated. Call PluginManagerCfg.addTaskListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	addTemplateDefinitionListener(Plugin plugin, int mask) Deprecated. Call PluginManagerCfg.addTemplateDefinitionListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	addTemplateListener(Plugin plugin, int mask) Deprecated. Call PluginManagerCfg.addTemplateListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.
java.lang.Class	classForName(java.lang.String pluginName, java.lang.String className) Return a plugin-defined class.
CategoryInfo[]	getActionInfo(java.util.Locale lc) Return a consolidated list of all actions and action categories.
DoneInfo[]	getDoneInfo(java.util.Locale lc) Return a list of plugin-defined done node types.
EventHandlerInfo[]	getEventHandlerInfo(java.util.Locale lc) Return a list of plugin-defined event handlers.
EventInfo[]	getEventInfo(java.util.Locale lc) Return a list of plugin-defined event node types.
FieldInfo[]	getFieldInfo(java.util.Locale lc) Return a list of plugin-defined field types.
VersionInfo	getFrameworkVersion() Return the Plugin Framework version.
FunctionInfo[]	getFunctionInfo(java.util.Locale lc) Return a consolidated list of all evaluator functions.
HelpSetInfo[]	getHelpSetInfo(java.util.Locale lc) Return a list of plugin-defined help sets.
InfoObject	getInfoObject(java.lang.String pluginName, int type, int ID, java.util.Locale lc) Return a localized plugin InfoObject by its ID.
PluginInfo	getPlugin(java.lang.String pluginName, java.util.Locale lc) Return localized basic information about a plugin.
ConfigurationData	getPluginConfiguration(java.lang.String pluginName, VersionInfo version) Return a plugin's configuration data.
java.lang.Object	getPluginObject(java.lang.String pluginName, int type, int ID, int key, java.util.Locale lc) Return a localized instance of a plugin-defined class.
java.lang.Object	getPluginObject(java.lang.String pluginName, int type, java.util.Locale lc) Return a plugin-supplied object.
java.lang.Object	getPluginObject(java.lang.String pluginName, java.lang.String className, java.util.Locale lc) Return a localized instance of a plugin-defined class.
PluginInfo[]	getPlugins(java.util.Locale lc) Return a list of installed plugins.
StartInfo[]	getStartInfo(java.util.Locale lc) Return a list of plugin-defined start node types.
TemplateDefinitionPropertiesInfo[]	getTemplateDefinitionInfo(java.util.Locale lc) Return a list of plugin-defined template definition property types.
TemplatePropertiesInfo[]	getTemplateInfo(java.util.Locale lc) Return a list of plugin-defined template property types.
VariableTypeInfo[]	getVariableTypeInfo(java.util.Locale lc) Return a list of plugin-defined variable types.
boolean	isLoaded(java.lang.String pluginName, VersionInfo version) Indicates whether the specified plugin is loaded.
void	onEvent(EventData eventData) Process an event.
void	refresh() Deprecated. Call PluginManagerCfg.refresh(). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	removeInstanceListener(Plugin plugin) Deprecated. Call PluginManagerCfg.removeInstanceListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	removeTaskListener(Plugin plugin) Deprecated. Call PluginManagerCfg.removeTaskListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	removeTemplateDefinitionListener(Plugin plugin) Deprecated. Call PluginManagerCfg.removeTemplateDefinitionListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	removeTemplateListener(Plugin plugin) Deprecated. Call PluginManagerCfg.removeTemplateListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.
void	stateChanged(java.lang.Object pms) Notify a server of a plugin manager cluster-wide state change.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

stateChanged

public void stateChanged(java.lang.Object pms)
                  throws java.rmi.RemoteException

Notify a server of a plugin manager cluster-wide state change. This method is exposed by the PluginManager interface, which is deployed on all slave servers. This method must not be called by plugins.

Parameters:

pms - The plugin manager's cluster-wide state.

isLoaded

public boolean isLoaded(java.lang.String pluginName,
                        VersionInfo version)
                 throws java.rmi.RemoteException,
                        WorkflowException

Indicates whether the specified plugin is loaded.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

Returns:

true if the plugin is loaded.

getPluginConfiguration

public ConfigurationData getPluginConfiguration(java.lang.String pluginName,
                                                VersionInfo version)
                                         throws java.rmi.RemoteException,
                                                WorkflowException

Return a plugin's configuration data.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

Returns:

The configuration for the specified plugin.

See Also:

PluginManagerCfg.setPluginConfiguration(java.lang.String, com.bea.wlpi.common.VersionInfo, int, java.lang.String)

getFrameworkVersion

public VersionInfo getFrameworkVersion()
                                throws java.rmi.RemoteException

Return the Plugin Framework version.

Returns:

Framework version.

getPlugins

public PluginInfo[] getPlugins(java.util.Locale lc)
                        throws java.rmi.RemoteException,
                               WorkflowException

Return a list of installed plugins.

Parameters:

lc - Locale in which to localize display strings.

Returns:

The list of installed plugins.

getPlugin

public PluginInfo getPlugin(java.lang.String pluginName,
                            java.util.Locale lc)
                     throws java.rmi.RemoteException,
                            WorkflowException

Return localized basic information about a plugin.

Parameters:

pluginName - The reverse-DNS plugin name.

lc - Locale in which to localize display strings.

getActionInfo

public CategoryInfo[] getActionInfo(java.util.Locale lc)
                             throws java.rmi.RemoteException,
                                    WorkflowException

Return a consolidated list of all actions and action categories. The list of actions and categories includes those predefined by WebLogic Process Integrator, together with those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A complete list of actions and categories.

getDoneInfo

public DoneInfo[] getDoneInfo(java.util.Locale lc)
                       throws java.rmi.RemoteException,
                              WorkflowException

Return a list of plugin-defined done node types. The list of done node types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of done node types.

getEventInfo

public EventInfo[] getEventInfo(java.util.Locale lc)
                         throws java.rmi.RemoteException,
                                WorkflowException

Return a list of plugin-defined event node types. The list of event node types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of event node types.

getEventHandlerInfo

public EventHandlerInfo[] getEventHandlerInfo(java.util.Locale lc)
                                       throws java.rmi.RemoteException,
                                              WorkflowException

Return a list of plugin-defined event handlers. The list of event handlers includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of event handlers.

getFieldInfo

public FieldInfo[] getFieldInfo(java.util.Locale lc)
                         throws java.rmi.RemoteException,
                                WorkflowException

Return a list of plugin-defined field types. The list of field types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of field types.

getFunctionInfo

public FunctionInfo[] getFunctionInfo(java.util.Locale lc)
                               throws java.rmi.RemoteException,
                                      WorkflowException

Return a consolidated list of all evaluator functions. The list of functions includes those predefined by WebLogic Process Integrator, together with those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of functions.

getHelpSetInfo

public HelpSetInfo[] getHelpSetInfo(java.util.Locale lc)
                             throws java.rmi.RemoteException,
                                    WorkflowException

Return a list of plugin-defined help sets. The list includes help set information provided by all loadable plugins, regardless of whether or not they are loaded.

Parameters:

lc - The locale in which to localize the help sets.

Returns:

A list of help sets.

getStartInfo

public StartInfo[] getStartInfo(java.util.Locale lc)
                         throws java.rmi.RemoteException,
                                WorkflowException

Return a list of plugin-defined start node types. The list of start node types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of start node types.

getTemplateInfo

public TemplatePropertiesInfo[] getTemplateInfo(java.util.Locale lc)
                                         throws java.rmi.RemoteException,
                                                WorkflowException

Return a list of plugin-defined template property types. The list of property types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of template property types.

getTemplateDefinitionInfo

public TemplateDefinitionPropertiesInfo[] getTemplateDefinitionInfo(java.util.Locale lc)
                                                             throws java.rmi.RemoteException,
                                                                    WorkflowException

Return a list of plugin-defined template definition property types. The list of property types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of template definition property types.

getVariableTypeInfo

public VariableTypeInfo[] getVariableTypeInfo(java.util.Locale lc)
                                       throws java.rmi.RemoteException,
                                              WorkflowException

Return a list of plugin-defined variable types. The list of variable types includes only those provided by loaded plugins.

Parameters:

lc - The locale in which to localize display strings.

Returns:

A list of variable types.

getInfoObject

public InfoObject getInfoObject(java.lang.String pluginName,
                                int type,
                                int ID,
                                java.util.Locale lc)
                         throws java.rmi.RemoteException,
                                WorkflowException

Return a localized plugin InfoObject by its ID.

Parameters:

pluginName - The reverse-DNS plugin name.

type - The type of info object to retrieve: PluginConstants.TYPE_ACTION_INFO, PluginConstants.TYPE_TEMPLATE_PROPERTIES_INFO, PluginConstants.TYPE_TEMPLATE_DEFINITION_PROPERTIES_INFO, PluginConstants.TYPE_START_INFO, PluginConstants.TYPE_DONE_INFO, PluginConstants.TYPE_EVENT_INFO, PluginConstants.TYPE_EVENT_HANDLER_INFO, PluginConstants.TYPE_FIELD_INFO, PluginConstants.TYPE_FUNCTION_INFO or PluginConstants.TYPE_VARIABLE_TYPE_INFO.

ID - The plugin-supplied ID for the required info object.

lc - The locale in which to localize display strings.

Returns:

The specified info object.

classForName

public java.lang.Class classForName(java.lang.String pluginName,
                                    java.lang.String className)
                             throws java.rmi.RemoteException,
                                    java.lang.ClassNotFoundException,
                                    WorkflowException

Return a plugin-defined class. Used by the server when instantiating plugin-provided classes that do not require localization.

Parameters:

pluginName - The reverse-DNS plugin name.

className - The fully qualified Java class name of the plugin-defined object to return.

Returns:

The plugin-defined class.

Throws:

java.lang.ClassNotFoundException - if the specified class could not be loaded.

See Also:

getPluginObject(String, String, Locale), getPluginObject(String, int, int, int, Locale)

getPluginObject

public java.lang.Object getPluginObject(java.lang.String pluginName,
                                        java.lang.String className,
                                        java.util.Locale lc)
                                 throws java.rmi.RemoteException,
                                        java.lang.ClassNotFoundException,
                                        WorkflowException

Return a localized instance of a plugin-defined class. Used by both server and client to instantiate plugin-provided classes.

Parameters:

pluginName - The reverse-DNS plugin name.

className - The fully qualified Java class name of the plugin-defined object to return.

lc - The locale in which to localize display strings.

Returns:

An instance of the specified class.

Throws:

java.lang.ClassNotFoundException - if the specified class could not be loaded.

See Also:

classForName(java.lang.String, java.lang.String), getPluginObject(String, int, int, int, Locale)

getPluginObject

public java.lang.Object getPluginObject(java.lang.String pluginName,
                                        int type,
                                        java.util.Locale lc)
                                 throws java.rmi.RemoteException,
                                        WorkflowException

Return a plugin-supplied object. This method is only applicable for retrieval of those plugin-supplied objects which do not have a corresponding XxxInfo object. Examples include the Help Set.

Parameters:

pluginName - The reverse-DNS plugin name.

type - The type of object to retrieve: PluginConstants.TYPE_HELP_SET_INFO.

lc - The locale in which to localize the object.

Returns:

The specified object.

Throws:

PluginException - if the specified object could not be located.

getPluginObject

public java.lang.Object getPluginObject(java.lang.String pluginName,
                                        int type,
                                        int ID,
                                        int key,
                                        java.util.Locale lc)
                                 throws java.rmi.RemoteException,
                                        java.lang.ClassNotFoundException,
                                        WorkflowException

Return a localized instance of a plugin-defined class. Used by both server and client to instantiate plugin-provided classes.

Parameters:

pluginName - The reverse-DNS plugin name.

type - The type of info object to retrieve: PluginConstants.TYPE_ACTION_INFO, PluginConstants.TYPE_CONFIGURATION_INFO, PluginConstants.TYPE_TEMPLATE_PROPERTIES_INFO, PluginConstants.TYPE_TEMPLATE_DEFINITION_PROPERTIES_INFO, PluginConstants.TYPE_START_INFO, PluginConstants.TYPE_DONE_INFO, PluginConstants.TYPE_EVENT_INFO, PluginConstants.TYPE_EVENT_HANDLER_INFO, PluginConstants.TYPE_FIELD_INFO, PluginConstants.TYPE_FUNCTION_INFO or PluginConstants.TYPE_VARIABLE_TYPE_INFO.

ID - The plugin-supplied ID for the required InfoObject.

key - A key value to indicate which plugin-supplied class to instantiate. Valid key values are declared in the corresponding InfoObject subclasses.

lc - The locale in which to localize display strings.

Returns:

An instance of the specified class.

Throws:

java.lang.ClassNotFoundException - if the specified class could not be loaded.

See Also:

classForName(java.lang.String, java.lang.String), getPluginObject(String, String, Locale)

onEvent

public void onEvent(EventData eventData)
             throws java.rmi.RemoteException,
                    WorkflowException

Process an event. Plugins which do not use JMS to deliver asynchronous messages can deliver an event to WLPI by calling this method.

Parameters:

eventData - The event datum, including optional addressing and processing information.

refresh

public void refresh()
             throws java.rmi.RemoteException,
                    WorkflowException

Deprecated. Call PluginManagerCfg.refresh(). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Flush cached plugin capabilities information. Plugins can call this method if their capabilities are dynamically configured. Calling this method causes the plugin manager to re-query all loaded plugins and to rebuild its internal plugin capabilities cache. This is a relatively expensive call to make, so its use should be kept to a minimum.

addTemplateListener

public void addTemplateListener(Plugin plugin,
                                int mask)
                         throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.addTemplateListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Register a specific plugin as a TemplateNotification listener.

Parameters:

plugin - The plugin to register.

mask - Notifications for which to register. The value is formed by performing a bitwise logical OR on any of the values: PluginConstants.TEMPLATE_CREATED, PluginConstants.TEMPLATE_UPDATED, PluginConstants.TEMPLATE_DELETED.

See Also:

PluginConstants.EVENT_NOTIFICATION_ALL

removeTemplateListener

public void removeTemplateListener(Plugin plugin)
                            throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.removeTemplateListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Unregister a specific plugin as a TemplateNotification listener.

Parameters:

plugin - The plugin to unregister.

addTemplateDefinitionListener

public void addTemplateDefinitionListener(Plugin plugin,
                                          int mask)
                                   throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.addTemplateDefinitionListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Register a specific plugin as a TemplateDefinitionNotification listener.

Parameters:

plugin - The plugin to register.

mask - Notifications for which to register. The value is formed by performing a bitwise logical OR on any of the values: PluginConstants.DEFINITION_CREATED, PluginConstants.DEFINITION_UPDATED, PluginConstants.DEFINITION_DELETED.

See Also:

PluginConstants.EVENT_NOTIFICATION_ALL

removeTemplateDefinitionListener

public void removeTemplateDefinitionListener(Plugin plugin)
                                      throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.removeTemplateDefinitionListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Unregister a specific plugin as a TemplateDefinitionNotification listener.

Parameters:

plugin - The plugin to unregister.

addInstanceListener

public void addInstanceListener(Plugin plugin,
                                int mask)
                         throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.addInstanceListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Register a specific plugin as an InstanceNotification listener.

Parameters:

plugin - The plugin to register.

mask - Notifications for which to register. The value is formed by performing a bitwise logical OR on any of the values: PluginConstants.INSTANCE_CREATED, PluginConstants.INSTANCE_COMPLETED, PluginConstants.INSTANCE_UPDATED, PluginConstants.INSTANCE_ABORTED, PluginConstants.INSTANCE_DELETED.

See Also:

PluginConstants.EVENT_NOTIFICATION_ALL

removeInstanceListener

public void removeInstanceListener(Plugin plugin)
                            throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.removeInstanceListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Unregister a specific plugin as an InstanceNotification listener.

Parameters:

plugin - The plugin to unregister.

addTaskListener

public void addTaskListener(Plugin plugin,
                            int mask)
                     throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.addTaskListener(com.bea.wlpi.server.plugin.Plugin, int). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Register a specific plugin as a TaskNotification listener.

Parameters:

plugin - The plugin to register.

mask - Notifications for which to register. The value is formed by performing a bitwise logical OR on any of the values: PluginConstants.TASK_STARTED, PluginConstants.TASK_EXECUTED. PluginConstants.TASK_COMPLETED. PluginConstants.TASK_UNMARKED_DONE. PluginConstants.TASK_OVERDUE. PluginConstants.TASK_ASSIGNED. PluginConstants.TASK_UNASSIGNED.

See Also:

PluginConstants.EVENT_NOTIFICATION_ALL

removeTaskListener

public void removeTaskListener(Plugin plugin)
                        throws java.rmi.RemoteException

Deprecated. Call PluginManagerCfg.removeTaskListener(com.bea.wlpi.server.plugin.Plugin). The cluster-wide plugin manager state is pinned to a single server in the cluster.

Unregister a specific plugin as a TaskNotification listener.

Parameters:

plugin - The plugin to register.