org.apache.reef.client

Class ClientConfiguration

java.lang.Object

org.apache.reef.tang.formats.ConfigurationModuleBuilder

org.apache.reef.client.ClientConfiguration

public final class ClientConfiguration
extends ConfigurationModuleBuilder

A ConfigurationModule to fill out for the client configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationModule	CONF
static OptionalImpl<EventHandler<CompletedJob>>	ON_JOB_COMPLETED Handler for the event when a submitted REEF Job is completed.
static OptionalImpl<EventHandler<FailedJob>>	ON_JOB_FAILED Handler for the event when a submitted REEF Job has failed.
static OptionalImpl<EventHandler<JobMessage>>	ON_JOB_MESSAGE Event handler for messages from the running job.
static OptionalImpl<EventHandler<RunningJob>>	ON_JOB_RUNNING Handler for the event when a submitted REEF Job is running.
static OptionalImpl<EventHandler<SubmittedJob>>	ON_JOB_SUBMITTED Handler for the event when a REEF job is submitted to the Resource Manager.
static OptionalImpl<EventHandler<FailedRuntime>>	ON_RUNTIME_ERROR Receives fatal resourcemanager errors.
static OptionalImpl<EventHandler<Throwable>>	ON_WAKE_ERROR Error handler for events on Wake-spawned threads.

Constructor Summary

Constructors

Constructor and Description
ClientConfiguration()

Method Summary

Methods inherited from class org.apache.reef.tang.formats.ConfigurationModuleBuilder

bind, bindConstructor, bindConstructor, bindImplementation, bindImplementation, bindImplementation, bindList, bindList, bindList, bindNamedParameter, bindNamedParameter, bindNamedParameter, bindNamedParameter, bindSetEntry, bindSetEntry, bindSetEntry, bindSetEntry, build, merge

Methods inherited from class java.lang.Object

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

Field Detail

ON_JOB_MESSAGE

public static final OptionalImpl<EventHandler<JobMessage>> ON_JOB_MESSAGE

Event handler for messages from the running job. Default implementation just writes message to the log. A message contains a status and a client-defined message payload.

ON_JOB_SUBMITTED

public static final OptionalImpl<EventHandler<SubmittedJob>> ON_JOB_SUBMITTED

Handler for the event when a REEF job is submitted to the Resource Manager. Default implementation just writes the new job ID to the log.

ON_JOB_RUNNING

public static final OptionalImpl<EventHandler<RunningJob>> ON_JOB_RUNNING

Handler for the event when a submitted REEF Job is running. Default implementation just writes to the log.

ON_JOB_COMPLETED

public static final OptionalImpl<EventHandler<CompletedJob>> ON_JOB_COMPLETED

Handler for the event when a submitted REEF Job is completed. Default implementation just writes to the log.

ON_JOB_FAILED

public static final OptionalImpl<EventHandler<FailedJob>> ON_JOB_FAILED

Handler for the event when a submitted REEF Job has failed. Default implementation logs an error and rethrows the exception in the client JVM.

ON_RUNTIME_ERROR

public static final OptionalImpl<EventHandler<FailedRuntime>> ON_RUNTIME_ERROR

Receives fatal resourcemanager errors. The presence of this error means that the underlying REEF instance is no longer able to execute REEF jobs. The actual Jobs may or may not still be running. Default implementation logs an error and rethrows the exception in the client JVM.

ON_WAKE_ERROR

public static final OptionalImpl<EventHandler<Throwable>> ON_WAKE_ERROR

Error handler for events on Wake-spawned threads. Exceptions that are thrown on wake-spawned threads (e.g. in EventHandlers) will be caught by Wake and delivered to this handler. Default behavior is to log the exceptions and rethrow them as RuntimeExceptions.

CONF

public static final ConfigurationModule CONF

Constructor Detail

ClientConfiguration

public ClientConfiguration()