Package org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher

Class ContainerLaunch.ShellScriptBuilder

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch.ShellScriptBuilder

Enclosing class:

ContainerLaunch

public abstract static class ContainerLaunch.ShellScriptBuilder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ENV_PRELAUNCH_STDERR
protected static java.lang.String	ENV_PRELAUNCH_STDOUT

Constructor Summary

Constructors

Constructor	Description
ShellScriptBuilder()

Method Summary

Modifier and Type	Method	Description
protected void	buildCommand(java.lang.String... command)
abstract void	command(java.util.List<java.lang.String> command)
abstract void	copyDebugInformation(org.apache.hadoop.fs.Path src, org.apache.hadoop.fs.Path dst)	Method to copy files that are useful for debugging container failures.
static ContainerLaunch.ShellScriptBuilder	create()
static ContainerLaunch.ShellScriptBuilder	create(org.apache.hadoop.util.Shell.OSType osType)
abstract void	echo(java.lang.String echoStr)
abstract void	env(java.lang.String key, java.lang.String value)
java.util.Set<java.lang.String>	getEnvDependencies(java.lang.String envVal)	Parse an environment value and returns all environment keys it uses.
protected void	line(java.lang.String... command)
protected void	linebreak(java.lang.String... command)
protected abstract void	link(org.apache.hadoop.fs.Path src, org.apache.hadoop.fs.Path dst)
abstract void	listDebugInformation(org.apache.hadoop.fs.Path output)	Method to dump debug information to a target file.
protected abstract void	mkdir(org.apache.hadoop.fs.Path path)
java.util.Map<java.lang.String,java.lang.String>	orderEnvByDependencies(java.util.Map<java.lang.String,java.lang.String> envs)	Returns a dependency ordered version of envs.
void	setExitOnFailure()
protected abstract void	setStdErr(org.apache.hadoop.fs.Path stdout)
protected abstract void	setStdOut(org.apache.hadoop.fs.Path stdout)
void	stderr(org.apache.hadoop.fs.Path stderrDir, java.lang.String stdErrFile)	Set stderr for the shell script
void	stdout(org.apache.hadoop.fs.Path stdoutDir, java.lang.String stdOutFile)	Set stdout for the shell script
void	symlink(org.apache.hadoop.fs.Path src, org.apache.hadoop.fs.Path dst)
java.lang.String	toString()
abstract void	whitelistedEnv(java.lang.String key, java.lang.String value)
void	write(java.io.PrintStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ENV_PRELAUNCH_STDOUT

protected static final java.lang.String ENV_PRELAUNCH_STDOUT

See Also:

Constant Field Values

ENV_PRELAUNCH_STDERR

protected static final java.lang.String ENV_PRELAUNCH_STDERR

See Also:

Constant Field Values

Constructor Detail

ShellScriptBuilder

public ShellScriptBuilder()

Method Detail

create

public static ContainerLaunch.ShellScriptBuilder create()

create

@VisibleForTesting
public static ContainerLaunch.ShellScriptBuilder create(org.apache.hadoop.util.Shell.OSType osType)

command

public abstract void command(java.util.List<java.lang.String> command)
                      throws java.io.IOException

Throws:

java.io.IOException

stdout

public final void stdout(org.apache.hadoop.fs.Path stdoutDir,
                         java.lang.String stdOutFile)
                  throws java.io.IOException

Set stdout for the shell script

Parameters:

stdoutDir - stdout must be an absolute path

stdOutFile - stdout file name

Throws:

java.io.IOException - thrown when stdout path is not absolute

stderr

public final void stderr(org.apache.hadoop.fs.Path stderrDir,
                         java.lang.String stdErrFile)
                  throws java.io.IOException

Set stderr for the shell script

Parameters:

stderrDir - stderr must be an absolute path

stdErrFile - stderr file name

Throws:

java.io.IOException - thrown when stderr path is not absolute

setStdOut

protected abstract void setStdOut(org.apache.hadoop.fs.Path stdout)
                           throws java.io.IOException

Throws:

java.io.IOException

setStdErr

protected abstract void setStdErr(org.apache.hadoop.fs.Path stdout)
                           throws java.io.IOException

Throws:

java.io.IOException

env

public abstract void env(java.lang.String key,
                         java.lang.String value)
                  throws java.io.IOException

Throws:

java.io.IOException

whitelistedEnv

public abstract void whitelistedEnv(java.lang.String key,
                                    java.lang.String value)
                             throws java.io.IOException

Throws:

java.io.IOException

echo

public abstract void echo(java.lang.String echoStr)
                   throws java.io.IOException

Throws:

java.io.IOException

symlink

public final void symlink(org.apache.hadoop.fs.Path src,
                          org.apache.hadoop.fs.Path dst)
                   throws java.io.IOException

Throws:

java.io.IOException

copyDebugInformation

public abstract void copyDebugInformation(org.apache.hadoop.fs.Path src,
                                          org.apache.hadoop.fs.Path dst)
                                   throws java.io.IOException

Method to copy files that are useful for debugging container failures. This method will be called by ContainerExecutor when setting up the container launch script. The method should take care to make sure files are read-able by the yarn user if the files are to undergo log-aggregation.

Parameters:

src - path to the source file

dst - path to the destination file - should be absolute

Throws:

java.io.IOException

listDebugInformation

public abstract void listDebugInformation(org.apache.hadoop.fs.Path output)
                                   throws java.io.IOException

Method to dump debug information to a target file. This method will be called by ContainerExecutor when setting up the container launch script.

Parameters:

output - the file to which debug information is to be written

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public final void write(java.io.PrintStream out)
                 throws java.io.IOException

Throws:

java.io.IOException

buildCommand

protected final void buildCommand(java.lang.String... command)

linebreak

protected final void linebreak(java.lang.String... command)

line

protected final void line(java.lang.String... command)

setExitOnFailure

public void setExitOnFailure()

link

protected abstract void link(org.apache.hadoop.fs.Path src,
                             org.apache.hadoop.fs.Path dst)
                      throws java.io.IOException

Throws:

java.io.IOException

mkdir

protected abstract void mkdir(org.apache.hadoop.fs.Path path)
                       throws java.io.IOException

Throws:

java.io.IOException

getEnvDependencies

public java.util.Set<java.lang.String> getEnvDependencies(java.lang.String envVal)

Parse an environment value and returns all environment keys it uses.

Parameters:

envVal - an environment variable's value

Returns:

all environment variable names used in envVal.

orderEnvByDependencies

public final java.util.Map<java.lang.String,java.lang.String> orderEnvByDependencies(java.util.Map<java.lang.String,java.lang.String> envs)

Returns a dependency ordered version of envs. Does not alter input envs map.

Parameters:

envs - environment map

Returns:

a dependency ordered version of envs