oracle.jdeveloper.db.adapter

Class OracleConnectionCreator

java.lang.Object

oracle.jdeveloper.db.adapter.AbstractConnectionCreator

oracle.jdeveloper.db.adapter.AbstractOracleConnCreator

oracle.jdeveloper.db.adapter.OracleConnectionCreator

All Implemented Interfaces:

ConnectionCreator, SSHConnectionCreator

public class OracleConnectionCreator
extends AbstractOracleConnCreator
implements SSHConnectionCreator

ConnectionCreator for Oracle connections, both thick and thin.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OLD_ORACLE_DRIVER_CLASS
static java.lang.String	ORA_DRIVER_OCI8
static java.lang.String	ORA_DRIVER_THIN
static java.lang.String	ORA_DRIVER_TYPE_CLASS_REFTYPE
static java.lang.String	ORACLE_DRIVER_CLASS
static java.lang.String	SUBTYPE_ORA_JDBC

Constructor Summary

Constructors

Constructor and Description
OracleConnectionCreator()

Method Summary

Modifier and Type	Method and Description
SSHTunnelConfiguration	getConfiguration(DatabaseProvider pro) Gets an SSHTunnelConfiguration (with the url, and the host and port information separate) for the connection details in the given DatabaseProvider.
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.
java.util.Collection<java.lang.String>	listAllowedProperties() Gets a list of the properties that are relevant to this creator.
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.

Methods inherited from class oracle.jdeveloper.db.adapter.AbstractOracleConnCreator

main, setCustomProperties

Methods inherited from class oracle.jdeveloper.db.adapter.AbstractConnectionCreator

allowNullPassword, convertToJDBCParameterInfos, getBundle, getConnection, getDriver, getInvalidURLMessage, getJDBCProperties, getLogger, getPropertyOrThrow, hasLength, isPassword, listJDBCParameterInfos, loadDriver, shouldEncrypt, shouldPromptForPassword, shouldSave, throwMissingPropertyException

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jdeveloper.db.adapter.ConnectionCreator

getConnection, getJDBCProperties, isPassword, listJDBCParameterInfos, shouldEncrypt, shouldPromptForPassword, shouldSave

Field Detail

ORACLE_DRIVER_CLASS

public static final java.lang.String ORACLE_DRIVER_CLASS

See Also:

Constant Field Values

OLD_ORACLE_DRIVER_CLASS

public static final java.lang.String OLD_ORACLE_DRIVER_CLASS

See Also:

Constant Field Values

SUBTYPE_ORA_JDBC

public static final java.lang.String SUBTYPE_ORA_JDBC

See Also:

Constant Field Values

ORA_DRIVER_TYPE_CLASS_REFTYPE

public static final java.lang.String ORA_DRIVER_TYPE_CLASS_REFTYPE

See Also:

Constant Field Values

ORA_DRIVER_THIN

public static final java.lang.String ORA_DRIVER_THIN

See Also:

Constant Field Values

ORA_DRIVER_OCI8

public static final java.lang.String ORA_DRIVER_OCI8

See Also:

Constant Field Values

Constructor Detail

OracleConnectionCreator

public OracleConnectionCreator()

Method Detail

getConnectionURL

public java.lang.String getConnectionURL(java.util.Properties props)
                                  throws java.sql.SQLException

Description copied from class: AbstractConnectionCreator

The default implementation on this abstract class return the DatabaseProvider.DRIVER_CLASS_REFTYPE property. Override as appropriate.

Specified by:

getConnectionURL in interface ConnectionCreator

Overrides:

getConnectionURL in class AbstractConnectionCreator

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

Description copied from class: AbstractConnectionCreator

The default implementation on this class returns the DatabaseProvider.CUSTOM_URL_CLASS_REFTYPE property. Override as appropraite.

Specified by:

getDriverClassName in interface ConnectionCreator

Overrides:

getDriverClassName in class AbstractConnectionCreator

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

Overrides:

listAllowedProperties in class AbstractOracleConnCreator

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

Overrides:

listRequiredProperties in class AbstractConnectionCreator

Returns:

a list of the required property names in order to be able to create a connection.

See Also:

ConnectionCreator.listAllowedProperties()

getConfiguration

public SSHTunnelConfiguration getConfiguration(DatabaseProvider pro)
                                        throws java.sql.SQLException

Description copied from interface: SSHConnectionCreator

Gets an SSHTunnelConfiguration (with the url, and the host and port information separate) for the connection details in the given DatabaseProvider.

Specified by:

getConfiguration in interface SSHConnectionCreator

Parameters:

pro - the connection details

Returns:

the tunnel configuration (must not be null)

Throws:

java.sql.SQLException - if the connection details are not valid and the tunnel configuration cannot be determined.