org.apache.samza.sql.client.cli

Class CliEnvironment

java.lang.Object

org.apache.samza.sql.client.cli.CliEnvironment

public class CliEnvironment
extends java.lang.Object

CliEnvironment handles "environment variables" that configures the shell behavior.

Method Summary

Modifier and Type	Method and Description
void	finishInitialization() Gives CliEnvironment a chance to apply settings, especially during initialization, things like making default values take effect
java.util.List<CommandHandler>	getCommandHandlers() retrieves the list of CommandHandlers setup in this environment
java.lang.String	getEnvironmentVariable(java.lang.String name) Gets the value of an environment variable.
SqlExecutor	getExecutor() retrieves the SqlExecutor setup in this environment
java.lang.String[]	getPossibleValues(java.lang.String name) Gets all possible valid values of an environment variable.
void	printAll(java.io.PrintWriter writer) Prints all the environment variables and their values, including both those of Shell and of the Executor.
static void	printVariable(java.io.PrintWriter writer, java.lang.String name, java.lang.String value)
int	setEnvironmentVariable(java.lang.String name, java.lang.String value) Sets the value of an environment variable.

Methods inherited from class java.lang.Object

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

Method Detail

setEnvironmentVariable

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

Sets the value of an environment variable.

Parameters:

name - Environment variable name

value - Value of the environment variable

Returns:

0 : succeed

Throws:

ExecutorException - When user sets an executor but not being able to create

CommandHandlerException - When user sets a CommandHandler but was not created successfully -1: invalid name -2: invalid value

getEnvironmentVariable

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

Gets the value of an environment variable.

Parameters:

name - environment variable name

Returns:

value of the environment variable. Returns null if the variable is not set.

getPossibleValues

public java.lang.String[] getPossibleValues(java.lang.String name)

Gets all possible valid values of an environment variable.

Parameters:

name - environment variable name

Returns:

An array of all possible valid values of the environment variable. Returns null if the environment variable name given is invalid.

printAll

public void printAll(java.io.PrintWriter writer)

Prints all the environment variables and their values, including both those of Shell and of the Executor.

Parameters:

writer - A writer to print to

finishInitialization

public void finishInitialization()
                          throws CliException

Gives CliEnvironment a chance to apply settings, especially during initialization, things like making default values take effect

Throws:

CliException

getExecutor

public SqlExecutor getExecutor()

retrieves the SqlExecutor setup in this environment

Returns:

SqlExecutor

getCommandHandlers

public java.util.List<CommandHandler> getCommandHandlers()

retrieves the list of CommandHandlers setup in this environment

Returns:

List of CommandHandler

printVariable

public static void printVariable(java.io.PrintWriter writer,
                                 java.lang.String name,
                                 java.lang.String value)