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
static final String	CLIENT_ID	The key, in the configuration of a plugin, of the identifier of its client.
static final String	CLIENT_SECRET	The key, in the configuration of a plugin, of the secret of its client.
protected final String	context	The Context the task runs in.
protected final Map<String,Object>	inputs
protected final int	iterationNumber
protected final org.gcube.common.security.secrets.Secret	nodeSecret	The secret of the node in the Context of the task: the service does its own work with it.
protected final String	ownerId
protected final T	plugin
protected org.gcube.common.security.secrets.Secret	pluginSecret	The secret the plugin runs with, see obtainPluginSecret(Map); set when the execution starts.
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, String context, List<org.gcube.vremanagement.executor.plugin.PluginStateNotification> pluginStateNotifications)

Method Summary

Modifier and Type	Method	Description
protected void	asPlugin(Callable<Void> task)	Runs code of the plugin with the secret of the plugin.
Map<String,Object>	getInputs()
T	getPlugin()
protected org.gcube.common.security.secrets.Secret	obtainPluginSecret(Map<String,Object> configuration)	Returns the secret the plugin runs with: a token of its client, given by "client_id" and "client_secret" in its configuration, in the Context of the task.
protected Map<String,Object>	readConfiguration()	Returns the configuration of the plugin: the content of <plugin>.yaml in the directory of the plugin (WEB-INF/lib/plugins/<plugin>/), written by the provisioning and read by SmartGears when the service starts.
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

CLIENT_ID

public static final String CLIENT_ID

The key, in the configuration of a plugin, of the identifier of its client.

See Also:

• Constant Field Values

CLIENT_SECRET

public static final String CLIENT_SECRET

The key, in the configuration of a plugin, of the secret of its client.

See Also:

• Constant Field Values

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

context

protected final String context

The Context the task runs in.

nodeSecret

protected final org.gcube.common.security.secrets.Secret nodeSecret

The secret of the node in the Context of the task: the service does its own work with it.

pluginSecret

protected volatile org.gcube.common.security.secrets.Secret pluginSecret

The secret the plugin runs with, see obtainPluginSecret(Map); set when the execution starts.

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,
 String context,
 List<org.gcube.vremanagement.executor.plugin.PluginStateNotification> pluginStateNotifications)

Method Details

run

public void run()

Specified by:

run in interface Runnable

asPlugin

protected void asPlugin(Callable<Void> task)
                 throws Exception

Runs code of the plugin with the secret of the plugin.

Parameters:

task - the code of the plugin

Throws:

Exception - if the code fails

readConfiguration

protected Map<String,Object> readConfiguration()
                                        throws Exception

Returns the configuration of the plugin: the content of <plugin>.yaml in the directory of the plugin (WEB-INF/lib/plugins/<plugin>/), written by the provisioning and read by SmartGears when the service starts. Every plugin has one, with at least its client; a missing, unreadable or wrong file is an error, never an empty configuration.

Returns:

the configuration

Throws:

Exception - if SmartGears does not know the plugin or has no configuration for it

obtainPluginSecret

protected org.gcube.common.security.secrets.Secret obtainPluginSecret(Map<String,Object> configuration)
                                                               throws Exception

Returns the secret the plugin runs with: a token of its client, given by "client_id" and "client_secret" in its configuration, in the Context of the task.

Parameters:

configuration - the configuration of the plugin

Returns:

the secret

Throws:

Exception - if the configuration has no client or its token cannot be obtained

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