com.netflix.genie.agent.utils

Class EnvUtils

java.lang.Object

com.netflix.genie.agent.utils.EnvUtils

public final class EnvUtils
extends java.lang.Object

Utilities for job environment variables.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvUtils.ParseException Exception for parsing errors.
static class	EnvUtils.VariableSubstitutionException Exception for failed variable expansion due to missing value.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	expandShellVariables(java.lang.String inputString, java.util.Map<java.lang.String,java.lang.String> environmentVariablesMap) Performs shell environment variables expansion on the given string.
static java.util.Map<java.lang.String,java.lang.String>	parseEnvFile(java.io.File environmentFile) Parse a file containing shell variable declarations.
static java.util.Map<java.lang.String,java.lang.String>	parseEnvStream(java.io.InputStream inputStream) Parse a file containing shell variable declarations.

Methods inherited from class java.lang.Object

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

Method Detail

parseEnvFile

public static java.util.Map<java.lang.String,java.lang.String> parseEnvFile(java.io.File environmentFile)
                                                                     throws java.io.IOException,
                                                                            EnvUtils.ParseException

Parse a file containing shell variable declarations. Expects all values to be single-quoted. Lines not conforming are silently skipped. Supports multi-line values.

Parameters:

environmentFile - file to parse

Returns:

a map of the values parsed

Throws:

java.io.IOException - if the file cannot be read

EnvUtils.ParseException - if the file contents cannot be parsed

parseEnvStream

public static java.util.Map<java.lang.String,java.lang.String> parseEnvStream(java.io.InputStream inputStream)
                                                                       throws EnvUtils.ParseException

Parse a file containing shell variable declarations. Expects all values to be single-quoted. Lines not conforming are silently skipped. Supports multi-line values.

Parameters:

inputStream - stream to parse

Returns:

a map of the values parsed

Throws:

EnvUtils.ParseException - if the file contents cannot be parsed

expandShellVariables

public static java.lang.String expandShellVariables(java.lang.String inputString,
                                                    java.util.Map<java.lang.String,java.lang.String> environmentVariablesMap)
                                             throws EnvUtils.VariableSubstitutionException

Performs shell environment variables expansion on the given string.

Parameters:

inputString - a string, possibly containing shell variables

environmentVariablesMap - a map of string environment variables

Returns:

a new string with variables expanded

Throws:

EnvUtils.VariableSubstitutionException - if the value for a variable appearing in input is not found in the map