oracle.jdeveloper.db.adapter

Class AbstractConnectionCreator

java.lang.Object

oracle.jdeveloper.db.adapter.AbstractConnectionCreator

All Implemented Interfaces:

ConnectionCreator

Direct Known Subclasses:

AbstractOracleConnCreator, CustomConnectionCreator, DB2ConnectionCreator, 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()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	allowNullPassword() Returns false by default if password is an allowed property.
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.
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.
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.
java.util.Collection<java.lang.String>	listAllowedProperties() Gets a list of the properties that are relevant to this creator.
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) By default only the password ( DatabaseProvider.PASSWORD_CLASS_REFTYPE ) is encrypted.
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.

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.

shouldEncrypt

public boolean shouldEncrypt(java.lang.String propName)

By default only the password ( DatabaseProvider.PASSWORD_CLASS_REFTYPE ) is encrypted.

Specified by:

shouldEncrypt in interface ConnectionCreator

Returns:

true if the given property should not be stored as plain text

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

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.

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 containing the connection data

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 boolean hasLength(java.lang.String s)

Utility method to check a string isn't null or empty.

getPropertyOrThrow

protected 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

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

Throws:

java.sql.SQLException

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

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.