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, Persistence<? extends PersistenceConnector> persistence)

Method Summary

Methods

Modifier and Type	Method and Description
T	getPluginDeclaration()
PluginState	getState() Used to retrieve the state of the execution
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	setState(PluginState pluginState) It is up to the plugin update the State of the Running Plugin using this facilities function.
void	stop() Stop the Plugin setting state to PluginState.SUSPENDED

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,
      Persistence<? extends PersistenceConnector> persistence)

Method Detail

getPluginDeclaration

public T getPluginDeclaration()

Returns:

the pluginDeclaration

setState

public void setState(PluginState pluginState)

It is up to the plugin update the State of the Running Plugin using this facilities function.

Parameters:

pluginState -

Throws:

Exception

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

Stop the Plugin setting state to PluginState.SUSPENDED

Throws:

Exception

getState

public PluginState getState()
                     throws Exception

Used to retrieve the state of the execution

Returns:

the PluginState

Throws:

Exception