Package 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 java.lang.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 Description AbstractJdbcConnectionProvider(java.lang.String display)Constructor.AbstractJdbcConnectionProvider(java.lang.String display, java.lang.String urlTemplate)Constructor.AbstractJdbcConnectionProvider(java.lang.String display, java.lang.String dbDriverClassName, java.lang.String urlTemplate)Constructor. -
Method Summary
Modifier and Type Method Description java.lang.StringgetAdditionalArgument(int index, java.lang.String s)Returns the additional argument to be used for URL construction.intgetAdditionalArgumentCount()Returns the number of additional arguments this provider knows about.java.lang.StringgetAdditionalArgumentName(int index)Returns the name of the additional argument.java.lang.String[]getAdditionalArgumentNames()Returns the names of additional arguments.java.sql.ConnectiongetConnection(java.lang.String host, java.lang.String port, java.lang.String dbName, java.lang.String dbLogin, java.lang.String dbPassword, java.lang.String... addOnArgs)Provide and open the connection for the given arguments.java.lang.StringgetDataSource()Returns the name of theDataSource.java.lang.StringgetDbDriverClassName()Returns the class name of the database driver.java.lang.StringgetDbLogin(java.lang.String s)Returns the DB login argument to be used for URL construction.java.lang.StringgetDbName(java.lang.String s)Returns the DB name argument to be used for URL construction.java.lang.StringgetDbPassword(java.lang.String s)Returns the DB password argument to be used for URL construction.java.lang.StringgetDefaultAdditionalArgument(int index)Returns the default additional argument to be used when it is disabled or actual value is empty.java.lang.StringgetDefaultDbLogin()Returns the default DB login argument to be used when DB login argument is disabled or actual value is empty.java.lang.StringgetDefaultDbName()Returns the default DB name argument to be used when DB name argument is disabled or actual value is empty.java.lang.StringgetDefaultDbPassword()Returns the default DB password argument to be used when DB password argument is disabled or actual value is empty.java.lang.StringgetDefaultHost()Returns the default host argument to be used when host argument is disabled or actual value is empty.java.lang.StringgetDefaultPort()Returns the default port argument to be used when port argument is disabled or actual value is empty.java.lang.StringgetDisplay()Returns a displayable string for users.java.lang.StringgetDriverParameter(java.lang.String name)Returns the value of th edriver parameter.intgetDriverParameterCount()Returns the number of additional driver parameters.java.lang.StringgetDriverParametersString()Returns the URL driver parameter string to be used inurl.java.lang.StringgetDriverUrl(java.lang.String host, java.lang.String port, java.lang.String dbName, java.lang.String dbLogin, java.lang.String dbPassword, java.lang.String... addOnArgs)Constructs the driver's URL from the arguments.java.lang.StringgetHibernateDialect()Returns the dialect to be used by Hibernate.java.lang.StringgetHost(java.lang.String s)Returns the host argument to be used for URL construction.java.lang.StringgetPort(java.lang.String s)Returns the port argument to be used for URL construction.java.lang.StringgetUrlTemplate()Returns theurlTemplate.booleanisAdditionalArgumentEnabled(int index)Returns whether additional argument is enabled.booleanisDbLoginEnabled()Returns whether DB login argument is enabled.booleanisDbNameEnabled()Returns whether DB name argument is enabled.booleanisDbPasswordEnabled()Returns whether DB password argument is enabled.booleanisHostEnabled()Returns whether host argument is enabled.booleanisPortEnabled()Returns whether port argument is enabled.voidsetAdditionalArgument(int index, java.lang.String name, boolean enabled, java.lang.String defaultValue)voidsetAdditionalArgumentEnabled(int index, boolean b)Sets whether additional argument is enabled.voidsetAdditionalArgumentName(int index, java.lang.String s)Sets the name of the additional argument.protected voidsetDataSource(java.lang.String dataSource)Sets thedataSource.voidsetDbLogin(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbLoginEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbLogin(String).voidsetDbLoginEnabled(boolean b)Sets whether DB login argument is enabled.voidsetDbName(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbNameEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbName(String).voidsetDbNameEnabled(boolean b)Sets whether DB name argument is enabled.voidsetDbPassword(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbPasswordEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbPassword(String).voidsetDbPasswordEnabled(boolean b)Sets whether DB password argument is enabled.voidsetDefaultAdditionalArgument(int index, java.lang.String s)Sets the default additional argument to be used when it is disabled or actual value is empty.voidsetDefaultDbLogin(java.lang.String s)Sets the default DB login argument to be used when DB login argument is disabled or actual value is empty.voidsetDefaultDbName(java.lang.String s)Sets the default DB name argument to be used when DB name argument is disabled or actual value is empty.voidsetDefaultDbPassword(java.lang.String s)Sets the default DB password argument to be used when DB password argument is disabled or actual value is empty.voidsetDefaultHost(java.lang.String s)Sets the default host argument to be used when host argument is disabled or actual value is empty.voidsetDefaultPort(java.lang.String s)Sets the default port argument to be used when port argument is disabled or actual value is empty.voidsetDriverParameter(java.lang.String name, java.lang.String value)Sets a driver parameter value or deletes it.voidsetHibernateDialect(java.lang.String hibernateDialect)Sets thehibernateDialect.voidsetHost(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setHostEnabled(boolean)andIJdbcConnectionProvider2.setDefaultHost(String).voidsetHostEnabled(boolean b)Sets whether host argument is enabled.voidsetPort(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setPortEnabled(boolean)andIJdbcConnectionProvider2.setDefaultPort(String).voidsetPortEnabled(boolean b)Sets whether port argument is enabled.
-
Constructor Details
-
AbstractJdbcConnectionProvider
public AbstractJdbcConnectionProvider(java.lang.String display)Constructor. Descendants must overridegetDbDriverClassName()andgetDriverUrl(String, String, String, String, String, String...)for a class.- Parameters:
display- a name to be displayed to users (seeIDisplayProvider)
-
AbstractJdbcConnectionProvider
public AbstractJdbcConnectionProvider(java.lang.String display, java.lang.String urlTemplate)Constructor. Descendants must overridegetDbDriverClassName()for a working class.- Parameters:
display- a name to be displayed to users (seeIDisplayProvider)urlTemplate- the URL template (see class description for details)
-
AbstractJdbcConnectionProvider
public AbstractJdbcConnectionProvider(java.lang.String display, java.lang.String dbDriverClassName, java.lang.String urlTemplate)Constructor.- Parameters:
display- a name to be displayed to users (seeIDisplayProvider)dbDriverClassName- the name of the DB driver (can benullif you overridegetDbDriverClassName())urlTemplate- the URL template (see class description for details)
-
-
Method Details
-
getConnection
public java.sql.Connection getConnection(java.lang.String host, java.lang.String port, java.lang.String dbName, java.lang.String dbLogin, java.lang.String dbPassword, java.lang.String... addOnArgs) throws java.sql.SQLExceptionProvide and open the connection for the given arguments.- Specified by:
getConnectionin interfaceIJdbcConnectionProvider- Parameters:
host- the host of the databaseport- the port of the database (some DB use names as port information)dbName- name of databasedbLogin- database logindbPassword- database passwordaddOnArgs- additional arguments to be processed by the driver- Returns:
- an opened connection if successful
- Throws:
java.sql.SQLException- when the connection cannot be opened
-
getDisplay
public java.lang.String getDisplay()Returns a displayable string for users.- Specified by:
getDisplayin interfaceIDisplayProvider- Returns:
- string
-
getDbDriverClassName
public java.lang.String getDbDriverClassName()Returns the class name of the database driver. The method shall returnnullin case of any errors.- Specified by:
getDbDriverClassNamein interfaceIJdbcConnectionProvider- Returns:
- the dbDriverClassName
-
getUrlTemplate
public java.lang.String getUrlTemplate()Returns theurlTemplate.- Returns:
- the urlTemplate
-
getDriverUrl
public java.lang.String getDriverUrl(java.lang.String host, java.lang.String port, java.lang.String dbName, java.lang.String dbLogin, java.lang.String dbPassword, java.lang.String... addOnArgs)Constructs the driver's URL from the arguments. The method shall returnnullin case of any problems or throw an exception.- Specified by:
getDriverUrlin interfaceIJdbcConnectionProvider- Parameters:
host- the host of the databaseport- the port of the database (some DB use names as port information)dbName- name of databasedbLogin- database logindbPassword- database passwordaddOnArgs- additional arguments for the driver URL- Returns:
- the URL for the driver or
null
-
getDataSource
public java.lang.String getDataSource()Returns the name of theDataSource.- Specified by:
getDataSourcein interfaceIDataSourceProvider- Returns:
- the source
-
setDataSource
protected void setDataSource(java.lang.String dataSource)Sets thedataSource.- Parameters:
dataSource- the dataSource to set
-
getHibernateDialect
public java.lang.String getHibernateDialect()Returns the dialect to be used by Hibernate.- Specified by:
getHibernateDialectin interfaceIHibernateDialectProvider- Returns:
- the name of the dialect class.
-
setHibernateDialect
public void setHibernateDialect(java.lang.String hibernateDialect)Sets thehibernateDialect.- Parameters:
hibernateDialect- the hibernateDialect to set
-
getHost
public java.lang.String getHost(java.lang.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:
getHostin interfaceIJdbcConnectionProvider2- 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:
isHostEnabledin interfaceIJdbcConnectionProvider2- Returns:
truewhenhostargument can be passed toIJdbcConnectionProvider.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:
setHostEnabledin interfaceIJdbcConnectionProvider2- Parameters:
b-truewhenhostargument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setHost
public void setHost(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setHostEnabled(boolean)andIJdbcConnectionProvider2.setDefaultHost(String).- Specified by:
setHostin interfaceIJdbcConnectionProvider2- Parameters:
enabled- whether to enable host argumentdefaultValue- the default value
-
getDefaultHost
public java.lang.String getDefaultHost()Returns the default host argument to be used when host argument is disabled or actual value is empty.- Specified by:
getDefaultHostin interfaceIJdbcConnectionProvider2- Returns:
- default value
-
setDefaultHost
public void setDefaultHost(java.lang.String s)Sets the default host argument to be used when host argument is disabled or actual value is empty.- Specified by:
setDefaultHostin interfaceIJdbcConnectionProvider2- Parameters:
s- default value
-
getPort
public java.lang.String getPort(java.lang.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:
getPortin interfaceIJdbcConnectionProvider2- 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:
isPortEnabledin interfaceIJdbcConnectionProvider2- Returns:
truewhenportargument can be passed toIJdbcConnectionProvider.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:
setPortEnabledin interfaceIJdbcConnectionProvider2- Parameters:
b-truewhenportargument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setPort
public void setPort(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setPortEnabled(boolean)andIJdbcConnectionProvider2.setDefaultPort(String).- Specified by:
setPortin interfaceIJdbcConnectionProvider2- Parameters:
enabled- whether to enable port argumentdefaultValue- the default value
-
getDefaultPort
public java.lang.String getDefaultPort()Returns the default port argument to be used when port argument is disabled or actual value is empty.- Specified by:
getDefaultPortin interfaceIJdbcConnectionProvider2- Returns:
- default value
-
setDefaultPort
public void setDefaultPort(java.lang.String s)Sets the default port argument to be used when port argument is disabled or actual value is empty.- Specified by:
setDefaultPortin interfaceIJdbcConnectionProvider2- Parameters:
s- default value
-
getDbName
public java.lang.String getDbName(java.lang.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:
getDbNamein interfaceIJdbcConnectionProvider2- 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:
isDbNameEnabledin interfaceIJdbcConnectionProvider2- Returns:
truewhendbNameargument can be passed toIJdbcConnectionProvider.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:
setDbNameEnabledin interfaceIJdbcConnectionProvider2- Parameters:
b-truewhendbNameargument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setDbName
public void setDbName(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbNameEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbName(String).- Specified by:
setDbNamein interfaceIJdbcConnectionProvider2- Parameters:
enabled- whether to enable DB name argumentdefaultValue- the default value
-
getDefaultDbName
public java.lang.String getDefaultDbName()Returns the default DB name argument to be used when DB name argument is disabled or actual value is empty.- Specified by:
getDefaultDbNamein interfaceIJdbcConnectionProvider2- Returns:
- default value
-
setDefaultDbName
public void setDefaultDbName(java.lang.String s)Sets the default DB name argument to be used when DB name argument is disabled or actual value is empty.- Specified by:
setDefaultDbNamein interfaceIJdbcConnectionProvider2- Parameters:
s- default value
-
getDbLogin
public java.lang.String getDbLogin(java.lang.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:
getDbLoginin interfaceIJdbcConnectionProvider2- 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:
isDbLoginEnabledin interfaceIJdbcConnectionProvider2- Returns:
truewhendbLoginargument can be passed toIJdbcConnectionProvider.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:
setDbLoginEnabledin interfaceIJdbcConnectionProvider2- Parameters:
b-truewhendbLoginargument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setDbLogin
public void setDbLogin(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbLoginEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbLogin(String).- Specified by:
setDbLoginin interfaceIJdbcConnectionProvider2- Parameters:
enabled- whether to enable DB login argumentdefaultValue- the default value
-
getDefaultDbLogin
public java.lang.String getDefaultDbLogin()Returns the default DB login argument to be used when DB login argument is disabled or actual value is empty.- Specified by:
getDefaultDbLoginin interfaceIJdbcConnectionProvider2- Returns:
- default value
-
setDefaultDbLogin
public void setDefaultDbLogin(java.lang.String s)Sets the default DB login argument to be used when DB login argument is disabled or actual value is empty.- Specified by:
setDefaultDbLoginin interfaceIJdbcConnectionProvider2- Parameters:
s- default value
-
getDbPassword
public java.lang.String getDbPassword(java.lang.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:
getDbPasswordin interfaceIJdbcConnectionProvider2- 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:
isDbPasswordEnabledin interfaceIJdbcConnectionProvider2- Returns:
truewhendbPasswordargument can be passed toIJdbcConnectionProvider.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:
setDbPasswordEnabledin interfaceIJdbcConnectionProvider2- Parameters:
b-truewhendbPasswordargument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setDbPassword
public void setDbPassword(boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setDbPasswordEnabled(boolean)andIJdbcConnectionProvider2.setDefaultDbPassword(String).- Specified by:
setDbPasswordin interfaceIJdbcConnectionProvider2- Parameters:
enabled- whether to enable DB password argumentdefaultValue- the default value
-
getDefaultDbPassword
public java.lang.String getDefaultDbPassword()Returns the default DB password argument to be used when DB password argument is disabled or actual value is empty.- Specified by:
getDefaultDbPasswordin interfaceIJdbcConnectionProvider2- Returns:
- default value
-
setDefaultDbPassword
public void setDefaultDbPassword(java.lang.String s)Sets the default DB password argument to be used when DB password argument is disabled or actual value is empty.- Specified by:
setDefaultDbPasswordin interfaceIJdbcConnectionProvider2- Parameters:
s- default value
-
getAdditionalArgument
public java.lang.String getAdditionalArgument(int index, java.lang.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:
getAdditionalArgumentin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional arguments- 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:
isAdditionalArgumentEnabledin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional argument- Returns:
truewhen additional argument can be passed toIJdbcConnectionProvider.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:
setAdditionalArgumentEnabledin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional argumentb-truewhen additional argument can be passed toIJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
-
setAdditionalArgument
public void setAdditionalArgument(int index, java.lang.String name, boolean enabled, java.lang.String defaultValue)A shortcut method forIJdbcConnectionProvider2.setAdditionalArgumentEnabled(int, boolean),IJdbcConnectionProvider2.setAdditionalArgumentName(int, String)andIJdbcConnectionProvider2.setDefaultAdditionalArgument(int, String).- Specified by:
setAdditionalArgumentin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional argumentname- name of additional argumentenabled- whether to enable additional argumentdefaultValue- the default value
-
getDefaultAdditionalArgument
public java.lang.String getDefaultAdditionalArgument(int index)Returns the default additional argument to be used when it is disabled or actual value is empty.- Specified by:
getDefaultAdditionalArgumentin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional argument- Returns:
- default value
-
setDefaultAdditionalArgument
public void setDefaultAdditionalArgument(int index, java.lang.String s)Sets the default additional argument to be used when it is disabled or actual value is empty.- Specified by:
setDefaultAdditionalArgumentin interfaceIJdbcConnectionProvider2- Parameters:
index- index of additional arguments- default value
-
getAdditionalArgumentName
public java.lang.String getAdditionalArgumentName(int index)Returns the name of the additional argument. The name can be used for labels.- Specified by:
getAdditionalArgumentNamein interfaceIJdbcConnectionProvider2- Parameters:
index- index of argument- Returns:
- name of argument
-
setAdditionalArgumentName
public void setAdditionalArgumentName(int index, java.lang.String s)Sets the name of the additional argument. The name can be used for labels.- Specified by:
setAdditionalArgumentNamein interfaceIJdbcConnectionProvider2- Parameters:
index- index of arguments- name of argument
-
getAdditionalArgumentNames
public java.lang.String[] getAdditionalArgumentNames()Returns the names of additional arguments.- Specified by:
getAdditionalArgumentNamesin interfaceIJdbcConnectionProvider2- 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:
getAdditionalArgumentCountin interfaceIJdbcConnectionProvider2- Returns:
- number of additional arguments
-
getDriverParameterCount
public int getDriverParameterCount()Returns the number of additional driver parameters.- Specified by:
getDriverParameterCountin interfaceIJdbcConnectionProvider2- Returns:
- number of driver parameters.
-
setDriverParameter
public void setDriverParameter(java.lang.String name, java.lang.String value)Sets a driver parameter value or deletes it.- Specified by:
setDriverParameterin interfaceIJdbcConnectionProvider2- Parameters:
name- name of parametervalue- value of parameter ornullif parameter shall be removed
-
getDriverParameter
public java.lang.String getDriverParameter(java.lang.String name)Returns the value of th edriver parameter.- Specified by:
getDriverParameterin interfaceIJdbcConnectionProvider2- Parameters:
name- name of parameter- Returns:
- value of parameter
-
getDriverParametersString
public java.lang.String getDriverParametersString()Returns the URL driver parameter string to be used inurl.- Specified by:
getDriverParametersStringin interfaceIJdbcConnectionProvider2- Returns:
- the parameter string
-