management.cli

Class TestableGfsh

java.lang.Object

org.springframework.shell.event.AbstractShellStatusPublisher

org.springframework.shell.core.AbstractShell

org.springframework.shell.core.JLineShell

com.gemstone.gemfire.management.internal.cli.shell.Gfsh

management.cli.TestableGfsh

All Implemented Interfaces:

java.lang.Runnable, ShellEvent, org.springframework.shell.core.CommandMarker, org.springframework.shell.core.Shell, org.springframework.shell.core.ShellPromptAccessor, org.springframework.shell.event.ShellStatusProvider

public class TestableGfsh
extends com.gemstone.gemfire.management.internal.cli.shell.Gfsh
implements ShellEvent

GfshShell implementation implementing ShellEvent interface

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	EXIT_SHELL_COMMAND
static boolean	useVirtualTerm

Fields inherited from class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

DEFAULT_APP_COLLECTION_LIMIT, DEFAULT_APP_FETCH_SIZE, DEFAULT_APP_LAST_EXIT_STATUS, DEFAULT_APP_QUERY_RESULTS_DISPLAY_MODE, DEFAULT_APP_QUIET_EXECUTION, ENV_APP_COLLECTION_LIMIT, ENV_APP_CONTEXT_PATH, ENV_APP_FETCH_SIZE, ENV_APP_LAST_EXIT_STATUS, ENV_APP_LOG_FILE, ENV_APP_LOGGING_ENABLED, ENV_APP_NAME, ENV_APP_PWD, ENV_APP_QUERY_RESULTS_DISPLAY_MODE, ENV_APP_QUIET_EXECUTION, ENV_SYS_CLASSPATH, ENV_SYS_GEMFIRE_DIR, ENV_SYS_HOST_NAME, ENV_SYS_JAVA_VERSION, ENV_SYS_OS, ENV_SYS_OS_LINE_SEPARATOR, ENV_SYS_USER, ENV_SYS_USER_HOME, GFSH_APP_NAME, gfsherr, gfshout, gfshThreadLocal, LINE_INDENT, LINE_SEPARATOR, SSL_ENABLED_CIPHERS, SSL_ENABLED_PROTOCOLS, SSL_KEYSTORE, SSL_KEYSTORE_PASSWORD, SSL_TRUSTSTORE, SSL_TRUSTSTORE_PASSWORD, SUPPORT_MUTLIPLESHELL

Fields inherited from class org.springframework.shell.core.JLineShell

reader, statusListener

Fields inherited from class org.springframework.shell.core.AbstractShell

completionKeys, exitShellRequest, inBlockComment, logger, ROO_PROMPT, shellPrompt

Fields inherited from class org.springframework.shell.event.AbstractShellStatusPublisher

shellStatus, shellStatusListeners

Fields inherited from interface management.cli.ShellEvent

COMMAND_SEP, EOF, NEW_LINE, TAB

Fields inherited from interface org.springframework.shell.core.Shell

WINDOW_TITLE_SLOT

Constructor Summary

Constructors

Constructor and Description
TestableGfsh(java.lang.String name, boolean launchShell, java.lang.String[] args)

Method Summary

Modifier and Type	Method and Description
ShellEvent	addChars(java.lang.String seq)
void	addCompletorOutput(java.lang.String buffer, java.util.List candidates)
ShellEvent	addCtrlD()
ShellEvent	addCtrlZ()
protected void	addError(java.lang.String string, java.lang.Exception e)
void	addOutput(java.lang.String command, java.lang.Object object)
static java.util.List<java.lang.Object>	autoComplete(TestableGfsh shell, java.lang.String command)
void	clearEvents()
protected jline.ConsoleReader	createConsoleReader()
ShellEvent	end()
void	eof()
static java.lang.Object[]	execAndLogCommand(TestableGfsh shell, java.lang.String command, java.io.PrintWriter commandOutputFile, boolean useFineLevelForLogging)
static java.lang.Object[]	execCommand(TestableGfsh shell, java.lang.String command, java.io.PrintWriter commandOutputFile)
java.util.Map<java.lang.String,java.lang.Object>	getCommandOutput()
static java.lang.String[]	getCommandOutputStrings(TestableGfsh shell)
java.util.Map<java.lang.String,java.util.List>	getCompletorOutput()
java.lang.String	getError()
protected org.springframework.shell.core.ExecutionStrategy	getExecutionStrategy()
java.lang.String	getOutputText()
protected org.springframework.shell.core.Parser	getParser()
java.lang.String	getPlainOutputText()
java.lang.String	getShellName()
protected void	handleExecutionResult(java.lang.Object result)
boolean	hasError()
ShellEvent	newline()
void	notifyDisconnect(java.lang.String endPoints)
void	run() Following code is copied from JLineShell of spring shell to manipulate consoleReader.
void	setTimeout(long timeout)
static void	setVirtualTerminal(boolean yes)
void	stop()
ShellEvent	tab()
void	terminate()
static java.lang.String	toHexString(byte[] array)
void	waitForOutput()

Methods inherited from class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

add, add, executeCommand, executeScript, findResources, getBanner, getCommandNames, getConsoleReader, getCurrentInstance, getDebug, getEnv, getEnvProperty, getGfshConfig, getGfshHistory, getHistoryFileName, getInstance, getLastExecutionStatus, getLogFilePath, getOperationInvoker, getProductName, getPromptText, getSignalHandler, getTerminalHeight, getTerminalWidth, getVersion, getVersion, getWelcomeMessage, interact, isConnectedAndReady, isHeadlessMode, isLoggingEnabled, isQuietMode, logCommandToOutput, logInfo, logSevere, logToFile, logWarning, obtainHelp, obtainHelpCommandNames, print, printAsInfo, printAsSevere, printAsWarning, printBannerAndWelcome, println, println, printlnErr, promptLoop, readWithMask, redirectInternalJavaLoggers, setDebug, setEnvProperty, setLastExecutionStatus, setOperationInvoker, setPromptPath, start, versionInfo, waitForComplete, wrapText

Methods inherited from class org.springframework.shell.core.JLineShell

closeShell, createAnsiWindowsReader, flash, getHistorySize, getHomeAsString, getStartupNotifications, isDevelopmentMode, setDevelopmentMode, setHistorySize, setPromptPath

Methods inherited from class org.springframework.shell.core.AbstractShell

blockCommentBegin, blockCommentFinish, date, executeScriptLine, flashCustom, getExitShellRequest, getHome, getShellPrompt, inlineComment, logCommandIfRequired, props, script, version

Methods inherited from class org.springframework.shell.event.AbstractShellStatusPublisher

addShellStatusListener, getShellStatus, removeShellStatusListener, setShellStatus, setShellStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.shell.core.Shell

getExitShellRequest, getHome

Methods inherited from interface org.springframework.shell.event.ShellStatusProvider

addShellStatusListener, getShellStatus, removeShellStatusListener

Methods inherited from interface org.springframework.shell.core.ShellPromptAccessor

getShellPrompt

Field Detail

EXIT_SHELL_COMMAND

protected static final java.lang.Object EXIT_SHELL_COMMAND

useVirtualTerm

public static boolean useVirtualTerm

Constructor Detail

TestableGfsh

public TestableGfsh(java.lang.String name,
                    boolean launchShell,
                    java.lang.String[] args)
             throws java.lang.ClassNotFoundException,
                    java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

Method Detail

setTimeout

public void setTimeout(long timeout)

setVirtualTerminal

public static void setVirtualTerminal(boolean yes)

addError

protected void addError(java.lang.String string,
                        java.lang.Exception e)

addCompletorOutput

public void addCompletorOutput(java.lang.String buffer,
                               java.util.List candidates)

getExecutionStrategy

protected org.springframework.shell.core.ExecutionStrategy getExecutionStrategy()

Overrides:

getExecutionStrategy in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

createConsoleReader

protected jline.ConsoleReader createConsoleReader()

Overrides:

createConsoleReader in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

run

public void run()

Following code is copied from JLineShell of spring shell to manipulate consoleReader. JLineShell adds its own completorAdaptor. Another addition is using of ThreadLocal for storing Gfsh instead of static singleton instance

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class org.springframework.shell.core.JLineShell

getShellName

public java.lang.String getShellName()

Overrides:

getShellName in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

tab

public ShellEvent tab()
               throws java.io.IOException

Specified by:

tab in interface ShellEvent

Throws:

java.io.IOException

addChars

public ShellEvent addChars(java.lang.String seq)
                    throws java.io.IOException

Specified by:

addChars in interface ShellEvent

Throws:

java.io.IOException

addCtrlZ

public ShellEvent addCtrlZ()
                    throws java.io.IOException

Specified by:

addCtrlZ in interface ShellEvent

Throws:

java.io.IOException

addCtrlD

public ShellEvent addCtrlD()
                    throws java.io.IOException

Specified by:

addCtrlD in interface ShellEvent

Throws:

java.io.IOException

newline

public ShellEvent newline()
                   throws java.io.IOException

Specified by:

newline in interface ShellEvent

Throws:

java.io.IOException

end

public ShellEvent end()

Specified by:

end in interface ShellEvent

eof

public void eof()

Specified by:

eof in interface ShellEvent

terminate

public void terminate()

Specified by:

terminate in interface ShellEvent

stop

public void stop()

Overrides:

stop in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

notifyDisconnect

public void notifyDisconnect(java.lang.String endPoints)

Overrides:

notifyDisconnect in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

getOutputText

public java.lang.String getOutputText()

getPlainOutputText

public java.lang.String getPlainOutputText()

toHexString

public static java.lang.String toHexString(byte[] array)

clearEvents

public void clearEvents()

Specified by:

clearEvents in interface ShellEvent

getCommandOutput

public java.util.Map<java.lang.String,java.lang.Object> getCommandOutput()

getCompletorOutput

public java.util.Map<java.lang.String,java.util.List> getCompletorOutput()

addOutput

public void addOutput(java.lang.String command,
                      java.lang.Object object)

waitForOutput

public void waitForOutput()

Specified by:

waitForOutput in interface ShellEvent

handleExecutionResult

protected void handleExecutionResult(java.lang.Object result)

Overrides:

handleExecutionResult in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

getParser

protected org.springframework.shell.core.Parser getParser()

Overrides:

getParser in class com.gemstone.gemfire.management.internal.cli.shell.Gfsh

hasError

public boolean hasError()

getError

public java.lang.String getError()

autoComplete

public static java.util.List<java.lang.Object> autoComplete(TestableGfsh shell,
                                                            java.lang.String command)

execAndLogCommand

public static java.lang.Object[] execAndLogCommand(TestableGfsh shell,
                                                   java.lang.String command,
                                                   java.io.PrintWriter commandOutputFile,
                                                   boolean useFineLevelForLogging)

execCommand

public static java.lang.Object[] execCommand(TestableGfsh shell,
                                             java.lang.String command,
                                             java.io.PrintWriter commandOutputFile)

getCommandOutputStrings

public static java.lang.String[] getCommandOutputStrings(TestableGfsh shell)