org.gcube.vremanagement.executor.plugin

Interface PluginDeclaration

public interface PluginDeclaration

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() This method is used by executor to retrieve an human oriented description and it will be published on the ServiceEndpoint created by the executor
String	getName() This method is used by executor to retrieve the name of the Plugin
Class<? extends Plugin<? extends PluginDeclaration>>	getPluginImplementation() Used to retrieve the class which run the plugin
Map<String,String>	getSupportedCapabilities() This method is used by the Executor to get a key-value Map to be published on IS (on Generic Resource), so a client which want to launch a Plugin only under certain condition can query the Generic Resource in the proper way to obtain its own filtered list.
String	getVersion() This method is used by executor to retrieve the plugin version.
void	init() This method is used by executor to ask to Plugin to initialize itself.

Method Detail

init

void init()
          throws Exception

This method is used by executor to ask to Plugin to initialize itself. In some cases the plugin does not need the initialization. In that case the plugin can just implement an empty method.

Throws:

Exception

getName

String getName()

This method is used by executor to retrieve the name of the Plugin

Returns:

the name of the plugin used by the Executor to refer to the plugin implementation class.

getDescription

String getDescription()

This method is used by executor to retrieve an human oriented description and it will be published on the ServiceEndpoint created by the executor

Returns:

the plugin description.

getVersion

String getVersion()

This method is used by executor to retrieve the plugin version. It will be published on the ServiceEndpoint created by the executor

Returns:

the plugin version

getSupportedCapabilities

Map<String,String> getSupportedCapabilities()

This method is used by the Executor to get a key-value Map to be published on IS (on Generic Resource), so a client which want to launch a Plugin only under certain condition can query the Generic Resource in the proper way to obtain its own filtered list.

Returns:

the Map with the supported capabilities

getPluginImplementation

Class<? extends Plugin<? extends PluginDeclaration>> getPluginImplementation()

Used to retrieve the class which run the plugin

Returns:

the class which run the plugin