org.ow2.proactive.scheduler.task.context

Class TaskContextVariableExtractor

java.lang.Object

org.ow2.proactive.scheduler.task.context.TaskContextVariableExtractor

All Implemented Interfaces:

Serializable

public class TaskContextVariableExtractor
extends Object
implements Serializable

This class will help you to create a Map containing all variables you need. I will also manage to resolve values following some constraints of VariableSubstitutor class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskContextVariableExtractor()

Method Summary

Modifier and Type	Method and Description
Map<String,byte[]>	extractPropagatedVariables(TaskContext taskContext) Extract variables from the previous task result to be propagated to children tasks in case of internal error.
Map<String,String>	extractThirdPartyCredentials(TaskContext taskContext)
Map<String,String>	extractVariablesThirdPartyCredentialsAndSystemEnvironmentVariables(TaskContext taskContext) Retrieve all third party credential variables in a map.
Map<String,Serializable>	getAllNonTaskVariables(TaskContext taskContext) Method to retrieve all variables in scope.
Map<String,Serializable>	getAllNonTaskVariablesInjectNodesFile(TaskContext taskContext, String nodesFile) Method to retrieve all variables in scope.
Map<String,Serializable>	getAllVariables(TaskContext taskContext) Method to retrieve all variables in scope.
Map<String,Serializable>	getAllVariablesWithTaskResult(TaskContext taskContext, TaskResult taskResult) Return all variables available.
Map<String,Serializable>	getScopeVariables(TaskContext taskContext) Return all variables in scope of a given taskContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskContextVariableExtractor

public TaskContextVariableExtractor()

Method Detail

extractVariablesThirdPartyCredentialsAndSystemEnvironmentVariables

public Map<String,String> extractVariablesThirdPartyCredentialsAndSystemEnvironmentVariables(TaskContext taskContext)

Retrieve all third party credential variables in a map.

Parameters:

taskContext - all information to extract third party credentials is here.

Returns:

map containing thirdPartyCredentials

extractThirdPartyCredentials

public Map<String,String> extractThirdPartyCredentials(TaskContext taskContext)

getScopeVariables

public Map<String,Serializable> getScopeVariables(TaskContext taskContext)

Return all variables in scope of a given taskContext.

Parameters:

taskContext - task context container.

Returns:

Map containing all variables resolved.

getAllNonTaskVariables

public Map<String,Serializable> getAllNonTaskVariables(TaskContext taskContext)

Method to retrieve all variables in scope. Note it ignores TaskResult variables and nodesFile.

Parameters:

taskContext - task context container.

Returns:

Map containing all variables extracted.

getAllNonTaskVariablesInjectNodesFile

public Map<String,Serializable> getAllNonTaskVariablesInjectNodesFile(TaskContext taskContext,
                                                                      String nodesFile)

Method to retrieve all variables in scope. Note it ignores TaskResult variables and nodesFile.

Parameters:

taskContext - task context container.

Returns:

Map containing all variables extracted.

getAllVariablesWithTaskResult

public Map<String,Serializable> getAllVariablesWithTaskResult(TaskContext taskContext,
                                                              TaskResult taskResult)

Return all variables available.

Parameters:

taskContext - context containing all variables inside.

taskResult - used to retrieve the result task variables.

Returns:

Map containing variables.

getAllVariables

public Map<String,Serializable> getAllVariables(TaskContext taskContext)

Method to retrieve all variables in scope. Note it ignores TaskResult variables and nodesFile.

Parameters:

taskContext -

Returns:

Map containing all variables extracted.

extractPropagatedVariables

public Map<String,byte[]> extractPropagatedVariables(TaskContext taskContext)

Extract variables from the previous task result to be propagated to children tasks in case of internal error.

Parameters:

taskContext - contains the information needed to extract.

Returns:

a map containing extracted variables or an empty hash if there are no variables or previous tasks.