Package org.gcube.vremanagement.executor.pluginmanager

Class RunnablePlugin<T extends org.gcube.vremanagement.executor.plugin.Plugin>

java.lang.Object

org.gcube.vremanagement.executor.pluginmanager.RunnablePlugin<T>

All Implemented Interfaces:

Runnable

public class RunnablePlugin<T extends org.gcube.vremanagement.executor.plugin.Plugin>
extends Object
implements Runnable

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.gcube.vremanagement.executor.plugin.PluginStateEvolution	actualStateEvolution
protected final Map<String,Object>	inputs
protected final int	iterationNumber
protected final String	ownerId
protected final T	plugin
protected final List<org.gcube.vremanagement.executor.plugin.PluginStateNotification>	pluginStateNotifications
protected final UUID	uuid

Constructor Summary

Constructors

Constructor	Description
RunnablePlugin(T plugin, Map<String,Object> inputs, UUID uuid, int iterationNumber, String ownerId, List<org.gcube.vremanagement.executor.plugin.PluginStateNotification> pluginStateNotifications)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getInputs()
T	getPlugin()
void	run()
protected void	setPercentage(Integer percentage)
void	setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState)
void	setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState, Exception e)
protected void	setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState, Integer percentage, Exception exception)	It is up to the plugin to update the State of the Running Plugin using this facilities function.
void	stop()	Stop the Plugin setting state to PluginState.STOPPED
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

plugin

protected final T extends org.gcube.vremanagement.executor.plugin.Plugin plugin

inputs

protected final Map<String,Object> inputs

uuid

protected final UUID uuid

iterationNumber

protected final int iterationNumber

pluginStateNotifications

protected final List<org.gcube.vremanagement.executor.plugin.PluginStateNotification> pluginStateNotifications

ownerId

protected final String ownerId

actualStateEvolution

protected org.gcube.vremanagement.executor.plugin.PluginStateEvolution actualStateEvolution

Constructor Details

RunnablePlugin

public RunnablePlugin(T plugin,
 Map<String,Object> inputs,
 UUID uuid,
 int iterationNumber,
 String ownerId,
 List<org.gcube.vremanagement.executor.plugin.PluginStateNotification> pluginStateNotifications)

Method Details

run

public void run()

Specified by:

run in interface Runnable

getPlugin

public T getPlugin()

Returns:

the plugin

getInputs

public Map<String,Object> getInputs()

Returns:

the launchInputs

setPercentage

protected void setPercentage(Integer percentage)
                      throws AlreadyInFinalStateException,
InvalidPluginStateEvolutionException

Throws:

AlreadyInFinalStateException

InvalidPluginStateEvolutionException

setState

public void setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState)
              throws AlreadyInFinalStateException,
InvalidPluginStateEvolutionException

Throws:

AlreadyInFinalStateException

InvalidPluginStateEvolutionException

setState

public void setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState,
 Exception e)
              throws AlreadyInFinalStateException,
InvalidPluginStateEvolutionException

Throws:

AlreadyInFinalStateException

InvalidPluginStateEvolutionException

setState

protected void setState(org.gcube.vremanagement.executor.plugin.PluginState pluginState,
 Integer percentage,
 Exception exception)
                 throws AlreadyInFinalStateException,
InvalidPluginStateEvolutionException

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

Parameters:

pluginState - the new plugin state to set

percentage - the completion percentage (can be null)

exception - the exception that caused the state change (can be null)

Throws:

AlreadyInFinalStateException - if the plugin is already in a final state

InvalidPluginStateEvolutionException - if the state transition is invalid

toString

public String toString()

Overrides:

toString in class Object

stop

public void stop()
          throws Exception

Stop the Plugin setting state to PluginState.STOPPED

Throws:

Exception