DatabaseProvider (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.jdeveloper.db.adapter.DatabaseProvider

All Implemented Interfaces:

java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.DataSource
```
public class DatabaseProvider
extends java.lang.Object
implements javax.naming.Referenceable, javax.sql.DataSource
```
Referenceable implementation for Database Connections, to be bound into an ADF connection architecture JNDI Context.
This class is also a DataSource and is therefore capable of creating a java.sql.Connection to the database as well.
If the connection details are required to separately connect to the database (e.g. via java.sql.DriverManager), then there are two methods that provide the information required:
- getConnectionURL() to get the jdbc url
- getJDBCProperties() to get the info properties that accompany the URL (includes user/password when required).
Depending on the environment getDriverClassName() might also be required.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALL_SCHEMAS_REFTYPE` Deprecated. with no replacement.
`static java.lang.String`	`CUSTOM_URL_CLASS_REFTYPE` The URL for the database connection.
`static java.lang.String`	`DEPLOY_PASSWORD_CLASS_REFTYPE` Deprecated. with no replacement.
`static java.lang.String`	`DRIVER_CLASS_REFTYPE` The JDBC driver class.
`static java.lang.String`	`DSN_CLASS_REFTYPE` The source name of the database.
`static java.lang.String`	`HOSTNAME_CLASS_REFTYPE` The hostname of the database machine.
`static java.lang.String`	`INSTANCE_CLASS_REFTYPE` Deprecated. - moved to `SQLServerConnectionCreator.INSTANCE_CLASS_REFTYPE`. Database specific keys belong on the appropriate ConnectionCreator subclasses.
`static java.lang.String`	`PARAMETERS_CLASS_REFTYPE` Extra parameters for the JDBC driver.
`static java.lang.String`	`PASSWORD_CLASS_REFTYPE` The database password.
`static java.lang.String`	`PORT_CLASS_REFTYPE` The network port the database is running on.
`static java.lang.String`	`ROLE_CLASS_REFTYPE` The database roles to associated with the connection session.
`static java.lang.String`	`SAVE_PASSWORD_CLASS_REFTYPE` Whether to persist the password with the connection details.
`static java.lang.String`	`SERVICENAME_CLASS_REFTYPE` The service name of the database (Oracle).
`static java.lang.String`	`SID_CLASS_REFTYPE` The SID name of the database (Oracle).
`static java.lang.String`	`SUBTYPE_CLASS_REFTYPE` The subtype of the database connection.
`static java.lang.String`	`USERNAME_CLASS_REFTYPE` The database username.

Constructor Summary

Constructors
Constructor and Description
`DatabaseProvider()` Creates an empty DatabaseProvider.
`DatabaseProvider(java.util.Properties props)` Creates a new DatabaseProvider using the given properties.
`DatabaseProvider(java.lang.String name, java.util.Properties props)` Creates a new DatabaseProvider using the given properties and with the given name.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`disconnect()` Notifies this provider that the connection(s) associated with it have been closed.
`boolean`	`equals(java.lang.Object obj)`
`javax.naming.directory.Attributes`	`getAttributes()`
`java.sql.Connection`	`getConnection()`
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`
`java.lang.String`	`getConnectionURL()` Returns the URL for the connection.
`static ConnectionCreator`	`getCreator(DatabaseProvider dp)` Gets a ConnectionCreator for the given DatabaseProvider, or throws a SQLException if the given provider doesn't have a subtype for which a ConnectionCreator is registered.
`java.lang.String`	`getDriverClassName()` Gets the driver class for the connection.
`java.util.Properties`	`getJDBCProperties()` Gets the full set of properties needed to create the connection.
`int`	`getLoginTimeout()`
`java.io.PrintWriter`	`getLogWriter()`
`java.util.logging.Logger`	`getParentLogger()`
`java.util.Properties`	`getProperties()` Returns a copy of the underlying properties for this provider.
`java.lang.String`	`getProperty(java.lang.String name)` Returns the value for the specified property on this provider.
`javax.naming.Reference`	`getReference()`
`int`	`hashCode()`
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`
`static void`	`registerConnectionCreator(java.lang.String subtype, ConnectionCreator creator)` Registers a ConnectionCreator implementation for a new connection subtype.
`static void`	`setClassLoaderFactory(DatabaseProviderClassLoaderFactory factory)`
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogWriter(java.io.PrintWriter out)`
`void`	`setProperty(java.lang.String name, java.lang.String value)` Sets the given property on this provider.
`void`	`setReferenceWorker(oracle.jdevimpl.db.adapter.ReferenceWorker worker)` Internal use only - sets the reference worker that this provider should use when creating a Referenceable.
`boolean`	`shouldPromptForCredentials()` Tests whether the Properties of this DatabaseProvider are sufficient to create a Connection, or whether the user should be prompted for the username and password.
`<T> T`	`unwrap(java.lang.Class<T> iface)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUBTYPE_CLASS_REFTYPE
```
public static final java.lang.String SUBTYPE_CLASS_REFTYPE
```
    The subtype of the database connection.
    
    See Also:
    Constant Field Values
  - CUSTOM_URL_CLASS_REFTYPE
```
public static final java.lang.String CUSTOM_URL_CLASS_REFTYPE
```
    The URL for the database connection. If set, this overrides all other properties like hostname.
    
    See Also:
    Constant Field Values
  - DRIVER_CLASS_REFTYPE
```
public static final java.lang.String DRIVER_CLASS_REFTYPE
```
    The JDBC driver class. Some connections do not require this to be set because it is implicity from the connection subtype (e.g. Oracle)
    
    See Also:
    Constant Field Values
  - USERNAME_CLASS_REFTYPE
```
public static final java.lang.String USERNAME_CLASS_REFTYPE
```
    The database username. This maps to the "user" property in the JDBC Properties when creating a Connection.
    
    See Also:
    Constant Field Values
  - PASSWORD_CLASS_REFTYPE
```
public static final java.lang.String PASSWORD_CLASS_REFTYPE
```
    The database password. This maps to the "password" property in the JDBC Properties when creating a Connection.
    
    See Also:
    Constant Field Values
  - ROLE_CLASS_REFTYPE
```
public static final java.lang.String ROLE_CLASS_REFTYPE
```
    The database roles to associated with the connection session.
    
    See Also:
    Constant Field Values
  - HOSTNAME_CLASS_REFTYPE
```
public static final java.lang.String HOSTNAME_CLASS_REFTYPE
```
    The hostname of the database machine.
    
    See Also:
    Constant Field Values
  - PORT_CLASS_REFTYPE
```
public static final java.lang.String PORT_CLASS_REFTYPE
```
    The network port the database is running on.
    
    See Also:
    Constant Field Values
  - SID_CLASS_REFTYPE
```
public static final java.lang.String SID_CLASS_REFTYPE
```
    The SID name of the database (Oracle). Alternative to setting the service name.
    
    See Also:
    Constant Field Values
  - DSN_CLASS_REFTYPE
```
public static final java.lang.String DSN_CLASS_REFTYPE
```
    The source name of the database.
    
    See Also:
    Constant Field Values
  - INSTANCE_CLASS_REFTYPE
```
@Deprecated
public static final java.lang.String INSTANCE_CLASS_REFTYPE
```
    Deprecated. - moved to SQLServerConnectionCreator.INSTANCE_CLASS_REFTYPE. Database specific keys belong on the appropriate ConnectionCreator subclasses.
    
    The instance name of the database. ( Used by SQLServer )
    
    See Also:
    Constant Field Values
  - PARAMETERS_CLASS_REFTYPE
```
public static final java.lang.String PARAMETERS_CLASS_REFTYPE
```
    Extra parameters for the JDBC driver.
    
    See Also:
    JDBCParametersParser, Constant Field Values
  - SERVICENAME_CLASS_REFTYPE
```
public static final java.lang.String SERVICENAME_CLASS_REFTYPE
```
    The service name of the database (Oracle). Alternative to setting the SID.
    
    See Also:
    Constant Field Values
  - SAVE_PASSWORD_CLASS_REFTYPE
```
public static final java.lang.String SAVE_PASSWORD_CLASS_REFTYPE
```
    Whether to persist the password with the connection details. If false a password prompter will be used to prompt for the password (DT only).
    
    See Also:
    Constant Field Values
  - DEPLOY_PASSWORD_CLASS_REFTYPE
```
@Deprecated
public static final java.lang.String DEPLOY_PASSWORD_CLASS_REFTYPE
```
    Deprecated. with no replacement.
    
    See Also:
    Constant Field Values
  - ALL_SCHEMAS_REFTYPE
```
@Deprecated
public static final java.lang.String ALL_SCHEMAS_REFTYPE
```
    Deprecated. with no replacement.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DatabaseProvider
```
public DatabaseProvider()
```
    Creates an empty DatabaseProvider.
  - DatabaseProvider
```
public DatabaseProvider(java.util.Properties props)
```
    Creates a new DatabaseProvider using the given properties.
  - DatabaseProvider
```
public DatabaseProvider(java.lang.String name,
                java.util.Properties props)
```
    Creates a new DatabaseProvider using the given properties and with the given name.
- Method Detail
  - setReferenceWorker
```
public void setReferenceWorker(oracle.jdevimpl.db.adapter.ReferenceWorker worker)
```
    Internal use only - sets the reference worker that this provider should use when creating a Referenceable.
    
    For internal use only. Application developers should not use this
  - getReference
```
public javax.naming.Reference getReference()
```
    Specified by:
    
    getReference in interface javax.naming.Referenceable
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                java.lang.String password)
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
         throws java.sql.SQLException
```
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
```
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
  - getConnectionURL
```
public java.lang.String getConnectionURL()
                                  throws java.sql.SQLException
```
    Returns the URL for the connection. This is used along with the JDBC properties to create the connection.
    
    Returns:
    the jdbc url for this connection
    
    Throws:
    
    java.sql.SQLException - if a valid connection URL cannot be created from the properties in this referenceable.
  - getJDBCProperties
```
public java.util.Properties getJDBCProperties()
                                       throws java.sql.SQLException
```
    Gets the full set of properties needed 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.
    
    Returns:
    the jdbc info properties for this connection
    
    Throws:
    
    java.sql.SQLException - if a valid set of properties cannot be created the properties in this referenceable.
  - getDriverClassName
```
public java.lang.String getDriverClassName()
                                    throws java.sql.SQLException
```
    Gets the driver class for the connection.
    
    Returns:
    the jdbc driver class name
    
    Throws:
    
    java.sql.SQLException - if the driver class name cannot be determined from the properties in this referenceable.
  - shouldPromptForCredentials
```
public boolean shouldPromptForCredentials()
```
    Tests whether the Properties of this DatabaseProvider are sufficient to create a Connection, or whether the user should be prompted for the username and password.
    This will return false if the SUBTYPE_CLASS_REFTYPE property is missing or invalid.
    
    Returns:
    whether or not the user needs to be prompted for the credentials before a Connection can be created.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name)
```
    Returns the value for the specified property on this provider.
  - getProperties
```
public java.util.Properties getProperties()
```
    Returns a copy of the underlying properties for this provider.
  - setProperty
```
public void setProperty(java.lang.String name,
               java.lang.String value)
```
    Sets the given property on this provider.
  - disconnect
```
public void disconnect()
```
    Notifies this provider that the connection(s) associated with it have been closed. Removes any cached passwords.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAttributes
```
public javax.naming.directory.Attributes getAttributes()
```
  - setClassLoaderFactory
```
public static void setClassLoaderFactory(DatabaseProviderClassLoaderFactory factory)
```
  - getCreator
```
public static ConnectionCreator getCreator(DatabaseProvider dp)
                                    throws java.sql.SQLException
```
    Gets a ConnectionCreator for the given DatabaseProvider, or throws a SQLException if the given provider doesn't have a subtype for which a ConnectionCreator is registered.
    
    Parameters:
    dp - the provider instance to lookup a creator for
    
    Returns:
    a ConnectionCreator for the given provider
    
    Throws:
    
    java.sql.SQLException - if the provider's subtype doesn't have a registered created.
  - registerConnectionCreator
```
public static void registerConnectionCreator(java.lang.String subtype,
                             ConnectionCreator creator)
```
    Registers a ConnectionCreator implementation for a new connection subtype.
    
    Parameters:
    subtype - the subtype for the connection
    creator - the creator responsible for creating connections of the given subtype.

Class DatabaseProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SUBTYPE_CLASS_REFTYPE

CUSTOM_URL_CLASS_REFTYPE

DRIVER_CLASS_REFTYPE

USERNAME_CLASS_REFTYPE

PASSWORD_CLASS_REFTYPE

ROLE_CLASS_REFTYPE

HOSTNAME_CLASS_REFTYPE

PORT_CLASS_REFTYPE

SID_CLASS_REFTYPE

DSN_CLASS_REFTYPE

INSTANCE_CLASS_REFTYPE

PARAMETERS_CLASS_REFTYPE

SERVICENAME_CLASS_REFTYPE

SAVE_PASSWORD_CLASS_REFTYPE

DEPLOY_PASSWORD_CLASS_REFTYPE

ALL_SCHEMAS_REFTYPE

Constructor Detail

DatabaseProvider

DatabaseProvider

DatabaseProvider

Method Detail

setReferenceWorker

getReference

getConnection

getConnection

getLogWriter

setLogWriter

getLoginTimeout

setLoginTimeout

isWrapperFor

unwrap

getParentLogger

getConnectionURL

getJDBCProperties

getDriverClassName

shouldPromptForCredentials

getProperty

getProperties

setProperty

disconnect

hashCode

equals

getAttributes

setClassLoaderFactory

getCreator

registerConnectionCreator