org.apache.reef.runtime.common.driver.evaluator

Class AllocatedEvaluatorImpl

java.lang.Object

org.apache.reef.runtime.common.driver.evaluator.AllocatedEvaluatorImpl

All Implemented Interfaces:

AutoCloseable, ContextAndTaskSubmittable, ContextSubmittable, AllocatedEvaluator, TaskSubmittable, Identifiable

public final class AllocatedEvaluatorImpl
extends Object
implements AllocatedEvaluator

Driver-Side representation of an allocated evaluator.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFile(File file) Puts the given file into the working directory of the Evaluator.
void	addLibrary(File file) Puts the given file into the working directory of the Evaluator and adds it to its classpath.
void	close() Releases the allocated evaluator back to the resource manager.
EvaluatorDescriptor	getEvaluatorDescriptor()
String	getId() Returns an identifier of this object.
void	setProcess(EvaluatorProcess process) Specify the process to be instantiated for the Evaluator.
void	submitContext(Configuration contextConfiguration) Submit a Context.
void	submitContext(String contextConfiguration) Submit Context with configuration strings.
void	submitContextAndService(Configuration contextConfiguration, Configuration serviceConfiguration) Submit a Context and a Service Configuration.
void	submitContextAndService(String contextConfiguration, String serviceConfiguration) Submit Context and Service with configuration strings.
void	submitContextAndServiceAndTask(Configuration contextConfiguration, Configuration serviceConfiguration, Configuration taskConfiguration) Submit a Context with Services and a Task.
void	submitContextAndServiceAndTask(String contextConfiguration, String serviceConfiguration, String taskConfiguration) Submit Context and Service with configuration strings.
void	submitContextAndTask(Configuration contextConfiguration, Configuration taskConfiguration) Submit a Context and a Task.
void	submitContextAndTask(String contextConfiguration, String taskConfiguration) Submit Context and Task with configuration strings.
void	submitTask(Configuration taskConfiguration) Submits the given Task for execution.
void	submitTask(String taskConfiguration) Submit Task with configuration strings.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

Returns an identifier of this object.

Specified by:

getId in interface Identifiable

Returns:

an identifier of this object

close

public void close()

Description copied from interface: AllocatedEvaluator

Releases the allocated evaluator back to the resource manager.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AllocatedEvaluator

submitTask

public void submitTask(Configuration taskConfiguration)

Description copied from interface: AllocatedEvaluator

Submits the given Task for execution.

This generates a ContextConfiguration for the root context with a generated ID derived from the EvaluatorId.

Specified by:

submitTask in interface AllocatedEvaluator

Specified by:

submitTask in interface TaskSubmittable

Parameters:

taskConfiguration - the Configuration. See TaskConfiguration for details.

submitTask

public void submitTask(String taskConfiguration)

Submit Task with configuration strings. This method should be called from bridge and the configuration strings are serialized at .Net side.

Parameters:

taskConfiguration -

getEvaluatorDescriptor

public EvaluatorDescriptor getEvaluatorDescriptor()

Specified by:

getEvaluatorDescriptor in interface AllocatedEvaluator

Returns:

the evaluator descriptor of this evaluator.

submitContext

public void submitContext(Configuration contextConfiguration)

Description copied from interface: ContextSubmittable

Submit a Context.

Specified by:

submitContext in interface ContextSubmittable

Specified by:

submitContext in interface AllocatedEvaluator

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

submitContext

public void submitContext(String contextConfiguration)

Submit Context with configuration strings. This method should be called from bridge and the configuration strings are serialized at .Net side.

Parameters:

contextConfiguration -

submitContextAndService

public void submitContextAndService(Configuration contextConfiguration,
                           Configuration serviceConfiguration)

Description copied from interface: ContextSubmittable

Submit a Context and a Service Configuration.

Specified by:

submitContextAndService in interface ContextSubmittable

Specified by:

submitContextAndService in interface AllocatedEvaluator

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

serviceConfiguration - the Configuration for the Services. See ServiceConfiguration for details.

submitContextAndService

public void submitContextAndService(String contextConfiguration,
                           String serviceConfiguration)

Submit Context and Service with configuration strings. This method should be called from bridge and the configuration strings are serialized at .Net side.

Parameters:

contextConfiguration -

serviceConfiguration -

submitContextAndTask

public void submitContextAndTask(Configuration contextConfiguration,
                        Configuration taskConfiguration)

Description copied from interface: ContextAndTaskSubmittable

Submit a Context and a Task.

The semantics of this call are the same as first submitting the context and then, on the fired ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on the network.

REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.

Specified by:

submitContextAndTask in interface ContextAndTaskSubmittable

Specified by:

submitContextAndTask in interface AllocatedEvaluator

Parameters:

contextConfiguration - the Configuration of the EvaluatorContext. See ContextConfiguration for details.

taskConfiguration - the Configuration of the Task. See TaskConfiguration for details.

submitContextAndTask

public void submitContextAndTask(String contextConfiguration,
                        String taskConfiguration)

Submit Context and Task with configuration strings. This method should be called from bridge and the configuration strings are serialized at .Net side.

Parameters:

contextConfiguration -

taskConfiguration -

submitContextAndServiceAndTask

public void submitContextAndServiceAndTask(Configuration contextConfiguration,
                                  Configuration serviceConfiguration,
                                  Configuration taskConfiguration)

Description copied from interface: ContextAndTaskSubmittable

Submit a Context with Services and a Task.

The semantics of this call are the same as first submitting the context and services and then, on the fired ActiveContext event to submit the Task. The performance of this will be better, though as it potentially saves some roundtrips on the network.

REEF will not fire an ActiveContext as a result of this. Instead, it will fire a TaskRunning event.

Specified by:

submitContextAndServiceAndTask in interface ContextAndTaskSubmittable

Specified by:

submitContextAndServiceAndTask in interface AllocatedEvaluator

submitContextAndServiceAndTask

public void submitContextAndServiceAndTask(String contextConfiguration,
                                  String serviceConfiguration,
                                  String taskConfiguration)

Submit Context and Service with configuration strings. This method should be called from bridge and the configuration strings are serialized at .Net side

Parameters:

contextConfiguration -

serviceConfiguration -

taskConfiguration -

setProcess

public void setProcess(EvaluatorProcess process)

Description copied from interface: AllocatedEvaluator

Specify the process to be instantiated for the Evaluator. Defaults to an EvaluatorProcess instantiated by the binded ProcessFactory.

Specified by:

setProcess in interface AllocatedEvaluator

addFile

public void addFile(File file)

Description copied from interface: AllocatedEvaluator

Puts the given file into the working directory of the Evaluator.

Specified by:

addFile in interface AllocatedEvaluator

Parameters:

file - the file to be copied

addLibrary

public void addLibrary(File file)

Description copied from interface: AllocatedEvaluator

Puts the given file into the working directory of the Evaluator and adds it to its classpath.

Specified by:

addLibrary in interface AllocatedEvaluator

Parameters:

file - the file to be copied

toString

public String toString()

Overrides:

toString in class Object