org.apache.samza.sql.client.interfaces

Class EnvironmentVariableHandlerImpl

java.lang.Object

org.apache.samza.sql.client.interfaces.EnvironmentVariableHandlerImpl

All Implemented Interfaces:

EnvironmentVariableHandler

Direct Known Subclasses:

CliShellEnvironmentVariableHandler

public abstract class EnvironmentVariableHandlerImpl
extends java.lang.Object
implements EnvironmentVariableHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	envVars

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableHandlerImpl()

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()
protected abstract EnvironmentVariableSpecs	initializeEnvironmentVariableSpecs() Subclasses shall override this method to provide with their EnvironmentVariableSpecs
protected boolean	isAcceptUnknowName() Subclasses can override this method if they want to accept environment variables with unknown names.
protected abstract boolean	processEnvironmentVariable(java.lang.String name, java.lang.String value) Subclasses shall override this method to process their settings
int	setEnvironmentVariable(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

envVars

protected java.util.Map<java.lang.String,java.lang.String> envVars

Constructor Detail

EnvironmentVariableHandlerImpl

public EnvironmentVariableHandlerImpl()

Method Detail

setEnvironmentVariable

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

Specified by:

setEnvironmentVariable in interface EnvironmentVariableHandler

Parameters:

name - Environment variable name

value - Value of the environment variable

Returns:

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

getEnvironmentVariable

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

Specified by:

getEnvironmentVariable in interface EnvironmentVariableHandler

Parameters:

name - Environment variable name

Returns:

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

getAllEnvironmentVariables

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

Specified by:

getAllEnvironmentVariables in interface EnvironmentVariableHandler

Returns:

All environment variables and their value.

getSpecs

public EnvironmentVariableSpecs getSpecs()

Specified by:

getSpecs in interface EnvironmentVariableHandler

Returns:

The corresponding EnvironmentVariableSpec.

processEnvironmentVariable

protected abstract boolean processEnvironmentVariable(java.lang.String name,
                                                      java.lang.String value)

Subclasses shall override this method to process their settings

Parameters:

name - name of the environment variable

value - value of the environment variable

Returns:

succeed or not

initializeEnvironmentVariableSpecs

protected abstract EnvironmentVariableSpecs initializeEnvironmentVariableSpecs()

Subclasses shall override this method to provide with their EnvironmentVariableSpecs

Returns:

An object of EnvironmentVariableSpecs

isAcceptUnknowName

protected boolean isAcceptUnknowName()

Subclasses can override this method if they want to accept environment variables with unknown names. When an executor is not able to go through all the valid configurations it can use this method as a temporary workaround.

Returns:

true if environment variables with unknown names are acceptable. This method returns false by default.