org.gcube.vremanagement.executor.api.types

Class LaunchParameter

java.lang.Object

org.gcube.vremanagement.executor.api.types.LaunchParameter

All Implemented Interfaces:

Comparable<LaunchParameter>

public class LaunchParameter
extends Object
implements Comparable<LaunchParameter>

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	inputs Inputs to provide to the plugin instance which have to be executed.
static String	PLUGIN_NAME
static String	PLUGIN_VERSION
protected Map<String,String>	pluginCapabilities The Plugin Capabilities which has to be satisfied to launch the plugin instance execution.
protected String	pluginName The name of the plugin to launch
protected Map<String,Map<String,String>>	pluginStateNotifications Plugin State Notification to be used and inputs to be provided when instantiated
protected String	pluginVersion The version of the plugin to launch.
protected Scheduling	scheduling Scheduling parameters.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LaunchParameter()
	LaunchParameter(LaunchParameter launchParameter)
	LaunchParameter(String pluginName, Map<String,Object> inputs)
	LaunchParameter(String pluginName, Map<String,Object> inputs, Scheduling scheduling)
	LaunchParameter(String pluginName, Map<String,String> pluginCapabilities, Map<String,Object> inputs)
	LaunchParameter(String pluginName, Map<String,String> pluginCapabilities, Map<String,Object> inputs, Scheduling scheduling)
	LaunchParameter(String pluginName, String pluginVersion, Map<String,String> pluginCapabilities, Map<String,Object> inputs, Scheduling scheduling)

Method Summary

Modifier and Type	Method and Description
void	addPluginStateNotifications(Class<? extends PluginStateNotification> pluginStateNotification, Map<String,String> inputs)
int	compareTo(LaunchParameter launchParameter)
Map<String,Object>	getInputs()
Map<String,String>	getPluginCapabilities()
String	getPluginName()
Map<String,Map<String,String>>	getPluginStateNotifications()
Scheduling	getScheduling()
void	setPluginCapabilities(Map<String,String> pluginCapabilities)
void	setPluginStateNotifications(Map<String,Map<String,String>> pluginStateNotifications)
void	setScheduling(Scheduling scheduling)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

Constant Field Values

PLUGIN_VERSION

public static final String PLUGIN_VERSION

See Also:

Constant Field Values

pluginName

protected String pluginName

The name of the plugin to launch

pluginVersion

protected String pluginVersion

The version of the plugin to launch. Version can be null, this means that no specific version is required. In other words, null means any version.

pluginCapabilities

protected Map<String,String> pluginCapabilities

The Plugin Capabilities which has to be satisfied to launch the plugin instance execution. The SmartExectuor Service check that this capabilities match the capabilities declared from the discovered plugin. If the capabilities does not match the service will not launch the execution. Plugin Capabilities can be null, this means that no capabilities have to be satisfied. In other words, null means that no constraint are required to launch the execution

inputs

protected Map<String,Object> inputs

Inputs to provide to the plugin instance which have to be executed.

pluginStateNotifications

protected Map<String,Map<String,String>> pluginStateNotifications

Plugin State Notification to be used and inputs to be provided when instantiated

scheduling

protected Scheduling scheduling

Scheduling parameters. See {#Scheduling} for further details

Constructor Detail

LaunchParameter

protected LaunchParameter()

LaunchParameter

public LaunchParameter(LaunchParameter launchParameter)

LaunchParameter

public LaunchParameter(String pluginName,
                       Map<String,Object> inputs)

LaunchParameter

public LaunchParameter(String pluginName,
                       Map<String,String> pluginCapabilities,
                       Map<String,Object> inputs)

LaunchParameter

public LaunchParameter(String pluginName,
                       Map<String,Object> inputs,
                       Scheduling scheduling)

LaunchParameter

public LaunchParameter(String pluginName,
                       Map<String,String> pluginCapabilities,
                       Map<String,Object> inputs,
                       Scheduling scheduling)

LaunchParameter

public LaunchParameter(String pluginName,
                       String pluginVersion,
                       Map<String,String> pluginCapabilities,
                       Map<String,Object> inputs,
                       Scheduling scheduling)

Method Detail

getPluginName

public String getPluginName()

Returns:

the name

getPluginCapabilities

public Map<String,String> getPluginCapabilities()

Returns:

the pluginCapabilities

setPluginCapabilities

public void setPluginCapabilities(Map<String,String> pluginCapabilities)

Parameters:

pluginCapabilities - the pluginCapabilities to set

getInputs

public Map<String,Object> getInputs()

Returns:

the inputs

getScheduling

public Scheduling getScheduling()

Returns:

the scheduling

setScheduling

public void setScheduling(Scheduling scheduling)

Parameters:

scheduling - the scheduling

addPluginStateNotifications

public void addPluginStateNotifications(Class<? extends PluginStateNotification> pluginStateNotification,
                                        Map<String,String> inputs)

getPluginStateNotifications

public Map<String,Map<String,String>> getPluginStateNotifications()

setPluginStateNotifications

public void setPluginStateNotifications(Map<String,Map<String,String>> pluginStateNotifications)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(LaunchParameter launchParameter)

Specified by:

compareTo in interface Comparable<LaunchParameter>