AbstractConnectionCreator (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.jdeveloper.db.adapter.AbstractConnectionCreator

All Implemented Interfaces:

ConnectionCreator

Direct Known Subclasses:

AbstractOracleConnCreator, CustomConnectionCreator, DB2ConnectionCreator, DerbyConnectionCreator, MySQLConnectionCreator, ODBCConnectionCreator, SQLiteConnectionCreator, SQLServerConnectionCreator
```
public abstract class AbstractConnectionCreator
extends java.lang.Object
implements ConnectionCreator
```
Abstract implementation of ConnectionCreator that implements getConnection() and creates a connection given the URL and driver class returned by getConnectionURL() and getDriverClassName().

Constructor Summary

Constructors
Constructor and Description

AbstractConnectionCreator()

Constructors
Constructor and Description
`AbstractConnectionCreator()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`allowNullPassword()` Returns false by default if `password` is an allowed property.
`protected java.util.Collection<JDBCParameterInfo>`	`convertToJDBCParameterInfos(java.sql.DriverPropertyInfo[] infos)` Converts the given DriverPropertyInfo objects returned from the JDBC driver into a collection of JDBCParameterInfo objects.
`protected java.util.ResourceBundle`	`getBundle()` Deprecated.
`java.sql.Connection`	`getConnection(java.util.Properties props)` Default implementation uses the standard properties for username and password, and the URL and driver class name to create a connection.
`java.lang.String`	`getConnectionURL(java.util.Properties props)` The default implementation on this abstract class return the DatabaseProvider.DRIVER_CLASS_REFTYPE property.
`protected java.sql.Driver`	`getDriver(java.util.Properties props)` Gets the Driver instance used to connect for the given connection properties.
`java.lang.String`	`getDriverClassName(java.util.Properties props)` The default implementation on this class returns the DatabaseProvider.CUSTOM_URL_CLASS_REFTYPE property.
`protected java.lang.String`	`getInvalidURLMessage()` Gets the translated message to use for the SQLException thrown when the DriverManager returns no connection, signifying that the URL was not valid.
`java.util.Properties`	`getJDBCProperties(java.util.Properties props)` Gets the full set of properties used to create the connection.
`protected java.util.logging.Logger`	`getLogger()` Gets a Logger implementation to log messages to for this ConnectionCreator.
`protected java.lang.String`	`getPropertyOrThrow(java.util.Properties props, java.lang.String name)` Utility method to retrieve a property from the given Properties and throw an exception is the property is missing or empty.
`protected boolean`	`hasLength(java.lang.String s)` Utility method to check a string isn't null or empty.
`boolean`	`isPassword(java.lang.String propName)` Tests whether the given property name is a password, and therefore the value should never be shown to the user.
`java.util.Collection<java.lang.String>`	`listAllowedProperties()` Gets a list of the properties that are relevant to this creator.
`java.util.Collection<JDBCParameterInfo>`	`listJDBCParameterInfos(java.util.Properties connProperties)` Lists the information for jdbc parameters that are associated with the given connection.
`java.util.Collection<java.lang.String>`	`listRequiredProperties()` Gets a list of the properties that are required for this creator to be able to create a connection.
`protected java.sql.Driver`	`loadDriver(java.lang.String driverClassName)` Loads the given driver class using the registered DatabaseProviderClassLoaderFactory.
`protected void`	`setCustomProperties(java.util.Properties connProps, java.util.Properties jdbcProps)` Override to include connection type specific properties in the jdbc properties set that the driver will be created with.
`boolean`	`shouldEncrypt(java.lang.String propName)` Indicates to the core getReference() logic whether a given property name should be encrypted when persisting or not.
`boolean`	`shouldPromptForPassword(java.util.Properties props)` By default the password is prompted for if `password` is an allowed property, it is not set and a null password is not alloewd, and `save password` is set to false.
`boolean`	`shouldSave(java.lang.String propName, DatabaseProvider pro)` Tests whether the given property be "saved" - i.e.
`protected void`	`throwMissingPropertyException(java.lang.String name)` Throws a SQLException for a missing property that is required in order to create a connection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractConnectionCreator
```
public AbstractConnectionCreator()
```
- Method Detail
  - getBundle
```
@Deprecated
protected java.util.ResourceBundle getBundle()
```
    Deprecated.
  - getLogger
```
protected java.util.logging.Logger getLogger()
```
    Gets a Logger implementation to log messages to for this ConnectionCreator. By default this returns the generic db-ca Logger.
  - shouldEncrypt
```
public boolean shouldEncrypt(java.lang.String propName)
```
    Indicates to the core getReference() logic whether a given property name should be encrypted when persisting or not.
    By default only the password, and any SSH credentials, are encrypted.
    
    Specified by:
    
    shouldEncrypt in interface ConnectionCreator
    
    Returns:
    
    true if the given property should not be stored as plain text
  - isPassword
```
public boolean isPassword(java.lang.String propName)
```
    Tests whether the given property name is a password, and therefore the value should never be shown to the user. This is separate to ConnectionCreator.shouldEncrypt(java.lang.String), as non-password values might still be encrypted (e.g. a username).
    By default this returns true for anything that is encrypted, except for the SSH username.
    
    Specified by:
    
    isPassword in interface ConnectionCreator
    
    Returns:
    
    true if the given property should not be stored as plain text
  - shouldSave
```
public boolean shouldSave(java.lang.String propName,
                          DatabaseProvider pro)
```
    Tests whether the given property be "saved" - i.e. included in a RefAddr when a Referenceable is created. By default DatabaseProvider.PASSWORD_CLASS_REFTYPE is not saved if DatabaseProvider.SAVE_PASSWORD_CLASS_REFTYPE is "false".
    
    Specified by:
    
    shouldSave in interface ConnectionCreator
    
    Parameters:
    
    propName - the name of the property to test
    
    pro - the connection definition
    
    Returns:
    
    true if the property should be saved
  - shouldPromptForPassword
```
public boolean shouldPromptForPassword(java.util.Properties props)
```
    By default the password is prompted for if password is an allowed property, it is not set and a null password is not alloewd, and save password is set to false.
    
    Specified by:
    
    shouldPromptForPassword in interface ConnectionCreator
    
    Parameters:
    
    props - the connection details that might need a password prompted for
    
    Returns:
    
    whether to show the prompter
    
    See Also:
    
    listAllowedProperties(), allowNullPassword()
  - setCustomProperties
```
protected void setCustomProperties(java.util.Properties connProps,
                                   java.util.Properties jdbcProps)
```
    Override to include connection type specific properties in the jdbc properties set that the driver will be created with.
    Username, password and role are done by default by this abstract creator.
    
    Parameters:
    
    connProps - the connection properties defined in the connection definition.
    
    jdbcProps - the properties that will be used to create the JDBC connection
  - getJDBCProperties
```
public final java.util.Properties getJDBCProperties(java.util.Properties props)
                                             throws java.sql.SQLException
```
    Description copied from interface: ConnectionCreator
    
    Gets the full set of properties used to create the connection. When set this will include the username and password. The returned map is used to connect along with the connection URL.
    
    Specified by:
    
    getJDBCProperties in interface ConnectionCreator
    
    Parameters:
    
    props - the properties from the underlying DatabaseProvider connection definition
    
    Returns:
    
    the jdbc info properties for this connection
    
    Throws:
    
    java.sql.SQLException - if a valid set of properties cannot be created from the given props.
  - getConnection
```
public java.sql.Connection getConnection(java.util.Properties props)
                                  throws java.sql.SQLException
```
    Default implementation uses the standard properties for username and password, and the URL and driver class name to create a connection. It also honours any extra parameters provided as well.
    When loading the JDBC driver class a ClassLoader for the class is searched for in the following order (if any ClassLoader loads the Class it is used, otherwise the next in the list is tested):
    1. If a DatabaseProviderClassLoaderFactory is registered, that is asked to find a ClassLoader first.
    2. The context ClassLoader - Thread.currentThread().getContextClassLoader()
    3. The ClassLoader for this class (if this ConnectionCreator implementation is provided by a separate OSGI bundle this will be the ClassLoader for that bundle).
    4. The ClassLoader for this DatabaseProvider.class (if different to 3)
    5. The system ClassLoader - ClassLoader.getSystemClassLoader()
    Specified by:
    
    getConnection in interface ConnectionCreator
    
    Parameters:
    
    props - the properties from the underlying DatabaseProvider connection definition
    
    Returns:
    
    a JDBC Connection to a database
    
    Throws:
    
    java.sql.SQLException - if the connection cannot be created because the data is wrong or the database is down.
    
    See Also:
    
    getConnectionURL(Properties), getDriverClassName(Properties)
  - getInvalidURLMessage
```
protected java.lang.String getInvalidURLMessage()
```
    Gets the translated message to use for the SQLException thrown when the DriverManager returns no connection, signifying that the URL was not valid.
  - allowNullPassword
```
protected boolean allowNullPassword()
```
    Returns false by default if password is an allowed property.
    
    See Also:
    
    listAllowedProperties()
  - hasLength
```
protected final boolean hasLength(java.lang.String s)
```
    Utility method to check a string isn't null or empty.
  - getPropertyOrThrow
```
protected final java.lang.String getPropertyOrThrow(java.util.Properties props,
                                                    java.lang.String name)
                                             throws java.sql.SQLException
```
    Utility method to retrieve a property from the given Properties and throw an exception is the property is missing or empty.
    
    Throws:
    
    java.sql.SQLException
  - throwMissingPropertyException
```
protected final void throwMissingPropertyException(java.lang.String name)
                                            throws java.sql.SQLException
```
    Throws a SQLException for a missing property that is required in order to create a connection.
    
    Parameters:
    
    name - the name of the missing property
    
    Throws:
    
    java.sql.SQLException
  - getConnectionURL
```
public java.lang.String getConnectionURL(java.util.Properties props)
                                  throws java.sql.SQLException
```
    The default implementation on this abstract class return the DatabaseProvider.DRIVER_CLASS_REFTYPE property. Override as appropriate.
    
    Specified by:
    
    getConnectionURL in interface ConnectionCreator
    
    Parameters:
    
    props - the properties from the underlying DatabaseProvider connection definition
    
    Returns:
    
    the jdbc url for this connection
    
    Throws:
    
    java.sql.SQLException - if a valid connection URL cannot be created with the given props.
  - getDriverClassName
```
public java.lang.String getDriverClassName(java.util.Properties props)
                                    throws java.sql.SQLException
```
    The default implementation on this class returns the DatabaseProvider.CUSTOM_URL_CLASS_REFTYPE property. Override as appropraite.
    
    Specified by:
    
    getDriverClassName in interface ConnectionCreator
    
    Throws:
    
    java.sql.SQLException
  - getDriver
```
protected java.sql.Driver getDriver(java.util.Properties props)
                             throws java.sql.SQLException
```
    Gets the Driver instance used to connect for the given connection properties.
    
    Throws:
    
    java.sql.SQLException
  - loadDriver
```
protected java.sql.Driver loadDriver(java.lang.String driverClassName)
                              throws java.sql.SQLException
```
    Loads the given driver class using the registered DatabaseProviderClassLoaderFactory.
    
    Parameters:
    
    driverClassName - the name of the driver to load
    
    Returns:
    
    the loaded driver
    
    Throws:
    
    java.sql.SQLException
  - listAllowedProperties
```
public java.util.Collection<java.lang.String> listAllowedProperties()
```
    Description copied from interface: ConnectionCreator
    
    Gets a list of the properties that are relevant to this creator. If a property is not listed, it is not needed/supported.
    
    Specified by:
    
    listAllowedProperties in interface ConnectionCreator
    
    Returns:
    
    a list of the allowed property keys for the connection's properties.
    
    See Also:
    
    ConnectionCreator.listRequiredProperties()
  - listRequiredProperties
```
public java.util.Collection<java.lang.String> listRequiredProperties()
```
    Description copied from interface: ConnectionCreator
    
    Gets a list of the properties that are required for this creator to be able to create a connection. If a property is not listed, it can be missing/null. Note that when a custom URL is provided, only username, password, role and driver class are considered from this list.
    DatabaseProvider.SUBTYPE_CLASS_REFTYPE is always implicitly required, it does not need to be included in this list.
    
    Specified by:
    
    listRequiredProperties in interface ConnectionCreator
    
    Returns:
    
    a list of the required property names in order to be able to create a connection.
    
    See Also:
    
    ConnectionCreator.listAllowedProperties()
  - listJDBCParameterInfos
```
public java.util.Collection<JDBCParameterInfo> listJDBCParameterInfos(java.util.Properties connProperties)
                                                               throws java.sql.SQLException
```
    Description copied from interface: ConnectionCreator
    
    Lists the information for jdbc parameters that are associated with the given connection. These can be used to suggest parameter names and values to the user.
    These parameters are supported by the DatabaseProvider.PARAMETERS_CLASS_REFTYPE property, and do not include any properties that we test separately in this layer via the connection properties (like user and password).
    
    Specified by:
    
    listJDBCParameterInfos in interface ConnectionCreator
    
    Parameters:
    
    connProperties - the connection properties to get the parameter information for
    
    Throws:
    
    java.sql.SQLException
  - convertToJDBCParameterInfos
```
protected java.util.Collection<JDBCParameterInfo> convertToJDBCParameterInfos(java.sql.DriverPropertyInfo[] infos)
```
    Converts the given DriverPropertyInfo objects returned from the JDBC driver into a collection of JDBCParameterInfo objects.
    
    Parameters:
    
    infos - the infos from the Driver
    
    Returns:
    
    a list of our wrapper JDBCParameterInfo classes

Class AbstractConnectionCreator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractConnectionCreator

Method Detail

getBundle

getLogger

shouldEncrypt

isPassword

shouldSave

shouldPromptForPassword

setCustomProperties

getJDBCProperties

getConnection

getInvalidURLMessage

allowNullPassword

hasLength

getPropertyOrThrow

throwMissingPropertyException

getConnectionURL

getDriverClassName

getDriver

loadDriver

listAllowedProperties

listRequiredProperties

listJDBCParameterInfos

convertToJDBCParameterInfos