com.pivotal.gemfirexd.tools.internal

Class GfxdDdlUtils

java.lang.Object

com.pivotal.gemfirexd.tools.internal.ToolsBase

com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils

public final class GfxdDdlUtils
extends ToolsBase

Command-line launcher class for some of the tools shipped with DdlUtils (avoiding the need to have and use ant for most cases).

Nested Class Summary

Nested classes/interfaces inherited from class com.pivotal.gemfirexd.tools.internal.ToolsBase

ToolsBase.ConnectionOptions, ToolsBase.ProcessCommand

Field Summary

Fields inherited from class com.pivotal.gemfirexd.tools.internal.ToolsBase

AUTH_PROVIDER, BIND_ADDRESS, CLIENT_BIND_ADDRESS, CLIENT_PORT, CONNECTION_URL, currentOpts, EXTRA_CONN_PROPS, LOCATORS, MCAST_ADDRESS, MCAST_PORT, outputStream, PASSWORD, SYSTEM_PROPERTY, USERNAME

Constructor Summary

Constructors

Constructor and Description
GfxdDdlUtils()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBasicConnectionOptions(org.apache.commons.cli.Options opts)
protected void	addCommonOptions(org.apache.commons.cli.Options opts)
protected void	addCommonReadTaskOptions(org.apache.commons.cli.Options opts)
protected void	addCommonTaskOptions(org.apache.commons.cli.Options opts)
protected void	addConnectionOptions(org.apache.commons.cli.Options opts)
protected void	addReplayFailedDMLsOptions(org.apache.commons.cli.Options opts)
protected void	addWriteDataDtdToFileOptions(org.apache.commons.cli.Options opts)
protected void	addWriteDataToDBOptions(org.apache.commons.cli.Options opts)
protected void	addWriteDataToXMLOptions(org.apache.commons.cli.Options opts)
protected void	addWriteSchemaToDBOptions(org.apache.commons.cli.Options opts)
protected void	addWriteSchemaToSQLOptions(org.apache.commons.cli.Options opts)
protected void	addWriteSchemaToXMLOptions(org.apache.commons.cli.Options opts)
protected void	executeReplayFailedDMLs(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteDataDtdToFile(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteDataToDB(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteDataToXML(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteSchemaToDB(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteSchemaToSQL(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected void	executeWriteSchemaToXML(org.apache.commons.cli.CommandLine cmdLine, String cmd, String cmdDescKey)
protected ToolsBase.ProcessCommand	getCommandProcessor(String cmd) Get a processor specific to the provided command.
protected 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 String	getUsageString(String cmd, String cmdDescKey) Get the usage string (without any formatting etc.) in case of an exception or when explicitly requested.
static Map<String,String>	getValidCommands()
protected com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions	handleCommonTaskOption(GfxdOption opt, boolean fromDatabase, com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts) Return a non-null TaskOptions object with the set TaskOptions field if the option is one of those handled by TaskOptions else return null.
protected boolean	handleDataSourceOption(GfxdOption opt, com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.DataSourceOptions dsOpts)
protected org.apache.commons.dbcp.BasicDataSource	handleDataSourceOptions(com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.DataSourceOptions dsOpts, String cmd, String cmdDescKey)
protected String	handleVerbosityOption(GfxdOption opt)
static void	main(String[] args)
protected void	setCommonReadTaskOptions(DatabaseToDdlTask task, com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts)
protected void	setCommonTaskOptions(DatabaseTaskBase task, com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts)

Methods inherited from class com.pivotal.gemfirexd.tools.internal.ToolsBase

buildCommandOptions, getConnection, handleCommonOption, handleConnectionOption, handleConnectionOptions, invoke, printUsageExamples, showUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

GfxdDdlUtils

public GfxdDdlUtils()

Method Detail

main

public static void main(String[] args)

getValidCommands

public static Map<String,String> getValidCommands()

getCommandToDescriptionKeyMap

protected 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.

Specified by:

getCommandToDescriptionKeyMap in class ToolsBase

getCommandProcessor

protected ToolsBase.ProcessCommand getCommandProcessor(String cmd)

Get a processor specific to the provided command.

Specified by:

getCommandProcessor in class ToolsBase

getUsageString

protected String getUsageString(String cmd,
                    String cmdDescKey)

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

Specified by:

getUsageString in class ToolsBase

addWriteSchemaToXMLOptions

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

addWriteSchemaToSQLOptions

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

addWriteDataToXMLOptions

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

addWriteDataDtdToFileOptions

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

addWriteSchemaToDBOptions

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

addWriteDataToDBOptions

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

addReplayFailedDMLsOptions

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

addCommonTaskOptions

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

addCommonReadTaskOptions

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

addCommonOptions

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

Overrides:

addCommonOptions in class ToolsBase

addConnectionOptions

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

Overrides:

addConnectionOptions in class ToolsBase

addBasicConnectionOptions

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

executeWriteSchemaToXML

protected void executeWriteSchemaToXML(org.apache.commons.cli.CommandLine cmdLine,
                           String cmd,
                           String cmdDescKey)
                                throws org.apache.commons.cli.ParseException,
                                       SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeWriteSchemaToSQL

protected void executeWriteSchemaToSQL(org.apache.commons.cli.CommandLine cmdLine,
                           String cmd,
                           String cmdDescKey)
                                throws org.apache.commons.cli.ParseException,
                                       SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeWriteDataToXML

protected void executeWriteDataToXML(org.apache.commons.cli.CommandLine cmdLine,
                         String cmd,
                         String cmdDescKey)
                              throws org.apache.commons.cli.ParseException,
                                     SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeWriteDataDtdToFile

protected void executeWriteDataDtdToFile(org.apache.commons.cli.CommandLine cmdLine,
                             String cmd,
                             String cmdDescKey)
                                  throws org.apache.commons.cli.ParseException,
                                         SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeWriteSchemaToDB

protected void executeWriteSchemaToDB(org.apache.commons.cli.CommandLine cmdLine,
                          String cmd,
                          String cmdDescKey)
                               throws org.apache.commons.cli.ParseException,
                                      SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeReplayFailedDMLs

protected void executeReplayFailedDMLs(org.apache.commons.cli.CommandLine cmdLine,
                           String cmd,
                           String cmdDescKey)
                                throws org.apache.commons.cli.ParseException,
                                       SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

executeWriteDataToDB

protected void executeWriteDataToDB(org.apache.commons.cli.CommandLine cmdLine,
                        String cmd,
                        String cmdDescKey)
                             throws org.apache.commons.cli.ParseException,
                                    SQLException

Throws:

org.apache.commons.cli.ParseException

SQLException

handleDataSourceOption

protected boolean handleDataSourceOption(GfxdOption opt,
                             com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.DataSourceOptions dsOpts)

handleCommonTaskOption

protected com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions handleCommonTaskOption(GfxdOption opt,
                                                                                   boolean fromDatabase,
                                                                                   com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts)
                                                                                        throws org.apache.commons.cli.ParseException

Return a non-null TaskOptions object with the set TaskOptions field if the option is one of those handled by TaskOptions else return null. If incoming taskOpts object is non-null then set the field on that object and return. Note that you cannot just pass back the result of previous invocation since if the current option is not one handled by TaskOptions then a null will be returned even if previous invocation had set the TaskOptions to non-null.

Throws:

org.apache.commons.cli.ParseException

handleVerbosityOption

protected String handleVerbosityOption(GfxdOption opt)

handleDataSourceOptions

protected org.apache.commons.dbcp.BasicDataSource handleDataSourceOptions(com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.DataSourceOptions dsOpts,
                                                              String cmd,
                                                              String cmdDescKey)

setCommonTaskOptions

protected void setCommonTaskOptions(DatabaseTaskBase task,
                        com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts)

setCommonReadTaskOptions

protected void setCommonReadTaskOptions(DatabaseToDdlTask task,
                            com.pivotal.gemfirexd.tools.internal.GfxdDdlUtils.TaskOptions taskOpts)