com.novell.emframe.dev

Class Plugin

java.lang.Object

com.novell.emframe.dev.Plugin

Direct Known Subclasses:

CreatorSilent, DataHandler, Deletor, Move, PropertyBookPage, RegistryHandler, Rename

public abstract class Plugin
extends java.lang.Object

Abstract class to implement to be an iManager plug-in that is not Task based. Used mainly as a base class. Look for a specific class that implements Plugin to extend instead of implementing Plugin directly.
(ex. CreatorSilent, DataHandler, Deletor, Move, PropertyBookPage, RegistryHandler, Rename)

See Also:

CreatorSilent, DataHandler, Deletor, Move, PropertyBookPage, RegistryHandler, Rename

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
void	init(PluginContext context, org.jdom.Document doc) Deprecated. as of 2.6 use init(TaskContext, Document)
void	init(TaskContext context, org.jdom.Document doc) Initialize the plug-in to be ready for work.
static void	isPluginAvailable(PluginContext context, org.jdom.Document doc) Deprecated. as of 2.6 Use isPluginAvailable(TaskContext, Document)
static void	isPluginAvailable(TaskContext context, org.jdom.Document doc) Checks to see if the plug-in is available to do work.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Plugin

public Plugin()

Method Detail

init

public void init(PluginContext context,
                 org.jdom.Document doc)

Deprecated. as of 2.6 use init(TaskContext, Document)

Initialize the plug-in to be ready for work.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

doc - XML Document used to register the task with iManager

See Also:

init(TaskContext, Document)

init

public void init(TaskContext context,
                 org.jdom.Document doc)

Initialize the plug-in to be ready for work.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

doc - XML Document used to register the task with iManager

isPluginAvailable

public static void isPluginAvailable(PluginContext context,
                                     org.jdom.Document doc)
                              throws PluginException

Deprecated. as of 2.6 Use isPluginAvailable(TaskContext, Document)

Checks to see if the plug-in is available to do work. The plug-in can overwrite this method to do checks for things like supported devices, operating systems, etc.... If the plug-in is ready to do work, simply return. Otherwise, throw a PluginExeception with the message stating why the plug-in will not work.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

doc - XML Document used to register the task with iManager

Throws:

PluginException - if the plugin is not available for work

See Also:

isPluginAvailable(TaskContext, Document)

isPluginAvailable

public static void isPluginAvailable(TaskContext context,
                                     org.jdom.Document doc)
                              throws PluginException

Checks to see if the plug-in is available to do work. The plug-in can overwrite this method to do checks for things like supported devices, operating systems, etc.... If the plug-in is ready to do work, simply return. Otherwise, throw a PluginExeception with the message stating why the plug-in will not work.

Parameters:

context - TaskContext provides access to framework and session data (ex. locale)

doc - XML Document used to register the task with iManager

Throws:

PluginException - if the plugin is not available for work