org.gcube.vremanagement.executor.api

Interface SmartExecutor

public interface SmartExecutor

Service Endpoint Interface

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TARGET_NAMESPACE
static String	WEB_SERVICE_SERVICE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
PluginState	getIterationState(String executionIdentifier, int iterationNumber) The method use the provided UUID as String and the iteration number to retrieve the status of the associated execution
PluginState	getState(String executionIdentifier) The method use the provided UUID as String to retrieve the status of the associated execution
String	launch(LaunchParameter launchParameter) Launch the plugin identified by the name provided as parameters with the provided inputs.
boolean	stop(String executionIdentifier) The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any).
boolean	unSchedule(String executionIdentifier) The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any) and release the the scheduling if the Task is a Scheduled Task.
boolean	unSchedule(String executionIdentifier, boolean globally) The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any) and release the the scheduling if the Task is a Scheduled Task.

Field Detail

TARGET_NAMESPACE

static final String TARGET_NAMESPACE

See Also:

Constant Field Values

WEB_SERVICE_SERVICE_NAME

static final String WEB_SERVICE_SERVICE_NAME

See Also:

Constant Field Values

Method Detail

launch

String launch(LaunchParameter launchParameter)
              throws InputsNullException,
                     PluginNotFoundException,
                     LaunchException,
                     ExecutorException

Launch the plugin identified by the name provided as parameters with the provided inputs. Inputs cannot be null. If you need to launch an execution with no inputs provide an empty Map. This method return as soon as the plugin has been launched. The execution is made in a separated Thread.

Parameters:

launchParameter - which contains the name of the plugin to launch and the input to be provided to plugin to run and the scheduling strategy.

Returns:

the UUID execution identifier as String which identify the execution of the plugin.

Throws:

InputsNullException - if LaunchParameter contains null inputs.

PluginNotFoundException - if LaunchParameter contains a name of a plugin which is not available on classpath

LaunchException - if an error occurs trying to instantiate and/or launch the plugin execution

ExecutorException - if any other undefined error occur

stop

boolean stop(String executionIdentifier)
             throws ExecutorException

The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any). If the Task is a scheduled Task the current execution is stopped but the next one will occur. To remove the

Parameters:

executionIdentifier - UUID as String which identify the execution

Returns:

return true if the current execution has been correctly stopped. False otherwise.

Throws:

Exception - if there is no Task identified by the provided UUID execution identifier as String

ExecutorException

unSchedule

boolean unSchedule(String executionIdentifier)
                   throws ExecutorException

The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any) and release the the scheduling if the Task is a Scheduled Task. After this method has been successfully executed, if the identified Scheduled Task was global, another SmartExecutor instance will be able to take in charge the Scheduling. If the identified Scheduled Task was local no other SmartExecutor instances will be able to take in charge the scheduling. If the Task is not a Scheduled Task, the only effect is stopping the current execution. In other word has the same side effect of invoking SmartExecutor#stop() method. Invoking this method has the same side effect of invoking unSchedule(String, boolean) passing false to the second argument

Parameters:

executionIdentifier - UUID as String which identify the execution

Returns:

return true if the current execution has been correctly stopped and the Task was unscheduled. False otherwise.

Throws:

Exception - if there is no Task identified by the provided UUID execution identifier as String

ExecutorException

unSchedule

boolean unSchedule(String executionIdentifier,
                 boolean globally)
                   throws ExecutorException

The method use the provided UUID execution identifier as String to stop the last running execution of a Task (if any) and release the the scheduling if the Task is a Scheduled Task. If the identified Task is not a Scheduled Task, the only effect is stopping the current execution. In other word has the same side effect of invoking SmartExecutor#stop() method.

Parameters:

executionIdentifier - UUID as String which identify the execution

globally - a boolean which when true indicate if releasing the Scheduled Task globally, so that no other SmartExecutor instance will take in charge the scheduling. When false this invocation has the same side effect of invoking unSchedule(String).

Returns:

return true if the current execution has been correctly stopped and the Task was unscheduled. False otherwise.

Throws:

Exception - if there is no Task identified by the provided UUID execution identifier as String

ExecutorException

getState

PluginState getState(String executionIdentifier)
                     throws PluginInstanceNotFoundException,
                            ExecutorException

The method use the provided UUID as String to retrieve the status of the associated execution

Parameters:

executionIdentifier - UUID as String which identify the execution

Returns:

PluginState which contains the state of the execution

Throws:

Exception - if there is no execution identified by the provided UUID execution identifier as String

PluginInstanceNotFoundException

ExecutorException

getIterationState

PluginState getIterationState(String executionIdentifier,
                            int iterationNumber)
                              throws PluginInstanceNotFoundException,
                                     ExecutorException

The method use the provided UUID as String and the iteration number to retrieve the status of the associated execution

Parameters:

executionIdentifier - UUID as String which identify the execution

iterationNumber - iteration number

Returns:

PluginState which contains the state of the execution

Throws:

Exception - if there is no execution identified by the provided UUID execution identifier as String

PluginInstanceNotFoundException

ExecutorException