oracle.jdeveloper.db.adapter

Interface ConnectionCreator

All Known Subinterfaces:

SSHConnectionCreator

All Known Implementing Classes:

AbstractConnectionCreator, AbstractOracleConnCreator, CustomConnectionCreator, DB2ConnectionCreator, DerbyConnectionCreator, MySQLConnectionCreator, ODBCConnectionCreator, OracleConnectionCreator, OracleLiteConnectionCreator, SQLiteConnectionCreator, SQLServerConnectionCreator

public interface ConnectionCreator

Creator for the DatabaseProvider to create a Connection given the key/value pairs accessible through the Properties class. A ConnectionCreator can be registered against the DatabaseProvider to provide support for more than the default set of jdbc connection types.

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	getConnection(java.util.Properties props) Creates a Connection from the given Properties.
java.lang.String	getConnectionURL(java.util.Properties props) Returns the URL for the connection.
java.lang.String	getDriverClassName(java.util.Properties props) Returns the driver class for the connection.
java.util.Properties	getJDBCProperties(java.util.Properties props) Gets the full set of properties used to create the connection.
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.
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) Indicates wether the password prompter should be invoked (when available) for the given connection properties.
boolean	shouldSave(java.lang.String propName, DatabaseProvider pro) Tests whether the given property be "saved" - i.e.

Method Detail

getConnection

java.sql.Connection getConnection(java.util.Properties props)
                           throws java.sql.SQLException

Creates a Connection from the given Properties. The Properties contains key/value pairs for the information required to create the connection.

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.

getConnectionURL

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

Returns the URL for the connection. This is used along with the JDBC properties to create the connection.

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.

getJDBCProperties

java.util.Properties getJDBCProperties(java.util.Properties props)
                                throws java.sql.SQLException

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.

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.

getDriverClassName

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

Returns the driver class for the connection.

Throws:

java.sql.SQLException

shouldEncrypt

boolean shouldEncrypt(java.lang.String propName)

Indicates to the core getReference() logic whether a given property name should be encrypted when persisting or not.

Returns:

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

isPassword

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 shouldEncrypt(java.lang.String), as non-password values might still be encrypted (e.g. a username).

Returns:

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

shouldSave

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.

Parameters:

propName - the name of the property to test

pro - the connection definition

Returns:

true if the property should be saved

shouldPromptForPassword

boolean shouldPromptForPassword(java.util.Properties props)

Indicates wether the password prompter should be invoked (when available) for the given connection properties.

Parameters:

props - the connection details that might need a password prompted for

Returns:

whether to show the prompter

listAllowedProperties

java.util.Collection<java.lang.String> listAllowedProperties()

Gets a list of the properties that are relevant to this creator. If a property is not listed, it is not needed/supported.

Returns:

a list of the allowed property keys for the connection's properties.

See Also:

listRequiredProperties()

listRequiredProperties

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. 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.

Returns:

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

See Also:

listAllowedProperties()

listJDBCParameterInfos

java.util.Collection<JDBCParameterInfo> listJDBCParameterInfos(java.util.Properties connProperties)
                                                        throws java.sql.SQLException

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).

Parameters:

connProperties - the connection properties to get the parameter information for

Throws:

java.sql.SQLException