ExecutorPluginContext
Date: 2013-05-21

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gcube.vremanagement.executor.plugin
Class ExecutorPluginContext

    java.lang.Object
      GCUBEPluginContext
          org.gcube.vremanagement.executor.plugin.ExecutorPluginContext

    public abstract class ExecutorPluginContext

extends GCUBEPluginContext

Extends `GCUBEPluginContext` to provide the service with information about its plugin.

Subclasses must indicate the class of an executable `ExecutorTask` (cf. `getTaskClass()`).
They may also provide examples of the any inputs the task may take and any output the task may produce (cf. `addSampleInput(DescriptiveProperty)`, `addSampleOutput(DescriptiveProperty...)`).
Finally, they may also indicate the time after which task executions that are completed or have failed can be forgotten (cf. `getTimeToLive()`).

Author:
  Fabio Simeoni (University of Strathclyde)

Field Summary
`static int` | `TIME_TO_LIVE` Default task expiration delay.

Constructor Summary
`ExecutorPluginContext()`

Method Summary
`TaskDescription` | `getDescription()` Returns the description of the task.
`java.util.List<DescriptiveProperty>` | `getSampleInputs()` Returns sample inputs for the task.
`java.util.List<DescriptiveProperty>` | `getSampleOutputs()` Return sample outputs for the task.* @return the sample outputs.
`abstract java.lang.Class<? extends ExecutorTask>` | `getTaskClass()` Return the type of the task.* @return the type.
`int` | `getTimeToLive()` Returns the time-to-live for completed or failed task, in minutes.@return the time-to-live.
`void` | `setTaskDescription(TaskDescription description)` Sets the description of the task.* @param the description.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### TIME_TO_LIVE

    public static final int TIME_TO_LIVE

  Default task expiration delay.

  See Also:
    Constant Field Values

Constructor Detail

### ExecutorPluginContext

    public ExecutorPluginContext()

Method Detail

### getDescription

    public TaskDescription getDescription()

  Returns the description of the task. * @return the description.

### setTaskDescription

    public void setTaskDescription(TaskDescription description)

  Sets the description of the task.* @param the description.

### getTaskClass

    public abstract java.lang.Class<? extends ExecutorTask> getTaskClass()

  Return the type of the task.* @return the type.

### getSampleInputs

    public java.util.List<DescriptiveProperty> getSampleInputs()

  Returns sample inputs for the task. @return the sample inputs.

### getSampleOutputs

    public java.util.List<DescriptiveProperty> getSampleOutputs()

  Return sample outputs for the task.* @return the sample outputs.

### getTimeToLive

    public int getTimeToLive()

  Returns the time-to-live for completed or failed task, in minutes.@return the time-to-live.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD