oracle.jdeveloper.db.adapter

Class MySQLConnectionCreator

java.lang.Object

oracle.jdeveloper.db.adapter.AbstractConnectionCreator

oracle.jdeveloper.db.adapter.MySQLConnectionCreator

All Implemented Interfaces:

ConnectionCreator, SSHConnectionCreator

public class MySQLConnectionCreator
extends AbstractConnectionCreator
implements SSHConnectionCreator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MYSQL_DRIVER_CLASS
static java.lang.String	SUBTYPE_MYSQL

Constructor Summary

Constructors

Constructor and Description
MySQLConnectionCreator()

Method Summary

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

convertToJDBCParameterInfos, getBundle, getDriver, getInvalidURLMessage, getJDBCProperties, getLogger, getPropertyOrThrow, hasLength, isPassword, listJDBCParameterInfos, loadDriver, setCustomProperties, 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

getJDBCProperties, isPassword, listJDBCParameterInfos, shouldEncrypt, shouldPromptForPassword, shouldSave

Field Detail

MYSQL_DRIVER_CLASS

public static final java.lang.String MYSQL_DRIVER_CLASS

See Also:

Constant Field Values

SUBTYPE_MYSQL

public static final java.lang.String SUBTYPE_MYSQL

See Also:

Constant Field Values

Constructor Detail

MySQLConnectionCreator

public MySQLConnectionCreator()

Method Detail

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

getConnection

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

Description copied from class: AbstractConnectionCreator

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

Overrides:

getConnection in class AbstractConnectionCreator

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:

AbstractConnectionCreator.getConnectionURL(Properties), AbstractConnectionCreator.getDriverClassName(Properties)

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

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.