org.gcube.vremanagement.executor.plugin

Class Plugin

java.lang.Object

org.gcube.vremanagement.executor.plugin.Plugin

All Implemented Interfaces:

PluginDefinition

public abstract class Plugin
extends Object
implements PluginDefinition

This class represent the contract for a plugin runnable by the executor.

Author:

Luca Frosini (ISTI - CNR) This class is deprecated use ExecutorPlugin instead

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_PROPERTY
static String	GROUP_PROPERTY
protected int	iterationNumber
static String	NAME_PROPERTY
protected PercentageSetter	percentageSetter
static String	PLUGIN_PROPERTIES_SUFFIX_FILENAME
protected Properties	properties
protected UUID	uuid
static String	VERSION_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
String	getDescription() This method is used by executor to retrieve the Plugin human oriented description.
String	getGroup() This method is used by executor to retrieve the Plugin group It will be published on the IS instance created by the executor
int	getIterationNumber()
String	getName() This method is used by executor to retrieve the Plugin name It will be published on the IS instance created by the executor
Map<String,String>	getSupportedCapabilities() This method is used by the Executor to get a key-value Map to be published on IS , so a client which want to launch a Plugin only under certain condition can query the IS to obtain its own filtered list.
UUID	getUUID()
String	getVersion() This method is used by executor to retrieve the plugin version.
abstract void	launch(Map<String,Object> inputs) Launch the plugin with the provided input.
protected abstract void	onStop() This function is used to correctly stop the plugin
void	setIterationNumber(int iterationNumber)
protected void	setPercentageEvolution(Integer integer)
void	setPercentageSetter(PercentageSetter percentageSetter)
void	setUUID(UUID uuid)
void	stop() Invoke onStop() function to allow the plugin to safely stop the execution

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_PROPERTIES_SUFFIX_FILENAME

public static final String PLUGIN_PROPERTIES_SUFFIX_FILENAME

See Also:

Constant Field Values

GROUP_PROPERTY

public static final String GROUP_PROPERTY

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

See Also:

Constant Field Values

VERSION_PROPERTY

public static final String VERSION_PROPERTY

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

public static final String DESCRIPTION_PROPERTY

See Also:

Constant Field Values

properties

protected Properties properties

uuid

protected UUID uuid

iterationNumber

protected int iterationNumber

percentageSetter

protected PercentageSetter percentageSetter

Constructor Detail

Plugin

public Plugin()

Method Detail

getGroup

public String getGroup()

Description copied from interface: PluginDefinition

This method is used by executor to retrieve the Plugin group It will be published on the IS instance created by the executor

Specified by:

getGroup in interface PluginDefinition

Returns:

the plugin group.

getName

public String getName()

Description copied from interface: PluginDefinition

This method is used by executor to retrieve the Plugin name It will be published on the IS instance created by the executor

Specified by:

getName in interface PluginDefinition

Returns:

the plugin name.

getVersion

public String getVersion()

Description copied from interface: PluginDefinition

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

Specified by:

getVersion in interface PluginDefinition

Returns:

the plugin version.

getDescription

public String getDescription()

Description copied from interface: PluginDefinition

This method is used by executor to retrieve the Plugin human oriented description. It will be published on the IS instance created by the executor

Specified by:

getDescription in interface PluginDefinition

Returns:

the plugin description.

getSupportedCapabilities

public Map<String,String> getSupportedCapabilities()

Description copied from interface: PluginDefinition

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

Specified by:

getSupportedCapabilities in interface PluginDefinition

Returns:

the Map with the supported capabilities

setPercentageSetter

public void setPercentageSetter(PercentageSetter percentageSetter)

Parameters:

percentageSetter - the percentageSetter to set

setPercentageEvolution

protected void setPercentageEvolution(Integer integer)

getUUID

public UUID getUUID()

Returns:

the uuid

setUUID

public void setUUID(UUID uuid)

Parameters:

uuid - the uuid to set

getIterationNumber

public int getIterationNumber()

Returns:

the Iteration Number

setIterationNumber

public void setIterationNumber(int iterationNumber)

Parameters:

iterationNumber - the iterationNumner to set

launch

public abstract void launch(Map<String,Object> inputs)
                     throws Exception

Launch the plugin with the provided input.

Parameters:

inputs -

Throws:

Exception - if the launch fails

onStop

protected abstract void onStop()
                        throws Exception

This function is used to correctly stop the plugin

Throws:

Exception - if the launch fails

stop

public void stop()
          throws Exception

Invoke onStop() function to allow the plugin to safely stop the execution

Throws:

Exception