org.apache.reef.runtime.common.driver.context

Class EvaluatorContext

java.lang.Object

org.apache.reef.runtime.common.driver.context.EvaluatorContext

All Implemented Interfaces:

AutoCloseable, ActiveContext, ContextBase, ContextSubmittable, TaskSubmittable, Identifiable

public final class EvaluatorContext
extends Object
implements ActiveContext

Driver-side representation of a Context on an Evaluator.

Constructor Summary

Constructors

Constructor and Description
EvaluatorContext(String contextIdentifier, String evaluatorIdentifier, EvaluatorDescriptor evaluatorDescriptor, Optional<String> parentID, ConfigurationSerializer configurationSerializer, ContextControlHandler contextControlHandler, EvaluatorMessageDispatcher messageDispatcher, ExceptionCodec exceptionCodec, ContextRepresenters contextRepresenters)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
ClosedContext	getClosedContext(ActiveContext parentContext)
EvaluatorDescriptor	getEvaluatorDescriptor()
String	getEvaluatorId()
FailedContext	getFailedContext(ContextStatusPOJO contextStatus)
FailedContext	getFailedContextForEvaluatorFailure()
String	getId() Returns an identifier of this object.
Optional<String>	getParentId()
boolean	isRootContext()
void	sendMessage(byte[] message) Send the active context the message, which will be delivered to all registered ContextMessageHandler, for this context.
void	submitContext(Configuration contextConfiguration) Submit a Context.
void	submitContext(String contextConf)
void	submitContextAndService(Configuration contextConfiguration, Configuration serviceConfiguration) Submit a Context and a Service Configuration.
void	submitContextAndService(String contextConf, Optional<String> serviceConf)
void	submitContextAndService(String contextConf, String serviceConf)
void	submitTask(Configuration taskConf) Submits a Task (encoded in the Configuration) for execution.
void	submitTask(String taskConf)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluatorContext

public EvaluatorContext(String contextIdentifier,
                String evaluatorIdentifier,
                EvaluatorDescriptor evaluatorDescriptor,
                Optional<String> parentID,
                ConfigurationSerializer configurationSerializer,
                ContextControlHandler contextControlHandler,
                EvaluatorMessageDispatcher messageDispatcher,
                ExceptionCodec exceptionCodec,
                ContextRepresenters contextRepresenters)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ActiveContext

sendMessage

public void sendMessage(byte[] message)

Description copied from interface: ActiveContext

Send the active context the message, which will be delivered to all registered ContextMessageHandler, for this context.

Specified by:

sendMessage in interface ActiveContext

Parameters:

message - The message to be sent.

submitTask

public void submitTask(Configuration taskConf)

Description copied from interface: TaskSubmittable

Submits a Task (encoded in the Configuration) for execution.

Specified by:

submitTask in interface ActiveContext

Specified by:

submitTask in interface TaskSubmittable

Parameters:

taskConf - the Configuration. See TaskConfiguration for details

submitTask

public void submitTask(String taskConf)

submitContext

public void submitContext(Configuration contextConfiguration)

Description copied from interface: ContextSubmittable

Submit a Context.

Specified by:

submitContext in interface ActiveContext

Specified by:

submitContext in interface ContextSubmittable

Parameters:

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

submitContext

public void submitContext(String contextConf)

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 ActiveContext

Specified by:

submitContextAndService in interface ContextSubmittable

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 contextConf,
                           String serviceConf)

submitContextAndService

public void submitContextAndService(String contextConf,
                           Optional<String> serviceConf)

getEvaluatorId

public String getEvaluatorId()

Specified by:

getEvaluatorId in interface ContextBase

Returns:

the identifier of the Evaluator this Context is instantiated on.

getParentId

public Optional<String> getParentId()

Specified by:

getParentId in interface ContextBase

Returns:

the ID of the parent context, if there is one.

getEvaluatorDescriptor

public EvaluatorDescriptor getEvaluatorDescriptor()

Specified by:

getEvaluatorDescriptor in interface ContextBase

Returns:

the descriptor of the Evaluator this Context is on.

getId

public String getId()

Description copied from interface: Identifiable

Returns an identifier of this object.

Specified by:

getId in interface ContextBase

Specified by:

getId in interface Identifiable

Returns:

an identifier of this object

toString

public String toString()

Overrides:

toString in class Object

getClosedContext

public ClosedContext getClosedContext(ActiveContext parentContext)

getFailedContextForEvaluatorFailure

public FailedContext getFailedContextForEvaluatorFailure()

Returns:

a FailedContext for the case of an EvaluatorFailure.

getFailedContext

public FailedContext getFailedContext(ContextStatusPOJO contextStatus)

isRootContext

public boolean isRootContext()