org.apache.hadoop.yarn.api

Interface ApplicationConstants

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface ApplicationConstants

This is the API for the applications comprising of constants that YARN sets up for the applications and the containers. TODO: Investigate the semantics and security of each cross-boundary refs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_SUBMIT_TIME_ENV The environment variable for APP_SUBMIT_TIME.
static String	APPLICATION_WEB_PROXY_BASE_ENV The environmental variable for APPLICATION_WEB_PROXY_BASE.
static String	CLASS_PATH_SEPARATOR This constant is used to construct class path and it will be replaced with real class path separator(':' for Linux and ';' for Windows) by NodeManager on container launch.
static String	CONTAINER_TOKEN_FILE_ENV_NAME The cache file into which container token is written
static String	LOG_DIR_EXPANSION_VAR The temporary environmental variable for container log directory.
static String	MAX_APP_ATTEMPTS_ENV The environment variable for MAX_APP_ATTEMPTS.
static String	PARAMETER_EXPANSION_LEFT The following two constants are used to expand parameter and it will be replaced with real parameter expansion marker ('%' for Windows and '$' for Linux) by NodeManager on container launch.
static String	PARAMETER_EXPANSION_RIGHT User has to use this constant to construct class path if user wants cross-platform practice i.e.
static String	STDERR
static String	STDOUT

Field Detail

APP_SUBMIT_TIME_ENV

static final String APP_SUBMIT_TIME_ENV

The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment only

See Also:

Constant Field Values

CONTAINER_TOKEN_FILE_ENV_NAME

static final String CONTAINER_TOKEN_FILE_ENV_NAME

The cache file into which container token is written

See Also:

Constant Field Values

APPLICATION_WEB_PROXY_BASE_ENV

static final String APPLICATION_WEB_PROXY_BASE_ENV

The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in ApplicationMaster's environment only. This states that for all non-relative web URLs in the app masters web UI what base should they have.

See Also:

Constant Field Values

LOG_DIR_EXPANSION_VAR

static final String LOG_DIR_EXPANSION_VAR

The temporary environmental variable for container log directory. This should be replaced by real container log directory on container launch.

See Also:

Constant Field Values

CLASS_PATH_SEPARATOR

@InterfaceAudience.Public
@InterfaceStability.Unstable
static final String CLASS_PATH_SEPARATOR

This constant is used to construct class path and it will be replaced with real class path separator(':' for Linux and ';' for Windows) by NodeManager on container launch. User has to use this constant to construct class path if user wants cross-platform practice i.e. submit an application from a Windows client to a Linux/Unix server or vice versa.

See Also:

Constant Field Values

PARAMETER_EXPANSION_LEFT

@InterfaceAudience.Public
@InterfaceStability.Unstable
static final String PARAMETER_EXPANSION_LEFT

The following two constants are used to expand parameter and it will be replaced with real parameter expansion marker ('%' for Windows and '$' for Linux) by NodeManager on container launch. For example: {{VAR}} will be replaced as $VAR on Linux, and %VAR% on Windows. User has to use this constant to construct class path if user wants cross-platform practice i.e. submit an application from a Windows client to a Linux/Unix server or vice versa.

See Also:

Constant Field Values

PARAMETER_EXPANSION_RIGHT

@InterfaceAudience.Public
@InterfaceStability.Unstable
static final String PARAMETER_EXPANSION_RIGHT

User has to use this constant to construct class path if user wants cross-platform practice i.e. submit an application from a Windows client to a Linux/Unix server or vice versa.

See Also:

Constant Field Values

STDERR

static final String STDERR

See Also:

Constant Field Values

STDOUT

static final String STDOUT

See Also:

Constant Field Values

MAX_APP_ATTEMPTS_ENV

static final String MAX_APP_ATTEMPTS_ENV

The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment only

See Also:

Constant Field Values