rs.baselib.sql

Class AbstractJdbcConnectionProvider

java.lang.Object

rs.baselib.sql.AbstractJdbcConnectionProvider

All Implemented Interfaces:

IDataSourceProvider, IHibernateDialectProvider, IJdbcConnectionProvider, IJdbcConnectionProvider2, IDisplayProvider

Direct Known Subclasses:

HyperSqlFileJdbcConnectionProvider, HyperSqlServerJdbcConnectionProvider, MySql5JdbcConnectionProvider

public abstract class AbstractJdbcConnectionProvider
extends Object
implements IJdbcConnectionProvider2, IDisplayProvider, IDataSourceProvider, IHibernateDialectProvider

Abstract implementation for JdbcConnectionProviders. The implementation already takes care of most purposes. A common usage scenario is to provide a URL template as follows:

    jdbc:mysql://{0}:{1}/{2}
 

The URL template is a format as for MessageFormat with following arguments:

• {0} - DB Host
• {1} - DB Port
• {2} - DB Name
• {3} - DB Login
• {4} - DB Password
• {5}...{n} - Additional arguments (addOnArgs)

Developers can override getDriverUrl(String, String, String, String, String, String...) to accommodate for more sophisticated URL templates.

Clients and developers can control whether each of the arguments is enabled and the default value of an argument. The default implementation will automatically use the default value for an argument when the argument is not enabled or is empty.

Author:

ralph

Constructor Summary

Constructors

Constructor and Description
AbstractJdbcConnectionProvider(String display) Constructor.
AbstractJdbcConnectionProvider(String display, String urlTemplate) Constructor.
AbstractJdbcConnectionProvider(String display, String dbDriverClassName, String urlTemplate) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdditionalArgument(int index, String s) Returns the additional argument to be used for URL construction.
int	getAdditionalArgumentCount() Returns the number of additional arguments this provider knows about.
String	getAdditionalArgumentName(int index) Returns the name of the additional argument.
String[]	getAdditionalArgumentNames() Returns the names of additional arguments.
Connection	getConnection(String host, String port, String dbName, String dbLogin, String dbPassword, String... addOnArgs) Provide and open the connection for the given arguments.
String	getDataSource() Returns the name of the DataSource.
String	getDbDriverClassName() Returns the dbDriverClassName.
String	getDbLogin(String s) Returns the DB login argument to be used for URL construction.
String	getDbName(String s) Returns the DB name argument to be used for URL construction.
String	getDbPassword(String s) Returns the DB password argument to be used for URL construction.
String	getDefaultAdditionalArgument(int index) Returns the default additional argument to be used when it is disabled or actual value is empty.
String	getDefaultDbLogin() Returns the default DB login argument to be used when DB login argument is disabled or actual value is empty.
String	getDefaultDbName() Returns the default DB name argument to be used when DB name argument is disabled or actual value is empty.
String	getDefaultDbPassword() Returns the default DB password argument to be used when DB password argument is disabled or actual value is empty.
String	getDefaultHost() Returns the default host argument to be used when host argument is disabled or actual value is empty.
String	getDefaultPort() Returns the default port argument to be used when port argument is disabled or actual value is empty.
String	getDisplay() Returns a displayable string for users.
String	getDriverUrl(String host, String port, String dbName, String dbLogin, String dbPassword, String... addOnArgs) Constructs the driver's URL from the arguments.
String	getHibernateDialect() Returns the dialect to be used by Hibernate.
String	getHost(String s) Returns the host argument to be used for URL construction.
String	getPort(String s) Returns the port argument to be used for URL construction.
String	getUrlTemplate() Returns the urlTemplate.
boolean	isAdditionalArgumentEnabled(int index) Returns whether additional argument is enabled.
boolean	isDbLoginEnabled() Returns whether DB login argument is enabled.
boolean	isDbNameEnabled() Returns whether DB name argument is enabled.
boolean	isDbPasswordEnabled() Returns whether DB password argument is enabled.
boolean	isHostEnabled() Returns whether host argument is enabled.
boolean	isPortEnabled() Returns whether port argument is enabled.
void	setAdditionalArgument(int index, String name, boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setAdditionalArgumentEnabled(int, boolean), IJdbcConnectionProvider2.setAdditionalArgumentName(int, String) and IJdbcConnectionProvider2.setDefaultAdditionalArgument(int, String).
void	setAdditionalArgumentEnabled(int index, boolean b) Sets whether additional argument is enabled.
void	setAdditionalArgumentName(int index, String s) Sets the name of the additional argument.
protected void	setDataSource(String dataSource) Sets the dataSource.
void	setDbLogin(boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setDbLoginEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbLogin(String).
void	setDbLoginEnabled(boolean b) Sets whether DB login argument is enabled.
void	setDbName(boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setDbNameEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbName(String).
void	setDbNameEnabled(boolean b) Sets whether DB name argument is enabled.
void	setDbPassword(boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setDbPasswordEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbPassword(String).
void	setDbPasswordEnabled(boolean b) Sets whether DB password argument is enabled.
void	setDefaultAdditionalArgument(int index, String s) Sets the default additional argument to be used when it is disabled or actual value is empty.
void	setDefaultDbLogin(String s) Sets the default DB login argument to be used when DB login argument is disabled or actual value is empty.
void	setDefaultDbName(String s) Sets the default DB name argument to be used when DB name argument is disabled or actual value is empty.
void	setDefaultDbPassword(String s) Sets the default DB password argument to be used when DB password argument is disabled or actual value is empty.
void	setDefaultHost(String s) Sets the default host argument to be used when host argument is disabled or actual value is empty.
void	setDefaultPort(String s) Sets the default port argument to be used when port argument is disabled or actual value is empty.
void	setHibernateDialect(String hibernateDialect) Sets the hibernateDialect.
void	setHost(boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setHostEnabled(boolean) and IJdbcConnectionProvider2.setDefaultHost(String).
void	setHostEnabled(boolean b) Sets whether host argument is enabled.
void	setPort(boolean enabled, String defaultValue) A shortcut method for IJdbcConnectionProvider2.setPortEnabled(boolean) and IJdbcConnectionProvider2.setDefaultPort(String).
void	setPortEnabled(boolean b) Sets whether port argument is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJdbcConnectionProvider

public AbstractJdbcConnectionProvider(String display)

Constructor. Descendants must override getDbDriverClassName() and getDriverUrl(String, String, String, String, String, String...) for a class.

Parameters:

display - a name to be displayed to users (see IDisplayProvider)

AbstractJdbcConnectionProvider

public AbstractJdbcConnectionProvider(String display,
                              String urlTemplate)

Constructor. Descendants must override getDbDriverClassName() for a working class.

Parameters:

display - a name to be displayed to users (see IDisplayProvider)

urlTemplate - the URL template (see class description for details)

AbstractJdbcConnectionProvider

public AbstractJdbcConnectionProvider(String display,
                              String dbDriverClassName,
                              String urlTemplate)

Constructor.

Parameters:

display - a name to be displayed to users (see IDisplayProvider)

dbDriverClassName - the name of the DB driver (can be null if you override getDbDriverClassName())

urlTemplate - the URL template (see class description for details)

Method Detail

getConnection

public Connection getConnection(String host,
                       String port,
                       String dbName,
                       String dbLogin,
                       String dbPassword,
                       String... addOnArgs)
                         throws SQLException

Provide and open the connection for the given arguments.

Specified by:

getConnection in interface IJdbcConnectionProvider

Parameters:

host - the host of the database

port - the port of the database (some DB use names as port information)

dbName - name of database

dbLogin - database login

dbPassword - database password

addOnArgs - additional arguments to be processed by the driver

Returns:

an opened connection if successful

Throws:

SQLException - when the connection cannot be opened

getDisplay

public String getDisplay()

Returns a displayable string for users.

Specified by:

getDisplay in interface IDisplayProvider

Returns:

string

getDbDriverClassName

public String getDbDriverClassName()

Returns the dbDriverClassName. The method shall return null in case of any errors.

Returns:

the dbDriverClassName

getUrlTemplate

public String getUrlTemplate()

Returns the urlTemplate.

Returns:

the urlTemplate

getDriverUrl

public String getDriverUrl(String host,
                  String port,
                  String dbName,
                  String dbLogin,
                  String dbPassword,
                  String... addOnArgs)

Constructs the driver's URL from the arguments. The method shall return null in case of any problems or throw an exception.

Specified by:

getDriverUrl in interface IJdbcConnectionProvider

Parameters:

host - the host of the database

port - the port of the database (some DB use names as port information)

dbName - name of database

dbLogin - database login

dbPassword - database password

addOnArgs - additional arguments for the driver URL

Returns:

the URL for the driver or null

getDataSource

public String getDataSource()

Returns the name of the DataSource.

Specified by:

getDataSource in interface IDataSourceProvider

Returns:

the source

setDataSource

protected void setDataSource(String dataSource)

Sets the dataSource.

Parameters:

dataSource - the dataSource to set

getHibernateDialect

public String getHibernateDialect()

Returns the dialect to be used by Hibernate.

Specified by:

getHibernateDialect in interface IHibernateDialectProvider

Returns:

the name of the dialect class.

setHibernateDialect

public void setHibernateDialect(String hibernateDialect)

Sets the hibernateDialect.

Parameters:

hibernateDialect - the hibernateDialect to set

getHost

public String getHost(String s)

Returns the host argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the host argument. This implementation returns the default host when the passed string is either empty or host argument was disabled.

Specified by:

getHost in interface IJdbcConnectionProvider2

Parameters:

s - the string containing an actual host argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isHostEnabled(), IJdbcConnectionProvider2.setHostEnabled(boolean), IJdbcConnectionProvider2.getDefaultHost(), IJdbcConnectionProvider2.setDefaultHost(String)

isHostEnabled

public boolean isHostEnabled()

Returns whether host argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isHostEnabled in interface IJdbcConnectionProvider2

Returns:

true when host argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setHostEnabled

public void setHostEnabled(boolean b)

Sets whether host argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setHostEnabled in interface IJdbcConnectionProvider2

Parameters:

b - true when host argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setHost

public void setHost(boolean enabled,
           String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setHostEnabled(boolean) and IJdbcConnectionProvider2.setDefaultHost(String).

Specified by:

setHost in interface IJdbcConnectionProvider2

Parameters:

enabled - whether to enable host argument

defaultValue - the default value

getDefaultHost

public String getDefaultHost()

Returns the default host argument to be used when host argument is disabled or actual value is empty.

Specified by:

getDefaultHost in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultHost

public void setDefaultHost(String s)

Sets the default host argument to be used when host argument is disabled or actual value is empty.

Specified by:

setDefaultHost in interface IJdbcConnectionProvider2

Parameters:

s - default value

getPort

public String getPort(String s)

Returns the port argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the port argument. This implementation returns the default port when the passed string is either empty or port argument was disabled.

Specified by:

getPort in interface IJdbcConnectionProvider2

Parameters:

s - the string containing an actual port argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isPortEnabled(), IJdbcConnectionProvider2.setPortEnabled(boolean), IJdbcConnectionProvider2.getDefaultPort(), IJdbcConnectionProvider2.setDefaultPort(String)

isPortEnabled

public boolean isPortEnabled()

Returns whether port argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isPortEnabled in interface IJdbcConnectionProvider2

Returns:

true when port argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setPortEnabled

public void setPortEnabled(boolean b)

Sets whether port argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setPortEnabled in interface IJdbcConnectionProvider2

Parameters:

b - true when port argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setPort

public void setPort(boolean enabled,
           String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setPortEnabled(boolean) and IJdbcConnectionProvider2.setDefaultPort(String).

Specified by:

setPort in interface IJdbcConnectionProvider2

Parameters:

enabled - whether to enable port argument

defaultValue - the default value

getDefaultPort

public String getDefaultPort()

Returns the default port argument to be used when port argument is disabled or actual value is empty.

Specified by:

getDefaultPort in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultPort

public void setDefaultPort(String s)

Sets the default port argument to be used when port argument is disabled or actual value is empty.

Specified by:

setDefaultPort in interface IJdbcConnectionProvider2

Parameters:

s - default value

getDbName

public String getDbName(String s)

Returns the DB name argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the DB name argument. This implementation returns the default DB name when the passed string is either empty or DB name argument was disabled.

Specified by:

getDbName in interface IJdbcConnectionProvider2

Parameters:

s - the string containing an actual DB name argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isDbNameEnabled(), IJdbcConnectionProvider2.setDbNameEnabled(boolean), IJdbcConnectionProvider2.getDefaultDbName(), IJdbcConnectionProvider2.setDefaultDbName(String)

isDbNameEnabled

public boolean isDbNameEnabled()

Returns whether DB name argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isDbNameEnabled in interface IJdbcConnectionProvider2

Returns:

true when dbName argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbNameEnabled

public void setDbNameEnabled(boolean b)

Sets whether DB name argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setDbNameEnabled in interface IJdbcConnectionProvider2

Parameters:

b - true when dbName argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbName

public void setDbName(boolean enabled,
             String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setDbNameEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbName(String).

Specified by:

setDbName in interface IJdbcConnectionProvider2

Parameters:

enabled - whether to enable DB name argument

defaultValue - the default value

getDefaultDbName

public String getDefaultDbName()

Returns the default DB name argument to be used when DB name argument is disabled or actual value is empty.

Specified by:

getDefaultDbName in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultDbName

public void setDefaultDbName(String s)

Sets the default DB name argument to be used when DB name argument is disabled or actual value is empty.

Specified by:

setDefaultDbName in interface IJdbcConnectionProvider2

Parameters:

s - default value

getDbLogin

public String getDbLogin(String s)

Returns the DB login argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the DB login argument. This implementation returns the default DB login when the passed string is either empty or DB login argument was disabled.

Specified by:

getDbLogin in interface IJdbcConnectionProvider2

Parameters:

s - the string containing an actual DB login argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isDbLoginEnabled(), IJdbcConnectionProvider2.setDbLoginEnabled(boolean), IJdbcConnectionProvider2.getDefaultDbLogin(), IJdbcConnectionProvider2.setDefaultDbLogin(String)

isDbLoginEnabled

public boolean isDbLoginEnabled()

Returns whether DB login argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isDbLoginEnabled in interface IJdbcConnectionProvider2

Returns:

true when dbLogin argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbLoginEnabled

public void setDbLoginEnabled(boolean b)

Sets whether DB login argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setDbLoginEnabled in interface IJdbcConnectionProvider2

Parameters:

b - true when dbLogin argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbLogin

public void setDbLogin(boolean enabled,
              String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setDbLoginEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbLogin(String).

Specified by:

setDbLogin in interface IJdbcConnectionProvider2

Parameters:

enabled - whether to enable DB login argument

defaultValue - the default value

getDefaultDbLogin

public String getDefaultDbLogin()

Returns the default DB login argument to be used when DB login argument is disabled or actual value is empty.

Specified by:

getDefaultDbLogin in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultDbLogin

public void setDefaultDbLogin(String s)

Sets the default DB login argument to be used when DB login argument is disabled or actual value is empty.

Specified by:

setDefaultDbLogin in interface IJdbcConnectionProvider2

Parameters:

s - default value

getDbPassword

public String getDbPassword(String s)

Returns the DB password argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the DB password argument. This implementation returns the default DB password when the passed string is either empty or DB password argument was disabled.

Specified by:

getDbPassword in interface IJdbcConnectionProvider2

Parameters:

s - the string containing an actual DB password argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isDbPasswordEnabled(), IJdbcConnectionProvider2.setDbPasswordEnabled(boolean), IJdbcConnectionProvider2.getDefaultDbPassword(), IJdbcConnectionProvider2.setDefaultDbPassword(String)

isDbPasswordEnabled

public boolean isDbPasswordEnabled()

Returns whether DB password argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isDbPasswordEnabled in interface IJdbcConnectionProvider2

Returns:

true when dbPassword argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbPasswordEnabled

public void setDbPasswordEnabled(boolean b)

Sets whether DB password argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setDbPasswordEnabled in interface IJdbcConnectionProvider2

Parameters:

b - true when dbPassword argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setDbPassword

public void setDbPassword(boolean enabled,
                 String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setDbPasswordEnabled(boolean) and IJdbcConnectionProvider2.setDefaultDbPassword(String).

Specified by:

setDbPassword in interface IJdbcConnectionProvider2

Parameters:

enabled - whether to enable DB password argument

defaultValue - the default value

getDefaultDbPassword

public String getDefaultDbPassword()

Returns the default DB password argument to be used when DB password argument is disabled or actual value is empty.

Specified by:

getDefaultDbPassword in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultDbPassword

public void setDefaultDbPassword(String s)

Sets the default DB password argument to be used when DB password argument is disabled or actual value is empty.

Specified by:

setDefaultDbPassword in interface IJdbcConnectionProvider2

Parameters:

s - default value

getAdditionalArgument

public String getAdditionalArgument(int index,
                           String s)

Returns the additional argument to be used for URL construction. Descendants can override this method when they have more sophisticated algorithms to determine the additional argument. This implementation returns the default additional argument when the passed string is either empty or the additional argument was disabled.

Specified by:

getAdditionalArgument in interface IJdbcConnectionProvider2

Parameters:

index - index of additional argument

s - the string containing an actual additional argument

Returns:

the argument to be used in URL construction

See Also:

IJdbcConnectionProvider2.isAdditionalArgumentEnabled(int), IJdbcConnectionProvider2.setAdditionalArgumentEnabled(int, boolean), IJdbcConnectionProvider2.getDefaultAdditionalArgument(int), IJdbcConnectionProvider2.setDefaultAdditionalArgument(int, String)

isAdditionalArgumentEnabled

public boolean isAdditionalArgumentEnabled(int index)

Returns whether additional argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

isAdditionalArgumentEnabled in interface IJdbcConnectionProvider2

Parameters:

index - index of additional argument

Returns:

true when additional argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setAdditionalArgumentEnabled

public void setAdditionalArgumentEnabled(int index,
                                boolean b)

Sets whether additional argument is enabled. The information can be used for UI developers to control the input flow.

Specified by:

setAdditionalArgumentEnabled in interface IJdbcConnectionProvider2

Parameters:

index - index of additional argument

b - true when additional argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)

setAdditionalArgument

public void setAdditionalArgument(int index,
                         String name,
                         boolean enabled,
                         String defaultValue)

A shortcut method for IJdbcConnectionProvider2.setAdditionalArgumentEnabled(int, boolean), IJdbcConnectionProvider2.setAdditionalArgumentName(int, String) and IJdbcConnectionProvider2.setDefaultAdditionalArgument(int, String).

Specified by:

setAdditionalArgument in interface IJdbcConnectionProvider2

Parameters:

index - index of additional argument

name - name of additional argument

enabled - whether to enable additional argument

defaultValue - the default value

getDefaultAdditionalArgument

public String getDefaultAdditionalArgument(int index)

Returns the default additional argument to be used when it is disabled or actual value is empty.

Specified by:

getDefaultAdditionalArgument in interface IJdbcConnectionProvider2

Returns:

default value

setDefaultAdditionalArgument

public void setDefaultAdditionalArgument(int index,
                                String s)

Sets the default additional argument to be used when it is disabled or actual value is empty.

Specified by:

setDefaultAdditionalArgument in interface IJdbcConnectionProvider2

s - default value

getAdditionalArgumentName

public String getAdditionalArgumentName(int index)

Returns the name of the additional argument. The name can be used for labels.

Specified by:

getAdditionalArgumentName in interface IJdbcConnectionProvider2

Parameters:

index - index of argument

Returns:

name of argument

setAdditionalArgumentName

public void setAdditionalArgumentName(int index,
                             String s)

Sets the name of the additional argument. The name can be used for labels.

Specified by:

setAdditionalArgumentName in interface IJdbcConnectionProvider2

Parameters:

index - index of argument

s - name of argument

getAdditionalArgumentNames

public String[] getAdditionalArgumentNames()

Returns the names of additional arguments.

Specified by:

getAdditionalArgumentNames in interface IJdbcConnectionProvider2

Returns:

array of names in order (array is empty when no additional arguments are used)

getAdditionalArgumentCount

public int getAdditionalArgumentCount()

Returns the number of additional arguments this provider knows about.

Specified by:

getAdditionalArgumentCount in interface IJdbcConnectionProvider2

Returns:

number of additional arguments