org.apache.samza.sql.client.interfaces

Interface EnvironmentVariableHandler

All Known Implementing Classes:

CliShellEnvironmentVariableHandler, EnvironmentVariableHandlerImpl

public interface EnvironmentVariableHandler

An executor, or shell itself, need to handle environment variables to have their behavior customizable.

Method Summary

Modifier and Type	Method and Description
java.util.List<Pair<java.lang.String,java.lang.String>>	getAllEnvironmentVariables()
java.lang.String	getEnvironmentVariable(java.lang.String name)
EnvironmentVariableSpecs	getSpecs()
int	setEnvironmentVariable(java.lang.String name, java.lang.String value)

Method Detail

setEnvironmentVariable

int setEnvironmentVariable(java.lang.String name,
                           java.lang.String value)

Parameters:

name - Environment variable name

value - Value of the environment variable

Returns:

0 : succeed -1: invalid name -2: invalid value

getEnvironmentVariable

java.lang.String getEnvironmentVariable(java.lang.String name)

Parameters:

name - Environment variable name

Returns:

value of the environment variable. Returns null if the variable doesn't exist.

getAllEnvironmentVariables

java.util.List<Pair<java.lang.String,java.lang.String>> getAllEnvironmentVariables()

Returns:

All environment variables and their value.

getSpecs

EnvironmentVariableSpecs getSpecs()

Returns:

The corresponding EnvironmentVariableSpec.