Task (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.common.task.CommonAttribute
- - org.ow2.proactive.scheduler.common.task.Task

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JavaTask, NativeTask, ScriptTask, TaskState
```
@PublicAPI
public abstract class Task
extends CommonAttribute
```
This class is the super class of the every task that can be integrated in a job.
A task contains some properties that can be set but also :
- A selection script that can be used to select a specific execution node for this task.
- A preScript that will be launched before the real task (can be used to set environment vars).
- A postScript that will be launched just after the end of the real task. (this can be used to transfer files that have been created by the task).
- A CleaningScript that will be launched by the resource manager to perform some cleaning. (deleting files or resources).
You will also be able to add dependences (if necessary) to this task. The dependences mechanism are best describe below.
Since:

ProActive Scheduling 0.9

See Also:

addDependence(Task), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Script<?>`	`cScript` CleaningScript : can be used to launch script just after the task or the postScript (if set) Started even if a problem occurs.
`protected String`	`description` Description of the task.
`protected String`	`flowBlock` block declaration : syntactic scopes used for workflows string representation of a FlowBlock enum
`protected FlowScript`	`flowScript` FlowScript: Control Flow Action Script executed after the task, returns a `FlowAction` which will perform flow actions on the job
`protected Boolean`	`fork` If true, task is ran in a forked JVM, this parameter is optional (nullable) .
`protected ForkEnvironment`	`forkEnvironment`
`protected List<InputSelector>`	`inputFiles` DataSpace inputFiles
`protected String`	`name` Name of the task.
`protected List<OutputSelector>`	`outputFiles` DataSpace outputFiles
`protected ParallelEnvironment`	`parallelEnvironment` The parallel environment of the task included number of nodes and topology definition required to execute this task.
`protected Script<?>`	`postScript` PostScript : can be used to launch script just after the task
`protected boolean`	`preciousLogs` If true, the stdout/err of this tasks are stored in a file in LOCALSPACE and copied back to USERSPACE
`protected boolean`	`preciousResult` Tell whether this task has a precious result or not.
`protected Script<?>`	`preScript` PreScript : can be used to launch script just before the task execution.
`protected boolean`	`runAsMe`
`protected List<SelectionScript>`	`sScripts` selection script : can be launched before getting a node in order to verify some computer specificity.
`protected String`	`tag` tag of the task
`protected Map<String,TaskVariable>`	`variables` A map to hold task variables
`protected long`	`wallTime` maximum execution time of the task (in milliseconds), the variable is only valid if isWallTime is true

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute
DEFAULT_TASK_RETRY_DELAY, GENERIC_INFO_START_AT_KEY, genericInformation, maxNumberOfExecution, onTaskError, restartTaskOnError, taskRetryDelay, unresolvedGenericInformation

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDependence(Task task)` Add a dependence to the task.
`void`	`addDependences(List<Task> tasks)` Same as the `addDependence(Task)` method, but for a list of dependences.
`void`	`addInputFiles(org.objectweb.proactive.extensions.dataspaces.vfs.selector.FileSelector files, InputAccessMode mode)` Add the files value to the given files value according to the provided access mode.
`void`	`addInputFiles(String filesToInclude, InputAccessMode mode)` Add the files to the given filesToInclude value according to the provided access mode.
`void`	`addOutputFiles(org.objectweb.proactive.extensions.dataspaces.vfs.selector.FileSelector files, OutputAccessMode mode)` Add the files value to the given files value according to the provided access mode.
`void`	`addOutputFiles(String filesToInclude, OutputAccessMode mode)` Add the files to the given filesToInclude value according to the provided access mode.
`void`	`addSelectionScript(SelectionScript selectionScript)` To add a selection script to the list of selection script.
`String`	`display()`
`Script<?>`	`getCleaningScript()` To get the cleaningScript of this task.
`List<Task>`	`getDependencesList()` To get the list of dependencies of the task.
`String`	`getDescription()` To get the description of this task.
`FlowBlock`	`getFlowBlock()` Defining Control Flow Blocks with pairs of `FlowBlock.START` and `FlowBlock.END` is a semantic requirement to be able to create specific control flow constructs.
`FlowScript`	`getFlowScript()` To perform complex Control Flow Actions in a TaskFlowJob, a FlowScript needs to be attached to specific tasks.
`ForkEnvironment`	`getForkEnvironment()`
`List<InputSelector>`	`getInputFilesList()` Get the input file selectors list.
`String`	`getName()` To get the name of this task.
`int`	`getNumberOfNodesNeeded()` Get the number of nodes needed for this task (by default: 1).
`List<OutputSelector>`	`getOutputFilesList()` Get the output file selectors list.
`ParallelEnvironment`	`getParallelEnvironment()` Returns the parallel environment of the task.
`Script<?>`	`getPostScript()` To get the postScript of this task.
`Script<?>`	`getPreScript()` To get the preScript of this task.
`List<SelectionScript>`	`getSelectionScripts()` To get the selection script.
`String`	`getTag()` Get the tag of this task.
`Map<String,TaskVariable>`	`getUnresolvedVariables()` Returns the unresolved variable map of this job.
`Map<String,TaskVariable>`	`getVariables()` Returns the variable map of this task.
`Map<String,String>`	`getVariablesOverriden(Job job)` Returns the variable map of this task.
`long`	`getWallTime()`
`String`	`getWorkingDir()` Return the working Directory.
`Boolean`	`isFork()` To know if the task will be run in a forked JVM
`boolean`	`isParallel()` Checks if the task is parallel.
`boolean`	`isPreciousLogs()` To know if the logs of this task are precious.
`boolean`	`isPreciousResult()` To know if the result of this task is precious.
`boolean`	`isRunAsMe()` To know if the task will be executed under the user identity or not.
`boolean`	`isWallTimeSet()` Return true if wallTime is set.
`void`	`setCleaningScript(Script<?> cleaningScript)` To set the cleaningScript of this task.
`void`	`setDescription(String description)` To set the description of this task.
`void`	`setFlowBlock(FlowBlock fb)` Defining Control Flow Blocks using `FlowBlock.START` and `FlowBlock.END` is a semantic requirement to be able to create specific control flow constructs.
`void`	`setFlowScript(FlowScript s)` To perform complex Control Flow Actions in a TaskFlowJob, a FlowScript needs to be attached to specific tasks.
`void`	`setFork(Boolean fork)` Set if the task will be run in a forked JVM
`void`	`setForkEnvironment(ForkEnvironment forkEnvironment)`
`void`	`setName(String name)` To set the name of this task.
`void`	`setNumberOfNeededNodes(int numberOfNodesNeeded)` Deprecated.
`void`	`setParallelEnvironment(ParallelEnvironment parallelEnvironment)` Sets new parallel environment of the task.
`void`	`setPostScript(Script<?> postScript)` To set the postScript of this task.
`void`	`setPreciousLogs(boolean preciousLogs)` Set if the logs of this task are precious.
`void`	`setPreciousResult(boolean preciousResult)` Set if the result of this task is precious.
`void`	`setPreScript(Script<?> preScript)` To set the preScript of this task.
`void`	`setRunAsMe(boolean runAsMe)` Set if this task will be run under user identity.
`void`	`setSelectionScript(SelectionScript selScript)` Set a selection script.
`void`	`setSelectionScripts(List<SelectionScript> selScriptsList)` Set a list of selection scripts.
`void`	`setTag(String tag)` Set the tag of this task.
`void`	`setUnresolvedVariables(Map<String,TaskVariable> unresolvedVariables)` Sets the unresolved variable map for this job.
`void`	`setVariables(Map<String,TaskVariable> variables)` Sets the variable map for this task.
`void`	`setWallTime(long walltime)` Set the wall time to the task in millisecond.
`String`	`toString()`
`static void`	`verifyVariableMap(Map<String,? extends TaskVariable> variables)`

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

- Field Detail
  - name
```
protected String name
```
    Name of the task.
  - flowBlock
```
protected String flowBlock
```
    block declaration : syntactic scopes used for workflows string representation of a FlowBlock enum
  - description
```
protected String description
```
    Description of the task.
  - tag
```
protected String tag
```
    tag of the task
  - inputFiles
```
protected List<InputSelector> inputFiles
```
    DataSpace inputFiles
  - outputFiles
```
protected List<OutputSelector> outputFiles
```
    DataSpace outputFiles
  - parallelEnvironment
```
protected ParallelEnvironment parallelEnvironment
```
    The parallel environment of the task included number of nodes and topology definition required to execute this task.
  - sScripts
```
protected List<SelectionScript> sScripts
```
    selection script : can be launched before getting a node in order to verify some computer specificity.
  - preScript
```
protected Script<?> preScript
```
    PreScript : can be used to launch script just before the task execution.
  - postScript
```
protected Script<?> postScript
```
    PostScript : can be used to launch script just after the task
  - cScript
```
protected Script<?> cScript
```
    CleaningScript : can be used to launch script just after the task or the postScript (if set) Started even if a problem occurs.
  - flowScript
```
protected FlowScript flowScript
```
    FlowScript: Control Flow Action Script executed after the task, returns a FlowAction which will perform flow actions on the job
  - preciousResult
```
protected boolean preciousResult
```
    Tell whether this task has a precious result or not.
  - preciousLogs
```
protected boolean preciousLogs
```
    If true, the stdout/err of this tasks are stored in a file in LOCALSPACE and copied back to USERSPACE
  - runAsMe
```
protected boolean runAsMe
```
  - fork
```
protected Boolean fork
```
    If true, task is ran in a forked JVM, this parameter is optional (nullable) .
  - wallTime
```
protected long wallTime
```
    maximum execution time of the task (in milliseconds), the variable is only valid if isWallTime is true
  - forkEnvironment
```
protected ForkEnvironment forkEnvironment
```
  - variables
```
protected Map<String,TaskVariable> variables
```
    A map to hold task variables
- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - addDependence
```
public void addDependence(Task task)
```
    Add a dependence to the task. Warning : the dependence order is very important.
    In fact, it is in this order that you will get back the result in the children task.
    For example: if you add to the task t3, the dependences t1 then t2, the parents of t3 will be t1 and t2 in this order and the parameters of t3 will be the results of t1 and t2 in this order.
    
    Parameters:
    
    task - the parent task to add to this task.
  - addDependences
```
public void addDependences(List<Task> tasks)
```
    Same as the addDependence(Task) method, but for a list of dependences.
    
    Parameters:
    
    tasks - the parent list of tasks to add to this task.
  - getDescription
```
public String getDescription()
```
    To get the description of this task.
    
    Returns:
    
    the description of this task.
  - setDescription
```
public void setDescription(String description)
```
    To set the description of this task.
    
    Parameters:
    
    description - the description to set.
  - isPreciousResult
```
public boolean isPreciousResult()
```
    To know if the result of this task is precious.
    
    Returns:
    
    true if the result is precious, false if not.
  - setPreciousResult
```
public void setPreciousResult(boolean preciousResult)
```
    Set if the result of this task is precious.
    
    Parameters:
    
    preciousResult - true if the result of this task is precious, false if not.
  - isPreciousLogs
```
public boolean isPreciousLogs()
```
    To know if the logs of this task are precious.
    
    Returns:
    
    true if the logs are precious, false if not.
  - setPreciousLogs
```
public void setPreciousLogs(boolean preciousLogs)
```
    Set if the logs of this task are precious.
    
    Parameters:
    
    preciousLogs - true if the logs of this task are precious, false if not.
  - isRunAsMe
```
public boolean isRunAsMe()
```
    To know if the task will be executed under the user identity or not.
    
    Returns:
    
    true if the task will be executed as the user identity.
  - setRunAsMe
```
public void setRunAsMe(boolean runAsMe)
```
    Set if this task will be run under user identity. This could impact the performance.
    
    Parameters:
    
    runAsMe - true if this task will be run under user identity.
  - isFork
```
public Boolean isFork()
```
    To know if the task will be run in a forked JVM
    
    Returns:
    
    fork true if the task will be run in a forked JVM; false if the task will be ran in the node's JVM.
  - setFork
```
public void setFork(Boolean fork)
```
    Set if the task will be run in a forked JVM
    
    Parameters:
    
    fork - if true, this task will be run in a forked JVM; if false, it will be ran in the node's JVM.
  - getName
```
public String getName()
```
    To get the name of this task.
    
    Returns:
    
    the name of this task.
  - setName
```
public void setName(String name)
```
    To set the name of this task.
    
    Parameters:
    
    name - the name to set.
  - getTag
```
public String getTag()
```
    Get the tag of this task. Return null if this task has no tag.
    
    Returns:
    
    the tag of this task
  - setTag
```
public void setTag(String tag)
```
    Set the tag of this task.
    
    Parameters:
    
    tag - tag value
  - getFlowBlock
```
public FlowBlock getFlowBlock()
```
    Defining Control Flow Blocks with pairs of FlowBlock.START and FlowBlock.END is a semantic requirement to be able to create specific control flow constructs.
    Refer to the documentation for detailed instructions.
    
    Returns:
    
    the FlowBlock attribute of this task indicating if it is the beginning or the ending of a new block scope
  - setFlowBlock
```
public void setFlowBlock(FlowBlock fb)
```
    Defining Control Flow Blocks using FlowBlock.START and FlowBlock.END is a semantic requirement to be able to create specific control flow constructs.
    Refer to the documentation for detailed instructions.
    
    Parameters:
    
    fb - the FlowBlock attribute of this task indicating if it is the beginning or the ending of a new block scope
  - getPreScript
```
public Script<?> getPreScript()
```
    To get the preScript of this task.
    
    Returns:
    
    the preScript of this task.
  - setPreScript
```
public void setPreScript(Script<?> preScript)
```
    To set the preScript of this task.
    
    Parameters:
    
    preScript - the preScript to set.
  - getPostScript
```
public Script<?> getPostScript()
```
    To get the postScript of this task.
    
    Returns:
    
    the postScript of this task.
  - getFlowScript
```
public FlowScript getFlowScript()
```
    To perform complex Control Flow Actions in a TaskFlowJob, a FlowScript needs to be attached to specific tasks.
    Some Control Flow constructs need to be used within the bounds of a FlowBlock, which is defined a the level of the Task using setFlowBlock(FlowBlock).
    Refer to the user documentation for further instructions.
    
    Returns:
    
    the Control Flow Script used for workflow actions
  - setFlowScript
```
public void setFlowScript(FlowScript s)
```
    To perform complex Control Flow Actions in a TaskFlowJob, a FlowScript needs to be attached to specific tasks.
    Some Control Flow constructs need to be used within the bounds of a FlowBlock, which is defined a the level of the Task using setFlowBlock(FlowBlock).
    Refer to the user documentation for further instructions.
    
    Parameters:
    
    s - the Control Flow Script used for workflow actions
  - setPostScript
```
public void setPostScript(Script<?> postScript)
```
    To set the postScript of this task.
    
    Parameters:
    
    postScript - the postScript to set.
  - getCleaningScript
```
public Script<?> getCleaningScript()
```
    To get the cleaningScript of this task.
    
    Returns:
    
    the cleaningScript of this task.
  - setCleaningScript
```
public void setCleaningScript(Script<?> cleaningScript)
```
    To set the cleaningScript of this task.
    
    Parameters:
    
    cleaningScript - the cleaningScript to set.
  - isParallel
```
public boolean isParallel()
```
    Checks if the task is parallel.
    
    Returns:
    
    true if the task is parallel, false otherwise.
  - getParallelEnvironment
```
public ParallelEnvironment getParallelEnvironment()
```
    Returns the parallel environment of the task.
    
    Returns:
    
    the parallel environment of the task.
  - setParallelEnvironment
```
public void setParallelEnvironment(ParallelEnvironment parallelEnvironment)
```
    Sets new parallel environment of the task.
    
    Parameters:
    
    parallelEnvironment - new parallel environment of the task.
  - getSelectionScripts
```
public List<SelectionScript> getSelectionScripts()
```
    To get the selection script. This is the script that will select a node.
    
    Returns:
    
    the selection Script.
  - setSelectionScript
```
public void setSelectionScript(SelectionScript selScript)
```
    Set a selection script. It is the script that will be in charge of selecting a node.
  - setSelectionScripts
```
public void setSelectionScripts(List<SelectionScript> selScriptsList)
```
    Set a list of selection scripts. These are the scripts that will be in charge of selecting a node.
  - addSelectionScript
```
public void addSelectionScript(SelectionScript selectionScript)
```
    To add a selection script to the list of selection script.
    
    Parameters:
    
    selectionScript - the selectionScript to add.
  - getDependencesList
```
public List<Task> getDependencesList()
```
    To get the list of dependencies of the task.
    
    Returns:
    
    the the list of dependencies of the task.
  - getNumberOfNodesNeeded
```
public int getNumberOfNodesNeeded()
```
    Get the number of nodes needed for this task (by default: 1).
    
    Returns:
    
    the number of Nodes Needed
  - getWallTime
```
public long getWallTime()
```
    Returns:
    
    the walltime
  - getWorkingDir
```
public String getWorkingDir()
```
    Return the working Directory.
    
    Returns:
    
    the working Directory.
  - setWallTime
```
public void setWallTime(long walltime)
```
    Set the wall time to the task in millisecond.
    
    Parameters:
    
    walltime - the walltime to set in millisecond.
  - isWallTimeSet
```
public boolean isWallTimeSet()
```
    Return true if wallTime is set.
    
    Returns:
    
    the isWallTime
  - setNumberOfNeededNodes
```
@Deprecated
public void setNumberOfNeededNodes(int numberOfNodesNeeded)
```
    Deprecated.
    
    Set the number of nodes needed for this task.
    This number represents the total number of nodes that you need. You may remember that default number is 1.
    
    Parameters:
    
    numberOfNodesNeeded - the number Of Nodes Needed to set.
  - addInputFiles
```
public void addInputFiles(org.objectweb.proactive.extensions.dataspaces.vfs.selector.FileSelector files,
                          InputAccessMode mode)
```
    Add the files value to the given files value according to the provided access mode.
    Mode define the way the files will be bring to LOCAL space.
    
    Parameters:
    
    files - the input Files to add
    
    mode - the way to provide files to LOCAL space
  - addOutputFiles
```
public void addOutputFiles(org.objectweb.proactive.extensions.dataspaces.vfs.selector.FileSelector files,
                           OutputAccessMode mode)
```
    Add the files value to the given files value according to the provided access mode.
    Mode define the way the files will be send to OUTPUT space.
    
    Parameters:
    
    files - the output Files to add
    
    mode - the way to send files to OUTPUT space
  - addInputFiles
```
public void addInputFiles(String filesToInclude,
                          InputAccessMode mode)
```
    Add the files to the given filesToInclude value according to the provided access mode.
    Mode define the way the files will be bring to LOCAL space. filesToInclude can represent one file or many files defined by a regular expression.
    
    Parameters:
    
    filesToInclude - the input files to add
    
    mode - the way to provide files to LOCAL space
    
    See Also:
    
    for details
  - addOutputFiles
```
public void addOutputFiles(String filesToInclude,
                           OutputAccessMode mode)
```
    Add the files to the given filesToInclude value according to the provided access mode.
    Mode define the way the files will be send to OUTPUT space. filesToInclude can represent one file or many files defined by a regular expression.
    
    Parameters:
    
    filesToInclude - the output files to add
    
    mode - the way to send files to OUTPUT space
    
    See Also:
    
    for details
  - getInputFilesList
```
public List<InputSelector> getInputFilesList()
```
    Get the input file selectors list. This list represents every couple of input FileSelector and its associated access mode The first element is the first added couple.
    This method returns null if nothing was added to the inputFiles.
    
    Returns:
    
    the input file selectors list
  - getOutputFilesList
```
public List<OutputSelector> getOutputFilesList()
```
    Get the output file selectors list. This list represents every couple of output FileSelector and its associated access mode The first element is the first added couple.
    This method returns null if nothing was added to the outputFiles.
    
    Returns:
    
    the output file selectors list
  - setVariables
```
public void setVariables(Map<String,TaskVariable> variables)
```
    Sets the variable map for this task.
    
    Parameters:
    
    variables - the variables map
  - getVariables
```
public Map<String,TaskVariable> getVariables()
```
    Returns the variable map of this task.
    
    Returns:
    
    a variable map
  - getUnresolvedVariables
```
public Map<String,TaskVariable> getUnresolvedVariables()
```
    Returns the unresolved variable map of this job.
    
    Returns:
    
    an unresolved variable map
  - setUnresolvedVariables
```
public void setUnresolvedVariables(Map<String,TaskVariable> unresolvedVariables)
```
    Sets the unresolved variable map for this job.
    
    Parameters:
    
    unresolvedVariables - the unresolved variables map
  - verifyVariableMap
```
public static void verifyVariableMap(Map<String,? extends TaskVariable> variables)
```
  - getVariablesOverriden
```
public Map<String,String> getVariablesOverriden(Job job)
```
    Returns the variable map of this task.
    
    Returns:
    
    a variable map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - display
```
public String display()
```
  - getForkEnvironment
```
public ForkEnvironment getForkEnvironment()
```
  - setForkEnvironment
```
public void setForkEnvironment(ForkEnvironment forkEnvironment)
```

Class Task

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

Constructor Summary

Method Summary

Methods inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

Methods inherited from class java.lang.Object

Field Detail

name

flowBlock

description

tag

inputFiles

outputFiles

parallelEnvironment

sScripts

preScript

postScript

cScript

flowScript

preciousResult

preciousLogs

runAsMe

fork

wallTime

forkEnvironment

variables

Constructor Detail

Task

Method Detail

addDependence

addDependences

getDescription

setDescription

isPreciousResult

setPreciousResult

isPreciousLogs

setPreciousLogs

isRunAsMe

setRunAsMe

isFork

setFork

getName

setName

getTag

setTag

getFlowBlock

setFlowBlock

getPreScript

setPreScript

getPostScript

getFlowScript

setFlowScript

setPostScript

getCleaningScript

setCleaningScript

isParallel

getParallelEnvironment

setParallelEnvironment

getSelectionScripts

setSelectionScript

setSelectionScripts

addSelectionScript

getDependencesList

getNumberOfNodesNeeded

getWallTime

getWorkingDir

setWallTime

isWallTimeSet

setNumberOfNeededNodes

addInputFiles

addOutputFiles

addInputFiles

addOutputFiles

getInputFilesList

getOutputFilesList

setVariables

getVariables

getUnresolvedVariables

setUnresolvedVariables