org.mdi.plugins

Class AbstractPlugin

java.lang.Object

org.mdi.plugins.AbstractPlugin

All Implemented Interfaces:

CommandLineListener, Plugin

Direct Known Subclasses:

AbstractMDIPlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements Plugin

This class provides a skeletal implementation of the Plugin interface, which does nothing, to minimize the effort required to implement this interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected MDIApplication	appli The MDIApplication.
protected CommandLineHandler	commandLineHandler The command-line handler.

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
CommandLineHandler	getCommandLineHandler() Return the command-line handler.
java.lang.ClassLoader	getContextClassLoader() Return the context classLoader used to create the plugin.
ApplicationDesc	getPluginDesc() Return the Plugin description.
void	init(MDIApplication app) Initialize the Plugin.
void	register(MDIApplication appli) Register the Application.
void	setCommandLineHandler(CommandLineHandler handler) Set the command-line handler.
protected void	setupPluginDesc(Configuration conf) Setup the content of the plugin description, using the Plugin configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mdi.plugins.Plugin

dispose, executeCustomAction, getDefaultPluginProperty, getPluginBuildDate, getPluginConfiguration, getPluginDescription, getPluginName, getPluginProperty, getPluginVersion, getProperty, getPropertyType, hasProperty, loadResources, modifySettings, resetSettings, setProperty, supportCustomAction

Methods inherited from interface org.mdi.bootstrap.launcher.CommandLineListener

getCommandLineConfiguration, handleCommandLineArguments, handleCommandLineArguments, handleCommandLineException

Field Detail

commandLineHandler

protected CommandLineHandler commandLineHandler

The command-line handler.

appli

protected MDIApplication appli

The MDIApplication.

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

getContextClassLoader

public java.lang.ClassLoader getContextClassLoader()

Return the context classLoader used to create the plugin.

Returns:

the context classLoader used to create the plugin

getPluginDesc

public ApplicationDesc getPluginDesc()

Return the Plugin description.

Specified by:

getPluginDesc in interface Plugin

Returns:

the Plugin description

setupPluginDesc

protected void setupPluginDesc(Configuration conf)

Setup the content of the plugin description, using the Plugin configuration.

Parameters:

conf - the Plugin configuration

register

public void register(MDIApplication appli)
              throws java.lang.Exception

Register the Application. The default behavior only set the appli to the application is register.

Specified by:

register in interface Plugin

Parameters:

appli - the application

Throws:

java.lang.Exception - if registering the Plugin throws an internal exception in the Plugin

setCommandLineHandler

public void setCommandLineHandler(CommandLineHandler handler)

Set the command-line handler.

Specified by:

setCommandLineHandler in interface CommandLineListener

Parameters:

handler - the handler

getCommandLineHandler

public CommandLineHandler getCommandLineHandler()

Return the command-line handler.

Specified by:

getCommandLineHandler in interface CommandLineListener

Returns:

the handler

init

public void init(MDIApplication app)
          throws java.lang.Exception

Initialize the Plugin. Do nothing by default.

Specified by:

init in interface Plugin

Parameters:

app - the application

Throws:

java.lang.Exception - if initializing the Plugin throws an internal exception in the Plugin.