com.bea.wlpi.server.plugin
Interface PluginManagerCfg

public interface PluginManagerCfg

extends PluginManager

Configures WebLogic Process Integrator plugins. The plugin configuration manager is responsible for maintaining plugin configurations, and managing the plugin framework's cluster-wide state transitions. It also maintains lists of the plugins that have registered for various system event notifications.

Since:

WebLogic Process Integrator version 2.0

Author:

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

See Also:

PluginManager

Method Summary

void	addInstanceListener(Plugin plugin, int mask) Register a specific plugin as an InstanceNotification listener.
java.lang.Object	addStateChangeListener(PluginManagerHome listener) Register the home interface of a plugin manager deployed on a slave server.
void	addTaskListener(Plugin plugin, int mask) Register a specific plugin as a TaskNotification listener.
void	addTemplateDefinitionListener(Plugin plugin, int mask) Register a specific plugin as a TemplateDefinitionNotification listener.
void	addTemplateListener(Plugin plugin, int mask) Register a specific plugin as a TemplateNotification listener.
void	deletePluginConfiguration(java.lang.String pluginName, VersionInfo version) Delete a plugin's configuration data.
void	exit() Unload and deinitialize all plugins.
java.lang.Object	getState() Retrieve the current plugin manager state.
void	init() Load and initialize all plugins.
void	loadPlugin(java.lang.String pluginName, VersionInfo version) Load and initialize the specified plugin.
void	onPluginDeployed(Plugin plugin) Notify the plugin manager that a plugin has been hot-deployed.
void	refresh() Flush cached plugin capabilities information.
void	removeInstanceListener(Plugin plugin) Unregister a specific plugin as an InstanceNotification listener.
void	removeTaskListener(Plugin plugin) Unregister a specific plugin as a TaskNotification listener.
void	removeTemplateDefinitionListener(Plugin plugin) Unregister a specific plugin as a TemplateDefinitionNotification listener.
void	removeTemplateListener(Plugin plugin) Unregister a specific plugin as a TemplateNotification listener.
void	setPluginConfiguration(java.lang.String pluginName, VersionInfo version, int startMode, java.lang.String config) Set a plugin's configuration data.
void	unloadPlugin(java.lang.String pluginName, VersionInfo version) Unload and deinitialize specified plugin.

Methods inherited from interface com.bea.wlpi.server.plugin.PluginManager

classForName, getActionInfo, getDoneInfo, getEventHandlerInfo, getEventInfo, getFieldInfo, getFrameworkVersion, getFunctionInfo, getHelpSetInfo, getInfoObject, getPlugin, getPluginConfiguration, getPluginObject, getPluginObject, getPluginObject, getPlugins, getStartInfo, getTemplateDefinitionInfo, getTemplateInfo, getVariableTypeInfo, isLoaded, onEvent, stateChanged

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

getState

public java.lang.Object getState()
                          throws java.rmi.RemoteException

Retrieve the current plugin manager state. This method must not be called by plugins: it is called by the plugin manager when its server joins a cluster.

Returns:

The plugin manager cluster-wide state.

addStateChangeListener

public java.lang.Object addStateChangeListener(PluginManagerHome listener)
                                        throws java.rmi.RemoteException

Register the home interface of a plugin manager deployed on a slave server. The master server will notify the slave of state changes. This method must not be called by plugins.

init

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

Load and initialize all plugins. Called by the InitListener message-driven EJB during server startup. This method must not be called by plugins.

exit

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

Unload and deinitialize all plugins. This method must not be called by plugins.

refresh

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

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.

Specified by:

refresh in interface PluginManager

loadPlugin

public void loadPlugin(java.lang.String pluginName,
                       VersionInfo version)
                throws java.rmi.RemoteException,
                       WorkflowException

Load and initialize the specified plugin. The plugin manager merges the capabilities of the plugin with those of the currently loaded plugins.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

unloadPlugin

public void unloadPlugin(java.lang.String pluginName,
                         VersionInfo version)
                  throws java.rmi.RemoteException,
                         WorkflowException

Unload and deinitialize specified plugin.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

setPluginConfiguration

public void setPluginConfiguration(java.lang.String pluginName,
                                   VersionInfo version,
                                   int startMode,
                                   java.lang.String config)
                            throws java.rmi.RemoteException,
                                   WorkflowException

Set a plugin's configuration data.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

startMode - Whether and when the plugin manager starts the plugin. One of: PluginConstants.MODE_DISABLED, PluginConstants.MODE_AUTOMATIC, PluginConstants.MODE_MANUAL.

config - The plugin configuration data as an XML document.

See Also:

PluginManager.getPluginConfiguration(java.lang.String, com.bea.wlpi.common.VersionInfo)

deletePluginConfiguration

public void deletePluginConfiguration(java.lang.String pluginName,
                                      VersionInfo version)
                               throws java.rmi.RemoteException,
                                      WorkflowException

Delete a plugin's configuration data.

Parameters:

pluginName - The reverse-DNS plugin name.

version - The plugin version required.

onPluginDeployed

public void onPluginDeployed(Plugin plugin)
                      throws java.rmi.RemoteException,
                             WorkflowException

Notify the plugin manager that a plugin has been hot-deployed. The implementation initializes and loads the plugin (unless the plugin was previously configured as disabled or manually started).

Parameters:

plugin - The plugin that was deployed.

addTemplateListener

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

Register a specific plugin as a TemplateNotification listener.

Specified by:

addTemplateListener in interface PluginManager

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

Unregister a specific plugin as a TemplateNotification listener.

Specified by:

removeTemplateListener in interface PluginManager

Parameters:

plugin - The plugin to unregister.

addTemplateDefinitionListener

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

Register a specific plugin as a TemplateDefinitionNotification listener.

Specified by:

addTemplateDefinitionListener in interface PluginManager

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

Unregister a specific plugin as a TemplateDefinitionNotification listener.

Specified by:

removeTemplateDefinitionListener in interface PluginManager

Parameters:

plugin - The plugin to unregister.

addInstanceListener

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

Register a specific plugin as an InstanceNotification listener.

Specified by:

addInstanceListener in interface PluginManager

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

Unregister a specific plugin as an InstanceNotification listener.

Specified by:

removeInstanceListener in interface PluginManager

Parameters:

plugin - The plugin to unregister.

addTaskListener

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

Register a specific plugin as a TaskNotification listener.

Specified by:

addTaskListener in interface PluginManager

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

Unregister a specific plugin as a TaskNotification listener.

Specified by:

removeTaskListener in interface PluginManager

Parameters:

plugin - The plugin to register.