org.apache.flink.runtime.execution

Class RuntimeEnvironment

java.lang.Object

org.apache.flink.runtime.execution.RuntimeEnvironment

All Implemented Interfaces:

Runnable, Environment

public class RuntimeEnvironment
extends Object
implements Environment, Runnable

Constructor Summary

Constructors

Constructor and Description
RuntimeEnvironment(akka.actor.ActorRef jobManager, Task owner, TaskDeploymentDescriptor tdd, ClassLoader userCodeClassLoader, MemoryManager memoryManager, IOManager ioManager, InputSplitProvider inputSplitProvider, BroadcastVariableManager broadcastVariableManager, NetworkEnvironment networkEnvironment)

Method Summary

Modifier and Type	Method and Description
void	addCopyTaskForCacheFile(String name, FutureTask<Path> copyTask)
void	addCopyTasksForCacheFile(Map<String,FutureTask<Path>> copyTasks)
void	cancelExecution()
SingleInputGate[]	getAllInputGates()
ResultPartitionWriter[]	getAllWriters()
BroadcastVariableManager	getBroadcastVariableManager()
Map<String,FutureTask<Path>>	getCopyTask()
Thread	getExecutingThread() Returns the thread, which is assigned to execute the user code.
int	getIndexInSubtaskGroup() Returns the index of this subtask in the subtask group.
InputGate	getInputGate(int index)
SingleInputGate	getInputGateById(IntermediateDataSetID id)
InputSplitProvider	getInputSplitProvider() Returns the input split provider assigned to this environment.
AbstractInvokable	getInvokable() Returns the task invokable instance.
IOManager	getIOManager() Returns the current IOManager.
Configuration	getJobConfiguration() Returns the job configuration object which was attached to the original JobGraph.
JobID	getJobID() Returns the ID of the job from the original job graph.
akka.actor.ActorRef	getJobManager() Returns the proxy object for the accumulator protocol.
JobVertexID	getJobVertexId() Gets the ID of the jobVertex that this task corresponds to.
MemoryManager	getMemoryManager() Returns the current MemoryManager.
int	getNumberOfSubtasks() Returns the current number of subtasks the respective task is split into.
ResultPartition[]	getProducedPartitions()
Configuration	getTaskConfiguration() Returns the task configuration object which was attached to the original JobVertex.
String	getTaskName() Returns the name of the task running in this environment.
String	getTaskNameWithSubtasks()
ClassLoader	getUserClassLoader() Returns the user code class loader
ResultPartitionWriter	getWriter(int index)
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeEnvironment

public RuntimeEnvironment(akka.actor.ActorRef jobManager,
                          Task owner,
                          TaskDeploymentDescriptor tdd,
                          ClassLoader userCodeClassLoader,
                          MemoryManager memoryManager,
                          IOManager ioManager,
                          InputSplitProvider inputSplitProvider,
                          BroadcastVariableManager broadcastVariableManager,
                          NetworkEnvironment networkEnvironment)
                   throws Exception

Throws:

Exception

Method Detail

getInvokable

public AbstractInvokable getInvokable()

Returns the task invokable instance.

getJobID

public JobID getJobID()

Description copied from interface: Environment

Returns the ID of the job from the original job graph. It is used by the library cache manager to find the required libraries for executing the assigned Nephele task.

Specified by:

getJobID in interface Environment

Returns:

the ID of the job from the original job graph

getJobVertexId

public JobVertexID getJobVertexId()

Description copied from interface: Environment

Gets the ID of the jobVertex that this task corresponds to.

Specified by:

getJobVertexId in interface Environment

Returns:

The JobVertexID of this task.

run

public void run()

Specified by:

run in interface Runnable

getExecutingThread

public Thread getExecutingThread()

Returns the thread, which is assigned to execute the user code.

cancelExecution

public void cancelExecution()

getJobManager

public akka.actor.ActorRef getJobManager()

Description copied from interface: Environment

Returns the proxy object for the accumulator protocol.

Specified by:

getJobManager in interface Environment

getIOManager

public IOManager getIOManager()

Description copied from interface: Environment

Returns the current IOManager.

Specified by:

getIOManager in interface Environment

Returns:

the current IOManager.

getMemoryManager

public MemoryManager getMemoryManager()

Description copied from interface: Environment

Returns the current MemoryManager.

Specified by:

getMemoryManager in interface Environment

Returns:

the current MemoryManager.

getBroadcastVariableManager

public BroadcastVariableManager getBroadcastVariableManager()

Specified by:

getBroadcastVariableManager in interface Environment

getWriter

public ResultPartitionWriter getWriter(int index)

Specified by:

getWriter in interface Environment

getAllWriters

public ResultPartitionWriter[] getAllWriters()

Specified by:

getAllWriters in interface Environment

getInputGate

public InputGate getInputGate(int index)

Specified by:

getInputGate in interface Environment

getAllInputGates

public SingleInputGate[] getAllInputGates()

Specified by:

getAllInputGates in interface Environment

getProducedPartitions

public ResultPartition[] getProducedPartitions()

getInputGateById

public SingleInputGate getInputGateById(IntermediateDataSetID id)

getTaskConfiguration

public Configuration getTaskConfiguration()

Description copied from interface: Environment

Returns the task configuration object which was attached to the original JobVertex.

Specified by:

getTaskConfiguration in interface Environment

Returns:

the task configuration object which was attached to the original JobVertex.

getJobConfiguration

public Configuration getJobConfiguration()

Description copied from interface: Environment

Returns the job configuration object which was attached to the original JobGraph.

Specified by:

getJobConfiguration in interface Environment

Returns:

the job configuration object which was attached to the original JobGraph

getNumberOfSubtasks

public int getNumberOfSubtasks()

Description copied from interface: Environment

Returns the current number of subtasks the respective task is split into.

Specified by:

getNumberOfSubtasks in interface Environment

Returns:

the current number of subtasks the respective task is split into

getIndexInSubtaskGroup

public int getIndexInSubtaskGroup()

Description copied from interface: Environment

Returns the index of this subtask in the subtask group.

Specified by:

getIndexInSubtaskGroup in interface Environment

Returns:

the index of this subtask in the subtask group

getTaskName

public String getTaskName()

Description copied from interface: Environment

Returns the name of the task running in this environment.

Specified by:

getTaskName in interface Environment

Returns:

the name of the task running in this environment

getInputSplitProvider

public InputSplitProvider getInputSplitProvider()

Description copied from interface: Environment

Returns the input split provider assigned to this environment.

Specified by:

getInputSplitProvider in interface Environment

Returns:

the input split provider or null if no such provider has been assigned to this environment.

getTaskNameWithSubtasks

public String getTaskNameWithSubtasks()

Specified by:

getTaskNameWithSubtasks in interface Environment

getUserClassLoader

public ClassLoader getUserClassLoader()

Description copied from interface: Environment

Returns the user code class loader

Specified by:

getUserClassLoader in interface Environment

addCopyTasksForCacheFile

public void addCopyTasksForCacheFile(Map<String,FutureTask<Path>> copyTasks)

addCopyTaskForCacheFile

public void addCopyTaskForCacheFile(String name,
                                    FutureTask<Path> copyTask)

getCopyTask

public Map<String,FutureTask<Path>> getCopyTask()

Specified by:

getCopyTask in interface Environment