oracle.jdeveloper.db.adapter

Class DerbyConnectionCreator

java.lang.Object

oracle.jdeveloper.db.adapter.AbstractConnectionCreator

oracle.jdeveloper.db.adapter.DerbyConnectionCreator

All Implemented Interfaces:

ConnectionCreator

public class DerbyConnectionCreator
extends AbstractConnectionCreator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DerbyConnectionCreator.DerbySubprotocol Enum that document the allowed subprotocols for a derby jdbc connection.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DERBY_CLIENT_DRIVER_CLASS Class name for the client jdbc driver class.
static java.lang.String	DERBY_EMBEDDED_DRIVER_CLASS Class name for the embedded jdbc driver class.
static java.lang.String	SUBPROTOCOL_CLASS_REFTYPE Optional subprotocol for the derby driver - valid values are defined by the DerbyConnectionCreator.DerbySubprotocol enum.
static java.lang.String	SUBTYPE_DERBY Connection subtype for Derby - used as a value for DatabaseProvider.SUBTYPE_CLASS_REFTYPE

Constructor Summary

Constructors

Constructor and Description
DerbyConnectionCreator()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	allowNullPassword() Returns false by default if password is an allowed property.
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<JDBCParameterInfo>	listJDBCParameterInfos(java.util.Properties connectionProps) 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.

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

convertToJDBCParameterInfos, getBundle, getConnection, getDriver, getInvalidURLMessage, getJDBCProperties, getLogger, getPropertyOrThrow, hasLength, loadDriver, setCustomProperties, shouldEncrypt, shouldPromptForPassword, throwMissingPropertyException

Methods inherited from class java.lang.Object

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

Field Detail

DERBY_EMBEDDED_DRIVER_CLASS

public static final java.lang.String DERBY_EMBEDDED_DRIVER_CLASS

Class name for the embedded jdbc driver class.

See Also:

Constant Field Values

DERBY_CLIENT_DRIVER_CLASS

public static final java.lang.String DERBY_CLIENT_DRIVER_CLASS

Class name for the client jdbc driver class.

See Also:

Constant Field Values

SUBTYPE_DERBY

public static final java.lang.String SUBTYPE_DERBY

Connection subtype for Derby - used as a value for DatabaseProvider.SUBTYPE_CLASS_REFTYPE

See Also:

Constant Field Values

SUBPROTOCOL_CLASS_REFTYPE

public static final java.lang.String SUBPROTOCOL_CLASS_REFTYPE

Optional subprotocol for the derby driver - valid values are defined by the DerbyConnectionCreator.DerbySubprotocol enum. As all Properties values are Strings the enum is only for reference.

See Also:

Constant Field Values

Constructor Detail

DerbyConnectionCreator

public DerbyConnectionCreator()

Method Detail

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

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.

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 AbstractConnectionCreator

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

allowNullPassword

protected boolean allowNullPassword()

Description copied from class: AbstractConnectionCreator

Returns false by default if password is an allowed property.

Overrides:

allowNullPassword in class AbstractConnectionCreator

See Also:

AbstractConnectionCreator.listAllowedProperties()

listJDBCParameterInfos

public java.util.Collection<JDBCParameterInfo> listJDBCParameterInfos(java.util.Properties connectionProps)
                                                               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

Overrides:

listJDBCParameterInfos in class AbstractConnectionCreator

Parameters:

connectionProps - the connection properties to get the parameter information for

Throws:

java.sql.SQLException