org.apache.reef.runtime.common.files

Class REEFFileNames

java.lang.Object

org.apache.reef.runtime.common.files.REEFFileNames

@Immutable
public final class REEFFileNames
extends Object

Access to the various places things go according to the REEF file system standard.

Constructor Summary

Constructors

Constructor and Description
REEFFileNames()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDriverConfigurationName() The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER
String	getDriverConfigurationPath()
String	getDriverStderrFileName()
String	getDriverStdoutFileName()
String	getEvaluatorConfigurationName()
String	getEvaluatorConfigurationPath()
String	getEvaluatorFolderPrefix()
String	getEvaluatorStderrFileName()
String	getEvaluatorStdoutFileName()
File	getGlobalFolder()
String	getGlobalFolderName()
String	getGlobalFolderPath()
String	getJarFileSuffix()
String	getJobFolderPrefix() The prefix used whenever REEF is asked to create a job folder, on (H)DFS or locally.
File	getLocalFolder()
String	getLocalFolderName()
String	getLocalFolderPath()
File	getREEFFolder()
String	getREEFFolderName() The name of the REEF folder inside of the working directory of an Evaluator or Driver

Methods inherited from class java.lang.Object

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

Constructor Detail

REEFFileNames

@Inject
public REEFFileNames()

Method Detail

getREEFFolderName

public String getREEFFolderName()

The name of the REEF folder inside of the working directory of an Evaluator or Driver

getREEFFolder

public File getREEFFolder()

Returns:

the folder und which all REEF files are stored.

getGlobalFolderName

public String getGlobalFolderName()

Returns:

the name of the folder inside of REEF_BASE_FOLDER that houses the global files.

getGlobalFolderPath

public String getGlobalFolderPath()

Returns:

the path to the global folder: REEF_BASE_FOLDER/GLOBAL_FOLDER

getGlobalFolder

public File getGlobalFolder()

Returns:

the folder holding the files global to all containers.

getLocalFolderName

public String getLocalFolderName()

Returns:

the name of the folder inside of REEF_BASE_FOLDER that houses the local files.

getLocalFolderPath

public String getLocalFolderPath()

Returns:

the path to the local folder: REEF_BASE_FOLDER/LOCAL_FOLDER

getLocalFolder

public File getLocalFolder()

Returns:

the folder holding the files local to this container.

getDriverConfigurationName

public String getDriverConfigurationName()

The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER

getDriverConfigurationPath

public String getDriverConfigurationPath()

Returns:

The path to the driver configuration: GLOBAL_FOLDER/LOCAL_FOLDER/DRIVER_CONFIGURATION_NAME

getEvaluatorConfigurationName

public String getEvaluatorConfigurationName()

Returns:

The name under which the driver configuration will be stored in REEF_BASE_FOLDER/LOCAL_FOLDER

getEvaluatorConfigurationPath

public String getEvaluatorConfigurationPath()

Returns:

the path to the evaluator configuration.

getJarFileSuffix

public String getJarFileSuffix()

Returns:

The suffix used for JAR files, including the "."

getJobFolderPrefix

public String getJobFolderPrefix()

The prefix used whenever REEF is asked to create a job folder, on (H)DFS or locally.

This prefix is also used with JAR files created to represent a job.

getDriverStderrFileName

public String getDriverStderrFileName()

Returns:

The name used within the current working directory of the driver to redirect standard error to.

getDriverStdoutFileName

public String getDriverStdoutFileName()

Returns:

The name used within the current working directory of the driver to redirect standard out to.

getEvaluatorFolderPrefix

public String getEvaluatorFolderPrefix()

Returns:

The prefix used whenever REEF is asked to create an Evaluator folder, e.g. for staging.

getEvaluatorStderrFileName

public String getEvaluatorStderrFileName()

Returns:

The name used within the current working directory of the driver to redirect standard error to.

getEvaluatorStdoutFileName

public String getEvaluatorStdoutFileName()

Returns:

The name used within the current working directory of the driver to redirect standard out to.