eu.scape_project.watch.interfaces
Interface PluginInterface

All Known Subinterfaces:

AdaptorPluginInterface, NotificationAdaptorInterface

All Known Implementing Classes:

LogNotificationAdaptor

public interface PluginInterface

A PluginInterface interface for dynamic class loading of plugin components within the watch component.

Author:

Petar Petrov

Method Summary

String	getDescription() Retrieves a short human readable description of this plugin.
String	getName() Retrieves the name of this plugin.
PluginType	getPluginType() Retrieves the type of the plugin.
String	getVersion() Retrieves the version of this plugin.
void	init() Initializes the plugin.
void	shutdown() This method is called exactly once before the system shuts down or when the component decides this plugin is not needed anymore.

Method Detail

init

void init()
          throws PluginException

Initializes the plugin. This method gets called exactly once by the PluginManager before the plugin gets executed. and initializing itself accordingly.

Throws:

PluginException - if something goes wrong during the initialization process.

shutdown

void shutdown()
              throws PluginException

This method is called exactly once before the system shuts down or when the component decides this plugin is not needed anymore. The plugin is responsible for cleaning up and freeing all neeeded resources.

Throws:

PluginException - if something goes wrong.

getName

String getName()

Retrieves the name of this plugin.

Returns:

the name.

getVersion

String getVersion()

Retrieves the version of this plugin.

Returns:

the version.

getDescription

String getDescription()

Retrieves a short human readable description of this plugin.

Returns:

the description.

getPluginType

PluginType getPluginType()

Retrieves the type of the plugin.

Returns:

the plugin type.