com.pivotal.gemfirexd.tools.internal

Class ToolsBase

java.lang.Object

com.pivotal.gemfirexd.tools.internal.ToolsBase

Direct Known Subclasses:

GfxdDdlUtils, JarTools, MiscTools

public abstract class ToolsBase
extends Object

Base class for command-line launcher tools. Encapsulates the common connection options used by all the new tools.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ToolsBase.ConnectionOptions Encapsulates values of connection options.
protected static interface	ToolsBase.ProcessCommand Interface to be implemented for processing of a command including adding command specific options, and then processing and executing the command.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTH_PROVIDER
protected static String	BIND_ADDRESS
protected static String	CLIENT_BIND_ADDRESS
protected static String	CLIENT_PORT
protected static String	CONNECTION_URL
protected org.apache.commons.cli.Options	currentOpts
protected static String	EXTRA_CONN_PROPS
protected static String	LOCATORS
protected static String	MCAST_ADDRESS
protected static String	MCAST_PORT
static PrintStream	outputStream
protected static String	PASSWORD
protected static String	SYSTEM_PROPERTY
protected static String	USERNAME

Constructor Summary

Constructors

Constructor and Description
ToolsBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCommonOptions(org.apache.commons.cli.Options opts)
protected void	addConnectionOptions(org.apache.commons.cli.Options opts)
protected org.apache.commons.cli.Options	buildCommandOptions(ToolsBase.ProcessCommand processor)
protected abstract ToolsBase.ProcessCommand	getCommandProcessor(String cmd) Get a processor specific to the provided command.
protected abstract Map<String,String>	getCommandToDescriptionKeyMap() Get the mapping from command-name to its description key that can be used to lookup the localized description string using LocalizedResource.
protected Connection	getConnection(ToolsBase.ConnectionOptions connOpts, String cmd, String cmdDescKey)
protected abstract String	getUsageString(String cmd, String cmdDescKey) Get the usage string (without any formatting etc.) in case of an exception or when explicitly requested.
protected boolean	handleCommonOption(GfxdOption opt, String cmd, String cmdDescKey)
protected boolean	handleConnectionOption(GfxdOption opt, ToolsBase.ConnectionOptions connOpts)
protected void	handleConnectionOptions(ToolsBase.ConnectionOptions connOpts, String cmd, String cmdDescKey)
protected void	invoke(String[] args)
protected void	printUsageExamples(GfxdHelpFormatter formatter, com.gemstone.gemfire.internal.shared.StringPrintWriter pw, int width, String cmd, String cmdDescKey)
protected void	showUsage(String header, String cmd, String cmdDescKey)

Methods inherited from class java.lang.Object

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

Field Detail

currentOpts

protected org.apache.commons.cli.Options currentOpts

outputStream

public static PrintStream outputStream

CONNECTION_URL

protected static final String CONNECTION_URL

CLIENT_PORT

protected static final String CLIENT_PORT

CLIENT_BIND_ADDRESS

protected static final String CLIENT_BIND_ADDRESS

MCAST_PORT

protected static final String MCAST_PORT

MCAST_ADDRESS

protected static final String MCAST_ADDRESS

LOCATORS

protected static final String LOCATORS

BIND_ADDRESS

protected static final String BIND_ADDRESS

AUTH_PROVIDER

protected static final String AUTH_PROVIDER

USERNAME

protected static final String USERNAME

PASSWORD

protected static final String PASSWORD

EXTRA_CONN_PROPS

protected static final String EXTRA_CONN_PROPS

SYSTEM_PROPERTY

protected static final String SYSTEM_PROPERTY

Constructor Detail

ToolsBase

public ToolsBase()

Method Detail

invoke

protected void invoke(String[] args)

buildCommandOptions

protected org.apache.commons.cli.Options buildCommandOptions(ToolsBase.ProcessCommand processor)

showUsage

protected void showUsage(String header,
             String cmd,
             String cmdDescKey)

getCommandToDescriptionKeyMap

protected abstract Map<String,String> getCommandToDescriptionKeyMap()

Get the mapping from command-name to its description key that can be used to lookup the localized description string using LocalizedResource.

getCommandProcessor

protected abstract ToolsBase.ProcessCommand getCommandProcessor(String cmd)

Get a processor specific to the provided command.

getUsageString

protected abstract String getUsageString(String cmd,
                    String cmdDescKey)

Get the usage string (without any formatting etc.) in case of an exception or when explicitly requested.

printUsageExamples

protected void printUsageExamples(GfxdHelpFormatter formatter,
                      com.gemstone.gemfire.internal.shared.StringPrintWriter pw,
                      int width,
                      String cmd,
                      String cmdDescKey)

addConnectionOptions

protected void addConnectionOptions(org.apache.commons.cli.Options opts)

addCommonOptions

protected void addCommonOptions(org.apache.commons.cli.Options opts)

handleCommonOption

protected boolean handleCommonOption(GfxdOption opt,
                         String cmd,
                         String cmdDescKey)
                              throws org.apache.commons.cli.ParseException

Throws:

org.apache.commons.cli.ParseException

handleConnectionOption

protected boolean handleConnectionOption(GfxdOption opt,
                             ToolsBase.ConnectionOptions connOpts)

handleConnectionOptions

protected void handleConnectionOptions(ToolsBase.ConnectionOptions connOpts,
                           String cmd,
                           String cmdDescKey)

getConnection

protected Connection getConnection(ToolsBase.ConnectionOptions connOpts,
                       String cmd,
                       String cmdDescKey)
                            throws SQLException

Throws:

SQLException