IJdbcConnectionProvider2 (eu.ralph-schuster.baselib 1.2.5 API)

All Superinterfaces:

IJdbcConnectionProvider

All Known Implementing Classes:

AbstractJdbcConnectionProvider, HyperSqlFileJdbcConnectionProvider, HyperSqlServerJdbcConnectionProvider, MySql5JdbcConnectionProvider
```
public interface IJdbcConnectionProvider2
extends IJdbcConnectionProvider
```
Enhanced IJdbcConnectionProvider which allows more control on connection provider settings.

Author:

ralph

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.
`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`	`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.
`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 `setAdditionalArgumentEnabled(int, boolean)`, `setAdditionalArgumentName(int, String)` and `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.
`void`	`setDbLogin(boolean enabled, String defaultValue)` A shortcut method for `setDbLoginEnabled(boolean)` and `setDefaultDbLogin(String)`.
`void`	`setDbLoginEnabled(boolean b)` Sets whether DB login argument is enabled.
`void`	`setDbName(boolean enabled, String defaultValue)` A shortcut method for `setDbNameEnabled(boolean)` and `setDefaultDbName(String)`.
`void`	`setDbNameEnabled(boolean b)` Sets whether DB name argument is enabled.
`void`	`setDbPassword(boolean enabled, String defaultValue)` A shortcut method for `setDbPasswordEnabled(boolean)` and `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`	`setHost(boolean enabled, String defaultValue)` A shortcut method for `setHostEnabled(boolean)` and `setDefaultHost(String)`.
`void`	`setHostEnabled(boolean b)` Sets whether host argument is enabled.
`void`	`setPort(boolean enabled, String defaultValue)` A shortcut method for `setPortEnabled(boolean)` and `setDefaultPort(String)`.
`void`	`setPortEnabled(boolean b)` Sets whether port argument is enabled.

Methods inherited from interface rs.baselib.sql.IJdbcConnectionProvider
getConnection, getDriverUrl

- Method Detail
  - getHost
```
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.
    
    Parameters:
    s - the string containing an actual host argument
    
    Returns:
    the argument to be used in URL construction
    See Also:
    isHostEnabled(), setHostEnabled(boolean), getDefaultHost(), setDefaultHost(String)
  - isHostEnabled
```
boolean isHostEnabled()
```
    Returns whether host argument is enabled. The information can be used for UI developers to control the input flow.
    
    Returns:
    true when host argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setHostEnabled
```
void setHostEnabled(boolean b)
```
    Sets whether host argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    b - true when host argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setHost
```
void setHost(boolean enabled,
           String defaultValue)
```
    A shortcut method for setHostEnabled(boolean) and setDefaultHost(String).
    
    Parameters:
    enabled - whether to enable host argument
    defaultValue - the default value
  - getDefaultHost
```
String getDefaultHost()
```
    Returns the default host argument to be used when host argument is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultHost
```
void setDefaultHost(String s)
```
    Sets the default host argument to be used when host argument is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getPort
```
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.
    
    Parameters:
    s - the string containing an actual port argument
    
    Returns:
    the argument to be used in URL construction
    See Also:
    isPortEnabled(), setPortEnabled(boolean), getDefaultPort(), setDefaultPort(String)
  - isPortEnabled
```
boolean isPortEnabled()
```
    Returns whether port argument is enabled. The information can be used for UI developers to control the input flow.
    
    Returns:
    true when port argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setPortEnabled
```
void setPortEnabled(boolean b)
```
    Sets whether port argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    b - true when port argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setPort
```
void setPort(boolean enabled,
           String defaultValue)
```
    A shortcut method for setPortEnabled(boolean) and setDefaultPort(String).
    
    Parameters:
    enabled - whether to enable port argument
    defaultValue - the default value
  - getDefaultPort
```
String getDefaultPort()
```
    Returns the default port argument to be used when port argument is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultPort
```
void setDefaultPort(String s)
```
    Sets the default port argument to be used when port argument is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getDbName
```
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.
    
    Parameters:
    s - the string containing an actual DB name argument
    
    Returns:
    the argument to be used in URL construction
    See Also:
    isDbNameEnabled(), setDbNameEnabled(boolean), getDefaultDbName(), setDefaultDbName(String)
  - isDbNameEnabled
```
boolean isDbNameEnabled()
```
    Returns whether DB name argument is enabled. The information can be used for UI developers to control the input flow.
    
    Returns:
    true when dbName argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbNameEnabled
```
void setDbNameEnabled(boolean b)
```
    Sets whether DB name argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    b - true when dbName argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbName
```
void setDbName(boolean enabled,
             String defaultValue)
```
    A shortcut method for setDbNameEnabled(boolean) and setDefaultDbName(String).
    
    Parameters:
    enabled - whether to enable DB name argument
    defaultValue - the default value
  - getDefaultDbName
```
String getDefaultDbName()
```
    Returns the default DB name argument to be used when DB name argument is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultDbName
```
void setDefaultDbName(String s)
```
    Sets the default DB name argument to be used when DB name argument is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getDbLogin
```
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.
    
    Parameters:
    s - the string containing an actual DB login argument
    
    Returns:
    the argument to be used in URL construction
    See Also:
    isDbLoginEnabled(), setDbLoginEnabled(boolean), getDefaultDbLogin(), setDefaultDbLogin(String)
  - isDbLoginEnabled
```
boolean isDbLoginEnabled()
```
    Returns whether DB login argument is enabled. The information can be used for UI developers to control the input flow.
    
    Returns:
    true when dbLogin argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbLoginEnabled
```
void setDbLoginEnabled(boolean b)
```
    Sets whether DB login argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    b - true when dbLogin argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbLogin
```
void setDbLogin(boolean enabled,
              String defaultValue)
```
    A shortcut method for setDbLoginEnabled(boolean) and setDefaultDbLogin(String).
    
    Parameters:
    enabled - whether to enable DB login argument
    defaultValue - the default value
  - getDefaultDbLogin
```
String getDefaultDbLogin()
```
    Returns the default DB login argument to be used when DB login argument is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultDbLogin
```
void setDefaultDbLogin(String s)
```
    Sets the default DB login argument to be used when DB login argument is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getDbPassword
```
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.
    
    Parameters:
    s - the string containing an actual DB password argument
    
    Returns:
    the argument to be used in URL construction
    See Also:
    isDbPasswordEnabled(), setDbPasswordEnabled(boolean), getDefaultDbPassword(), setDefaultDbPassword(String)
  - isDbPasswordEnabled
```
boolean isDbPasswordEnabled()
```
    Returns whether DB password argument is enabled. The information can be used for UI developers to control the input flow.
    
    Returns:
    true when dbPassword argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbPasswordEnabled
```
void setDbPasswordEnabled(boolean b)
```
    Sets whether DB password argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    b - true when dbPassword argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setDbPassword
```
void setDbPassword(boolean enabled,
                 String defaultValue)
```
    A shortcut method for setDbPasswordEnabled(boolean) and setDefaultDbPassword(String).
    
    Parameters:
    enabled - whether to enable DB password argument
    defaultValue - the default value
  - getDefaultDbPassword
```
String getDefaultDbPassword()
```
    Returns the default DB password argument to be used when DB password argument is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultDbPassword
```
void setDefaultDbPassword(String s)
```
    Sets the default DB password argument to be used when DB password argument is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getAdditionalArgument
```
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.
    
    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:
    isAdditionalArgumentEnabled(int), setAdditionalArgumentEnabled(int, boolean), getDefaultAdditionalArgument(int), setDefaultAdditionalArgument(int, String)
  - isAdditionalArgumentEnabled
```
boolean isAdditionalArgumentEnabled(int index)
```
    Returns whether additional argument is enabled. The information can be used for UI developers to control the input flow.
    
    Parameters:
    index - index of additional argument
    
    Returns:
    true when additional argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setAdditionalArgumentEnabled
```
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.
    
    Parameters:
    index - index of additional argument
    b - true when additional argument can be passed to IJdbcConnectionProvider.getConnection(String, String, String, String, String, String...)
  - setAdditionalArgument
```
void setAdditionalArgument(int index,
                         String name,
                         boolean enabled,
                         String defaultValue)
```
    A shortcut method for setAdditionalArgumentEnabled(int, boolean), setAdditionalArgumentName(int, String) and setDefaultAdditionalArgument(int, String).
    
    Parameters:
    index - index of additional argument
    enabled - whether to enable additional argument
    name - name of additional argument
    defaultValue - the default value
  - getDefaultAdditionalArgument
```
String getDefaultAdditionalArgument(int index)
```
    Returns the default additional argument to be used when it is disabled or actual value is empty.
    
    Returns:
    default value
  - setDefaultAdditionalArgument
```
void setDefaultAdditionalArgument(int index,
                                String s)
```
    Sets the default additional argument to be used when it is disabled or actual value is empty.
    
    Parameters:
    s - default value
  - getAdditionalArgumentName
```
String getAdditionalArgumentName(int index)
```
    Returns the name of the additional argument. The name can be used for labels.
    
    Parameters:
    index - index of argument
    
    Returns:
    name of argument
  - setAdditionalArgumentName
```
void setAdditionalArgumentName(int index,
                             String s)
```
    Sets the name of the additional argument. The name can be used for labels.
    
    Parameters:
    index - index of argument
    s - name of argument
  - getAdditionalArgumentNames
```
String[] getAdditionalArgumentNames()
```
    Returns the names of additional arguments.
    
    Returns:
    array of names in order (array is empty when no additional arguments are used)
  - getAdditionalArgumentCount
```
int getAdditionalArgumentCount()
```
    Returns the number of additional arguments this provider knows about.
    
    Returns:
    number of additional arguments

Interface IJdbcConnectionProvider2

Method Summary

Methods inherited from interface rs.baselib.sql.IJdbcConnectionProvider

Method Detail

getHost

isHostEnabled

setHostEnabled

setHost

getDefaultHost

setDefaultHost

getPort

isPortEnabled

setPortEnabled

setPort

getDefaultPort

setDefaultPort

getDbName

isDbNameEnabled

setDbNameEnabled

setDbName

getDefaultDbName

setDefaultDbName

getDbLogin

isDbLoginEnabled

setDbLoginEnabled

setDbLogin

getDefaultDbLogin

setDefaultDbLogin

getDbPassword

isDbPasswordEnabled

setDbPasswordEnabled

setDbPassword

getDefaultDbPassword

setDefaultDbPassword

getAdditionalArgument

isAdditionalArgumentEnabled

setAdditionalArgumentEnabled

setAdditionalArgument

getDefaultAdditionalArgument

setDefaultAdditionalArgument

getAdditionalArgumentName

setAdditionalArgumentName

getAdditionalArgumentNames

getAdditionalArgumentCount