DriverServiceConfiguration (REEF 0.14.0 API)

java.lang.Object
- org.apache.reef.tang.formats.ConfigurationModuleBuilder
- - org.apache.reef.client.DriverServiceConfiguration

```
public final class DriverServiceConfiguration
extends ConfigurationModuleBuilder
```
Use this ConfigurationModule to configure Services to be run in the Driver.
A service is a set of event handlers that are informed of events in addition to * the event handlers defined in DriverConfiguration. However, most services will treat the events as read-only. Doing differently should be documented clearly in the Service documentation.

Field Summary

Fields
Modifier and Type	Field and Description
`static ConfigurationModule`	`CONF` ConfigurationModule to fill out to get a legal Driver Configuration.
`static OptionalParameter<String>`	`GLOBAL_FILES` Files to be made available on the Driver and all Evaluators.
`static OptionalParameter<String>`	`GLOBAL_LIBRARIES` Libraries to be made available on the Driver and all Evaluators.
`static OptionalParameter<String>`	`LOCAL_FILES` Files to be made available on the Driver only.
`static OptionalParameter<String>`	`LOCAL_LIBRARIES` Libraries to be made available on the Driver only.
`static OptionalImpl<EventHandler<ActiveContext>>`	`ON_CONTEXT_ACTIVE` Event handler for active context.
`static OptionalImpl<EventHandler<ClosedContext>>`	`ON_CONTEXT_CLOSED` Event handler for closed context.
`static OptionalImpl<EventHandler<FailedContext>>`	`ON_CONTEXT_FAILED` Event handler for closed context.
`static OptionalImpl<EventHandler<ContextMessage>>`	`ON_CONTEXT_MESSAGE` Event handler for context messages.
`static OptionalImpl<EventHandler<DriverRestarted>>`	`ON_DRIVER_RESTARTED` The event handler invoked right after the driver restarts.
`static RequiredImpl<EventHandler<StartTime>>`	`ON_DRIVER_STARTED` The event handler invoked right after the driver boots up.
`static OptionalImpl<EventHandler<StopTime>>`	`ON_DRIVER_STOP` The event handler invoked right before the driver shuts down.
`static OptionalImpl<EventHandler<AllocatedEvaluator>>`	`ON_EVALUATOR_ALLOCATED` Event handler for allocated evaluators.
`static OptionalImpl<EventHandler<CompletedEvaluator>>`	`ON_EVALUATOR_COMPLETED` Event handler for completed evaluators.
`static OptionalImpl<EventHandler<FailedEvaluator>>`	`ON_EVALUATOR_FAILED` Event handler for failed evaluators.
`static OptionalImpl<EventHandler<CompletedTask>>`	`ON_TASK_COMPLETED` Event handler for completed tasks.
`static OptionalImpl<EventHandler<FailedTask>>`	`ON_TASK_FAILED` Event handler for failed tasks.
`static OptionalImpl<EventHandler<TaskMessage>>`	`ON_TASK_MESSAGE` Event handler for task messages.
`static OptionalImpl<EventHandler<RunningTask>>`	`ON_TASK_RUNNING` Event handler for running tasks.
`static OptionalImpl<EventHandler<SuspendedTask>>`	`ON_TASK_SUSPENDED` Event handler for suspended tasks.

Constructor Summary

Constructors
Constructor and Description

DriverServiceConfiguration()

Constructors
Constructor and Description
`DriverServiceConfiguration()`

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
  - GLOBAL_FILES
```
public static final OptionalParameter<String> GLOBAL_FILES
```
    Files to be made available on the Driver and all Evaluators.
  - GLOBAL_LIBRARIES
```
public static final OptionalParameter<String> GLOBAL_LIBRARIES
```
    Libraries to be made available on the Driver and all Evaluators.
  - LOCAL_FILES
```
public static final OptionalParameter<String> LOCAL_FILES
```
    Files to be made available on the Driver only.
  - LOCAL_LIBRARIES
```
public static final OptionalParameter<String> LOCAL_LIBRARIES
```
    Libraries to be made available on the Driver only.
  - ON_DRIVER_STARTED
```
public static final RequiredImpl<EventHandler<StartTime>> ON_DRIVER_STARTED
```
    The event handler invoked right after the driver boots up.
  - ON_DRIVER_RESTARTED
```
public static final OptionalImpl<EventHandler<DriverRestarted>> ON_DRIVER_RESTARTED
```
    The event handler invoked right after the driver restarts.
  - ON_DRIVER_STOP
```
public static final OptionalImpl<EventHandler<StopTime>> ON_DRIVER_STOP
```
    The event handler invoked right before the driver shuts down. Defaults to ignore.
  - ON_EVALUATOR_ALLOCATED
```
public static final OptionalImpl<EventHandler<AllocatedEvaluator>> ON_EVALUATOR_ALLOCATED
```
    Event handler for allocated evaluators. Defaults to returning the evaluator if not bound.
  - ON_EVALUATOR_COMPLETED
```
public static final OptionalImpl<EventHandler<CompletedEvaluator>> ON_EVALUATOR_COMPLETED
```
    Event handler for completed evaluators. Defaults to logging if not bound.
  - ON_EVALUATOR_FAILED
```
public static final OptionalImpl<EventHandler<FailedEvaluator>> ON_EVALUATOR_FAILED
```
    Event handler for failed evaluators. Defaults to job failure if not bound.
  - ON_TASK_MESSAGE
```
public static final OptionalImpl<EventHandler<TaskMessage>> ON_TASK_MESSAGE
```
    Event handler for task messages. Defaults to logging if not bound.
  - ON_TASK_COMPLETED
```
public static final OptionalImpl<EventHandler<CompletedTask>> ON_TASK_COMPLETED
```
    Event handler for completed tasks. Defaults to closing the context the task ran on if not bound.
  - ON_TASK_FAILED
```
public static final OptionalImpl<EventHandler<FailedTask>> ON_TASK_FAILED
```
    Event handler for failed tasks. Defaults to job failure if not bound.
  - ON_TASK_RUNNING
```
public static final OptionalImpl<EventHandler<RunningTask>> ON_TASK_RUNNING
```
    Event handler for running tasks. Defaults to logging if not bound.
  - ON_TASK_SUSPENDED
```
public static final OptionalImpl<EventHandler<SuspendedTask>> ON_TASK_SUSPENDED
```
    Event handler for suspended tasks. Defaults to job failure if not bound. Rationale: many jobs don't support task suspension. Hence, this parameter should be optional. The only sane default is to crash the job, then.
  - ON_CONTEXT_ACTIVE
```
public static final OptionalImpl<EventHandler<ActiveContext>> ON_CONTEXT_ACTIVE
```
    Event handler for active context. Defaults to closing the context if not bound.
  - ON_CONTEXT_CLOSED
```
public static final OptionalImpl<EventHandler<ClosedContext>> ON_CONTEXT_CLOSED
```
    Event handler for closed context. Defaults to logging if not bound.
  - ON_CONTEXT_FAILED
```
public static final OptionalImpl<EventHandler<FailedContext>> ON_CONTEXT_FAILED
```
    Event handler for closed context. Defaults to job failure if not bound.
  - ON_CONTEXT_MESSAGE
```
public static final OptionalImpl<EventHandler<ContextMessage>> ON_CONTEXT_MESSAGE
```
    Event handler for context messages. Defaults to logging if not bound.
  - CONF
```
public static final ConfigurationModule CONF
```
    ConfigurationModule to fill out to get a legal Driver Configuration.
- Constructor Detail
  - DriverServiceConfiguration
```
public DriverServiceConfiguration()
```

Class DriverServiceConfiguration

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

GLOBAL_FILES

GLOBAL_LIBRARIES

LOCAL_FILES

LOCAL_LIBRARIES

ON_DRIVER_STARTED

ON_DRIVER_RESTARTED

ON_DRIVER_STOP

ON_EVALUATOR_ALLOCATED

ON_EVALUATOR_COMPLETED

ON_EVALUATOR_FAILED

ON_TASK_MESSAGE

ON_TASK_COMPLETED

ON_TASK_FAILED

ON_TASK_RUNNING

ON_TASK_SUSPENDED

ON_CONTEXT_ACTIVE

ON_CONTEXT_CLOSED

ON_CONTEXT_FAILED

ON_CONTEXT_MESSAGE

CONF

Constructor Detail

DriverServiceConfiguration