org.apache.reef.runtime.common

Class REEFEnvironment

java.lang.Object

org.apache.reef.runtime.common.REEFEnvironment

All Implemented Interfaces:

AutoCloseable, Runnable

public final class REEFEnvironment
extends Object
implements Runnable, AutoCloseable

The main entry point into any REEF process (Driver and Evaluator). It is mostly reading from the command line to instantiate the runtime clock and calling .run() on it.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close and cleanup the environment.
static REEFEnvironment	fromConfiguration(Configuration... configurations) Create a new REEF environment.
static REEFEnvironment	fromConfiguration(UserCredentials hostUser, Configuration... configurations) Create a new REEF environment.
ReefServiceProtos.JobStatusProto	getLastStatus() Get the last known status of REEF job.
void	run() Launch REEF component (Driver or Evaluator).

Methods inherited from class java.lang.Object

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

Method Detail

fromConfiguration

public static REEFEnvironment fromConfiguration(Configuration... configurations)
                                         throws InjectionException

Create a new REEF environment.

Parameters:

configurations - REEF component (Driver or Evaluator) configuration. If multiple configurations are provided, they will be merged before use. Main part of the configuration is usually read from config file by REEFLauncher.

Throws:

InjectionException - Thrown on configuration error.

fromConfiguration

public static REEFEnvironment fromConfiguration(UserCredentials hostUser,
                                Configuration... configurations)
                                         throws InjectionException

Create a new REEF environment.

Parameters:

hostUser - User credentials to use when registering REEF app with the Resource Manager. This parameter may be required for Unmanaged AM mode. Can be null.

configurations - REEF component (Driver or Evaluator) configuration. If multiple configurations are provided, they will be merged before use. Main part of the configuration is usually read from config file by REEFLauncher.

Throws:

InjectionException - Thrown on configuration error.

close

public void close()

Close and cleanup the environment. Invoke .close() on all closeable members (clock and error handler).

Specified by:

close in interface AutoCloseable

run

public void run()

Launch REEF component (Driver or Evaluator). It is usually called from the static .run() method. Check the status of the run via .getLastStatus() method.

Specified by:

run in interface Runnable

getLastStatus

public ReefServiceProtos.JobStatusProto getLastStatus()

Get the last known status of REEF job. Can return null if job has not started yet.

Returns:

Status of the REEF job launched in this environment.