JavaExecutable (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.common.task.executable.JavaExecutable

Direct Known Subclasses:

AbortJob, CopyFile, EmptyTask, FailTaskConditionally, IncrementJob, IterationAwareJob, KillJob, MonteCarlo, MonteCarloAverage, MultiNodeExample, PropertyTask, WaitAndPrint
```
@PublicAPI
public abstract class JavaExecutable
extends Object
```
AbstractJavaExecutable : base class of Java Executables

Since:

ProActive Scheduling 0.9

Field Summary

Fields
Modifier and Type Field and Description

protected JavaStandaloneExecutableInitializer execInitializer

Fields
Modifier and Type	Field and Description
`protected JavaStandaloneExecutableInitializer`	`execInitializer`

Constructor Summary

Constructors
Constructor and Description

JavaExecutable()

Constructors
Constructor and Description
`JavaExecutable()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Serializable`	`execute(TaskResult... results)` The content of this method will be executed once after being scheduled. This may generate a result as an `Object`.
`Set<String>`	`getAllNodesURL()` Use this method for a multi-node task.
`protected PrintStream`	`getErr()` When using non forked Java tasks, you should use this PrintStream instead of System.err.
`String`	`getGlobalSpace()`
`String`	`getInputSpace()`
`int`	`getIterationIndex()` When iteration occurs due to a `FlowActionType.LOOP` FlowAction, each new iterated instance of a task is assigned an iteration index so that it can be uniquely identified.
`String`	`getLocalSpace()`
`Map<String,String>`	`getMetadata()` Return the result metadata map
`List<String>`	`getNodesURL()` Use this method for a multi-node task.
`protected PrintStream`	`getOut()` When using non forked Java tasks, you should use this PrintStream instead of System.out.
`String`	`getOutputSpace()`
`int`	`getProgress()` Return the current progress value for this executable, ranged between 0 and 100.
`int`	`getReplicationIndex()` When replication occurs due to a `FlowActionType.REPLICATE` FlowAction, each new replicated instance of a task is assigned a replication index so that it can be uniquely identified.
`Map<String,Serializable>`	`getResultMap()`
`SignalApi`	`getSignalAPI()`
`Synchronization`	`getSynchronizationAPI()`
`protected String`	`getThirdPartyCredential(String key)` Third-party credentials are specific to each Scheduler user and stored on the server side.
`String`	`getUserSpace()`
`Map<String,Serializable>`	`getVariables()`
`void`	`init(Map<String,Serializable> args)` Initialization default method for a java task.
`void`	`initAPIs(ScriptContext sc)`
`void`	`initDataSpaces(ScriptContext sc)` Initialization of the dataSpaces.
`void`	`initMetadata(ScriptContext sc)` Initialization of the metadata.
`void`	`initResultMap(ScriptContext sc)` Initialization of the resultMap.
`void`	`internalInit(JavaStandaloneExecutableInitializer execInitializer, ScriptContext sc)` Initialize the executable using the given executable Initializer.
`protected int`	`setProgress(int newValue)` Set the progress value for this Executable.
`void`	`setVariables(Map<String,Serializable> propagatedVariables)`

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

- Field Detail
  - execInitializer
```
protected JavaStandaloneExecutableInitializer execInitializer
```
- Constructor Detail
  - JavaExecutable
```
public JavaExecutable()
```
- Method Detail
  - internalInit
```
public void internalInit(JavaStandaloneExecutableInitializer execInitializer,
                         ScriptContext sc)
                  throws Exception
```
    Initialize the executable using the given executable Initializer.
    
    Parameters:
    
    execInitializer - the executable Initializer used to init the executable itself
    
    Throws:
    
    Exception - an exception if something goes wrong during executable initialization.
  - init
```
public void init(Map<String,Serializable> args)
          throws Exception
```
    Initialization default method for a java task.
    
    By default, this method does automatic assignment between the value given in the arguments map and the fields contained in your executable.
    If the field type and the argument type are different and if the argument type is String (i.e. for all jobs defined with XML descriptors), then a automatic mapping is tried. Managed types are byte, short, int, long, boolean and the corresponding classes, other type must be handle by user by overriding this method.
    
    For example, if you set as argument the key="var", value="12" in the XML descriptor
    just add an int (or Integer, long, Long) field named "var" in your executable. The default init(java.util.Map) method will store your arguments into the integer class field.
    To avoid this default behavior, just override this method to make your own initialization.
    
    Parameters:
    
    args - a map containing the different parameter names and values given by the user task.
    
    Throws:
    
    Exception
  - initDataSpaces
```
public void initDataSpaces(ScriptContext sc)
```
    Initialization of the dataSpaces.
    
    Parameters:
    
    sc - the ScriptContext including as bindings the dataSpaces locations.
  - initAPIs
```
public void initAPIs(ScriptContext sc)
```
  - initMetadata
```
public void initMetadata(ScriptContext sc)
```
    Initialization of the metadata.
    
    Parameters:
    
    sc - the ScriptContext including as bindings the metadata map.
  - initResultMap
```
public void initResultMap(ScriptContext sc)
```
    Initialization of the resultMap.
    
    Parameters:
    
    sc - the ScriptContext including as bindings the resultMap map.
  - getNodesURL
```
public List<String> getNodesURL()
```
    Use this method for a multi-node task. It returns the list of nodes url demanded by the user while describing the task.
    In a task, one node is used to start the task itself, the other are returned by this method.
    If user describe the task using the "numberOfNodes" property set to 5, then this method returns a list containing 4 nodes. The first one being used by the task itself.
    
    Returns:
    
    the list of nodes demanded by the user.
  - getAllNodesURL
```
public Set<String> getAllNodesURL()
```
    Use this method for a multi-node task. It returns the set of all nodes url demanded by the user while describing the task.
    This set contains the node is used to start the task itself, and all other nodes reserved by the resource manager in the multi-node definition.
    
    Returns:
    
    the set of nodes urls demanded by the user.
  - getIterationIndex
```
public final int getIterationIndex()
```
    When iteration occurs due to a FlowActionType.LOOP FlowAction, each new iterated instance of a task is assigned an iteration index so that it can be uniquely identified.
    This is a convenience method to retrieve the Iteration Index that was exported as a Java Property by the TaskLauncher.
    
    Returns:
    
    the Iteration Index of this Task
  - getReplicationIndex
```
public final int getReplicationIndex()
```
    When replication occurs due to a FlowActionType.REPLICATE FlowAction, each new replicated instance of a task is assigned a replication index so that it can be uniquely identified.
    This is a convenience method to retrieve the Replication Index that was exported as a Java Property by the TaskLauncher.
    
    Returns:
    
    the Replication Index of this Task
  - getThirdPartyCredential
```
protected String getThirdPartyCredential(String key)
```
    Third-party credentials are specific to each Scheduler user and stored on the server side. They consist of key-value pairs and are exposed in Java tasks via this method.
    
    Parameters:
    
    key - the credential's key whose associated value is to be returned
    
    Returns:
    
    the credential's value associated with the key parameter
  - getOut
```
protected PrintStream getOut()
```
    When using non forked Java tasks, you should use this PrintStream instead of System.out.
    
    Returns:
    
    a stream that will write to the task's output stream
  - getErr
```
protected PrintStream getErr()
```
    When using non forked Java tasks, you should use this PrintStream instead of System.err.
    
    Returns:
    
    a stream that will write to the task's error stream
  - execute
```
public abstract Serializable execute(TaskResult... results)
                              throws Throwable
```
    The content of this method will be executed once after being scheduled.
    This may generate a result as an Object. It can be whatever you want.
    The results list order correspond to the order in the dependence list.
    
    Parameters:
    
    results - the results (as a taskResult) from parent tasks.
    
    Returns:
    
    any serializable object from the user.
    
    Throws:
    
    Throwable - any exception thrown by the user's code
  - setProgress
```
protected final int setProgress(int newValue)
                         throws IllegalArgumentException
```
    Set the progress value for this Executable. Progress value must be ranged between 0 and 100.
    
    Parameters:
    
    newValue - the new progress value
    
    Returns:
    
    the previous progress value
    
    Throws:
    
    IllegalArgumentException - if the value is not ranged between 0 and 100.
  - getProgress
```
public int getProgress()
```
    Return the current progress value for this executable, ranged between 0 and 100.
    
    Returns:
    
    the current progress value for this executable.
  - getVariables
```
public Map<String,Serializable> getVariables()
```
  - getResultMap
```
public Map<String,Serializable> getResultMap()
```
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Return the result metadata map
    
    Returns:
    
    metadata map
  - setVariables
```
public void setVariables(Map<String,Serializable> propagatedVariables)
```
  - getInputSpace
```
public String getInputSpace()
```
  - getOutputSpace
```
public String getOutputSpace()
```
  - getGlobalSpace
```
public String getGlobalSpace()
```
  - getLocalSpace
```
public String getLocalSpace()
```
  - getUserSpace
```
public String getUserSpace()
```
  - getSynchronizationAPI
```
public Synchronization getSynchronizationAPI()
```
  - getSignalAPI
```
public SignalApi getSignalAPI()
```

Class JavaExecutable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

execInitializer

Constructor Detail

JavaExecutable

Method Detail

internalInit

init

initDataSpaces

initAPIs

initMetadata

initResultMap

getNodesURL

getAllNodesURL

getIterationIndex

getReplicationIndex

getThirdPartyCredential

getOut

getErr

execute

setProgress

getProgress

getVariables

getResultMap

getMetadata

setVariables

getInputSpace

getOutputSpace

getGlobalSpace

getLocalSpace

getUserSpace

getSynchronizationAPI

getSignalAPI