de.esprit.appsuite.database.dbase.clp

Class DatabaseCommandLineParser

java.lang.Object

de.esprit.common.clp.CommandLineParser

de.esprit.appsuite.launch.ApplicationCommandLineParser

de.esprit.appsuite.database.dbase.clp.DatabaseCommandLineParser

Direct Known Subclasses:

AbstractUnlCLP, DBToolCommandLineParser, TableEditCLP

public class DatabaseCommandLineParser
extends ApplicationCommandLineParser

This parser reads special options for building a database Credential from the command line.

Author:

Rainer Buesch

See Also:

getCredential(), Credential

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DatabaseCommandLineParser.OptionCredDir
protected static class	DatabaseCommandLineParser.OptionCredFile
protected static class	DatabaseCommandLineParser.OptionDbPassword
protected static class	DatabaseCommandLineParser.OptionDbUrl
protected static class	DatabaseCommandLineParser.OptionDbUser
protected static class	DatabaseCommandLineParser.OptionJdbcDriver
protected static class	DatabaseCommandLineParser.OptionLoginTimeout
protected static class	DatabaseCommandLineParser.OptionMaxConns
protected static class	DatabaseCommandLineParser.OptionMinConns
protected static class	DatabaseCommandLineParser.OptionSchema

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseCommandLineParser.OptionCredDir	optCredDir
protected DatabaseCommandLineParser.OptionCredFile	optCredFile
protected DatabaseCommandLineParser.OptionJdbcDriver	optDriver
protected DatabaseCommandLineParser.OptionLoginTimeout	optLoginTimeout
protected DatabaseCommandLineParser.OptionMaxConns	optMaxConns
protected DatabaseCommandLineParser.OptionMinConns	optMinConns
protected DatabaseCommandLineParser.OptionDbPassword	optPassword
protected DatabaseCommandLineParser.OptionSchema	optSchema
protected DatabaseCommandLineParser.OptionDbUrl	optUrl
protected DatabaseCommandLineParser.OptionDbUser	optUser

Fields inherited from class de.esprit.appsuite.launch.ApplicationCommandLineParser

optApplicationName

Fields inherited from class de.esprit.common.clp.CommandLineParser

espritVersion, optDebug, optDemo, optHelp, optLocale, optLogDir, optLogToFile, optNoConsole, optTest, optVerbose, optVersion

Constructor Summary

Constructors

Constructor and Description
DatabaseCommandLineParser(java.lang.Class mainClass, java.lang.String... args)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkForMissingCredentialOptions()
protected void	checkForMissingOption(CommandLineOption option)
protected DatabaseConfig	createConfig() May be overridden to return a specific ApplicationConfig derivation which contains all data extracted from the command line.
DBConnectionPool	getConnectionPool() Returns a ConnectionPool which is initialized according to the Credential information found in the command line.
java.io.File	getCredDir() Returns the argument of the -credDir option which indicates the base directory where credentials are stored.
Credential	getCredential() Asks for the command line parameter -credFile and returns a credential read from the given credential file.
Credential	getCredential(Credential defaultCred) Same as getCredential() but returns the defaultCred if the credential could not be created from the command line.
java.io.File	getCredFile() Returns the argument of the -credFile option which indicates the file that contains the credential information.
java.lang.String	getDriver()
int	getLoginTimeout()
int	getMaxConns()
int	getMinConns()
java.lang.String	getPassword()
java.lang.String	getSchema()
java.lang.String	getUrl()
java.lang.String	getUser()

Methods inherited from class de.esprit.appsuite.launch.ApplicationCommandLineParser

getApplicationName, getConfig, isPrintVersionOnly, setDefaultApplicationName

Methods inherited from class de.esprit.common.clp.CommandLineParser

addOption, addOption, addSoftwareVersion, checkDependencies, createHelpText, createHelpText, createOptionList, createSyntaxLine, ensureParsed, fetchDefinedOptionFor, findDefinedOptionFor, getArgument, getArgumentCount, getArguments, getCustomVersion, getEspritVersion, getLogDir, getMainClass, getSoftwareVersions, getStartLogLevel, handleParsingError, hasArguments, isDebug, isDemoMode, isExitAfterParsing, isLogToFile, isNoConsoleLog, isParsed, isTestMode, isVerbose, parse, removeOption, removeOption

Methods inherited from class java.lang.Object

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

Field Detail

optCredDir

protected final DatabaseCommandLineParser.OptionCredDir optCredDir

optCredFile

protected final DatabaseCommandLineParser.OptionCredFile optCredFile

optDriver

protected final DatabaseCommandLineParser.OptionJdbcDriver optDriver

optUrl

protected final DatabaseCommandLineParser.OptionDbUrl optUrl

optUser

protected final DatabaseCommandLineParser.OptionDbUser optUser

optPassword

protected final DatabaseCommandLineParser.OptionDbPassword optPassword

optMinConns

protected final DatabaseCommandLineParser.OptionMinConns optMinConns

optMaxConns

protected final DatabaseCommandLineParser.OptionMaxConns optMaxConns

optLoginTimeout

protected final DatabaseCommandLineParser.OptionLoginTimeout optLoginTimeout

optSchema

protected final DatabaseCommandLineParser.OptionSchema optSchema

Constructor Detail

DatabaseCommandLineParser

public DatabaseCommandLineParser(java.lang.Class mainClass,
                         java.lang.String... args)

Method Detail

getLoginTimeout

public int getLoginTimeout()

getDriver

public java.lang.String getDriver()

getUrl

public java.lang.String getUrl()

getUser

public java.lang.String getUser()

getPassword

public java.lang.String getPassword()

getMinConns

public int getMinConns()

getMaxConns

public int getMaxConns()

getCredential

public Credential getCredential()
                         throws java.lang.Exception

Asks for the command line parameter -credFile and returns a credential read from the given credential file. If that fails it asks for the parameters -driver, -dbUrl, -user, -password, -minCons, -maxCons, -loginTimeout, -schema in order to build a Credential of those values. If that fails an Exception is thrown.

Throws:

java.lang.Exception

See Also:

Credential

checkForMissingCredentialOptions

protected void checkForMissingCredentialOptions()
                                         throws CommandLineParsingException

Throws:

CommandLineParsingException

checkForMissingOption

protected final void checkForMissingOption(CommandLineOption option)
                                    throws CommandLineParsingException

Throws:

CommandLineParsingException

getCredential

public Credential getCredential(Credential defaultCred)

Same as getCredential() but returns the defaultCred if the credential could not be created from the command line.

See Also:

Credential

getConnectionPool

public DBConnectionPool getConnectionPool()
                                   throws java.lang.Exception

Returns a ConnectionPool which is initialized according to the Credential information found in the command line.

Throws:

java.lang.Exception

getCredDir

public java.io.File getCredDir()

Returns the argument of the -credDir option which indicates the base directory where credentials are stored. If a -credFile is given then the parent directory of that file is used as the credential base dir.

getCredFile

public java.io.File getCredFile()

Returns the argument of the -credFile option which indicates the file that contains the credential information.

createConfig

protected DatabaseConfig createConfig()
                               throws java.lang.Exception

Description copied from class: ApplicationCommandLineParser

May be overridden to return a specific ApplicationConfig derivation which contains all data extracted from the command line.

Overrides:

createConfig in class ApplicationCommandLineParser

Throws:

java.lang.Exception

getSchema

public java.lang.String getSchema()