Package weblogic.jdbc.extensions

Interface WLDataSource

public interface WLDataSource

A WLDataSource provides methods not supported by javax.sql.DataSource.

WLDataSource provides methods for the following:

• Get a connection with matching labels
• Register and unregister the connection labeling callback
• Register and unregister the connection initialization callback

See Also:

DataSource

Method Summary

Modifier and Type	Method	Description
java.sql.Connection	createConnection(java.util.Properties additionalProperties)	Attempts to create a new database connection with the requested additional connection properties.
java.sql.Connection	createConnectionToInstance(java.lang.String instance, java.util.Properties additionalProperties)	Attempts to create a new database connection with the requested additional connection properties to the specified instance.
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password, java.util.Properties labels)	Attempts to obtain a database connection with the requested connection labels.
java.sql.Connection	getConnection(java.util.Properties labels)	Attempts to obtain a database connection with the requested connection labels.
void	registerConnectionInitializationCallback(ConnectionInitializationCallback cbk)	Registers a connection initialization callback with the underlying connection pool.
void	registerConnectionLabelingCallback(ConnectionLabelingCallback cbk)	Registers a connection labeling callback with the underlying connection pool.
void	removeConnectionLabelingCallback()	Removes the ConnectionLabelingCallback object registered with the underlying connection pool, if any.
void	unregisterConnectionInitializationCallback()	Unregisters the ConnectionInitializationCallback object registered with the underlying connection pool, if any.

Method Detail

getConnection

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

Attempts to obtain a database connection with the requested connection labels.

Parameters:

labels - The requested connection labels.

Returns:

A Connection to the database.

Throws:

java.sql.SQLException - if a database-access error occurs.

getConnection

java.sql.Connection getConnection(java.lang.String username,
                                  java.lang.String password,
                                  java.util.Properties labels)
                           throws java.sql.SQLException

Attempts to obtain a database connection with the requested connection labels.

Parameters:

username - The database user on whose behalf the connection is being made.

password - The user's password.

labels - The requested connection labels.

Returns:

A Connection to the database.

Throws:

java.sql.SQLException - if a database-access error occurs.

registerConnectionLabelingCallback

void registerConnectionLabelingCallback(ConnectionLabelingCallback cbk)
                                 throws java.sql.SQLException

Registers a connection labeling callback with the underlying connection pool.

Parameters:

cbk - The ConnectionLabelingCallback object to be registered.

Throws:

java.sql.SQLException - If there is a callback already registered with the pool.

removeConnectionLabelingCallback

void removeConnectionLabelingCallback()
                               throws java.sql.SQLException

Removes the ConnectionLabelingCallback object registered with the underlying connection pool, if any.

Throws:

java.sql.SQLException - If callback removal fails.

registerConnectionInitializationCallback

void registerConnectionInitializationCallback(ConnectionInitializationCallback cbk)
                                       throws java.sql.SQLException

Registers a connection initialization callback with the underlying connection pool.

Parameters:

cbk - The ConnectionInitializationCallback object to be registered.

Throws:

java.sql.SQLException - If there is a callback already registered with the pool.

unregisterConnectionInitializationCallback

void unregisterConnectionInitializationCallback()
                                         throws java.sql.SQLException

Unregisters the ConnectionInitializationCallback object registered with the underlying connection pool, if any.

Throws:

java.sql.SQLException - If callback removal fails.

createConnection

java.sql.Connection createConnection(java.util.Properties additionalProperties)
                              throws java.sql.SQLException

Attempts to create a new database connection with the requested additional connection properties. When the connection is closed, it will not be returned to the connection pool. This API should work on any driver, assuming that the additional connection properties that are specified can either be used or ignored by the associated driver.

Parameters:

additionalProperties - The requested additional connection properties.

Returns:

A new Connection to the database.

Throws:

java.sql.SQLException - if a database-access error occurs.

createConnectionToInstance

java.sql.Connection createConnectionToInstance(java.lang.String instance,
                                               java.util.Properties additionalProperties)
                                        throws java.sql.SQLException

Attempts to create a new database connection with the requested additional connection properties to the specified instance. When the connection is closed, it will not be returned to the connection pool. This is only supported on Active GridLink on Oracle thin driver.

Parameters:

instance - Target instance.

additionalProperties - The requested additional connection properties.

Returns:

A new Connection to the same instance as the connection specified.

Throws:

java.sql.SQLException - if a database-access error occurs.

SQLFeatureNotSupportedException - The method was invoked on an unsupported connection or driver type