org.gcube.vremanagement.executor.plugin

Class Plugin<T extends PluginDeclaration>

java.lang.Object

org.gcube.vremanagement.executor.plugin.Plugin<T>

public abstract class Plugin<T extends PluginDeclaration>
extends Object

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

Author:

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

Constructor Summary

Constructors

Constructor and Description
Plugin(T pluginDeclaration)

Method Summary

Modifier and Type	Method and Description
T	getPluginDeclaration()
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
protected void	setPercentageEvolution(Integer integer)
void	setPercentageSetter(PercentageSetter percentageSetter)
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

Constructor Detail

Plugin

public Plugin(T pluginDeclaration)

Method Detail

getPluginDeclaration

public T getPluginDeclaration()

Returns:

the pluginDeclaration

setPercentageSetter

public void setPercentageSetter(PercentageSetter percentageSetter)

Parameters:

percentageSetter - the percentageSetter to set

setPercentageEvolution

protected void setPercentageEvolution(Integer integer)

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