Top Description Fields Constructors Methods
org.hsqldb.jdbc

public Class JDBCDataSource

extends JDBCCommonDataSource
implements DataSource, Serializable, Referenceable, Wrapper
Class Inheritance
All Implemented Interfaces
java.sql.Wrapper, javax.naming.Referenceable, java.io.Serializable, javax.sql.DataSource, javax.sql.CommonDataSource
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, java.sql.Connection, .SQLException, .Wrapper, java.util.Properties, javax.naming.NamingException, .Reference, .Referenceable, .StringRefAddr, javax.sql.DataSource

A factory for connections to the physical data source that this DataSource object represents. An alternative to the DriverManager facility, a DataSource object is the preferred means of getting a connection. An object that implements the DataSource interface will typically be registered with a naming service based on the Java™ Naming and Directory (JNDI) API.

The DataSource interface is implemented by a driver vendor. There are three types of implementations:

  1. Basic implementation -- produces a standard Connection object
  2. Connection pooling implementation -- produces a Connection object that will automatically participate in connection pooling. This implementation works with a middle-tier connection pooling manager.
  3. Distributed transaction implementation -- produces a Connection object that may be used for distributed transactions and almost always participates in connection pooling. This implementation works with a middle-tier transaction manager and almost always with a connection pooling manager.

A DataSource object has properties that can be modified when necessary. For example, if the data source is moved to a different server, the property for the server can be changed. The benefit is that because the data source's properties can be changed, any code accessing that data source does not need to be changed.

A driver that is accessed via a DataSource object does not register itself with the DriverManager. Rather, a DataSource object is retrieved though a lookup operation and then used to create a Connection object. With a basic implementation, the connection obtained through a DataSource object is identical to a connection obtained through the DriverManager facility.

HSQLDB-Specific Information:

This implementation of data source is a basic implementation and does not perform connection pooling.

The getter and setter methods of the parent class, JDBCCommonDataSource, can be used.

Authors
Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
Since
JDK 1.4, HSQLDB 1.7.2
Version
2.7.3

Field Summary

Inherited from org.hsqldb.jdbc.JDBCCommonDataSource:
connectionPropsdataSourceNamedescriptionloginTimeoutlogWriternetworkProtocolpasswordserverNameurluser

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Connection

Returns:

a connection to the data source
getConnection
()

Implements javax.sql.DataSource.getConnection.

Retrieves a new connection using the properties that have already been set.

public Connection

Returns:

a connection to the data source
getConnection
(String
the database user on whose behalf the connection is being made
username
,
String
the user's password
password
)

Implements javax.sql.DataSource.getConnection.

Retrieves a new connection using the given username and password, and the database url that has been set.

private Connection
public Reference

Returns:

The non-null Reference of this object.
getReference
()

Implements javax.naming.Referenceable.getReference.

Retrieves the Reference of this object.

public boolean

Returns:

true if this implements the interface or directly or indirectly wraps an object that does.
isWrapperFor
(Class<?>
a Class defining an interface.
iface
)

Implements java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.

public <T> T

Returns:

an object that implements the interface. May be a proxy for the actual implementing object.
unwrap
(Class<T>
A Class defining an interface that the result must implement.
iface
)

Implements java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

Inherited from org.hsqldb.jdbc.JDBCCommonDataSource:
getDatabasegetDatabaseNamegetDataSourceNamegetDescriptiongetLoginTimeoutgetLogWritergetNetworkProtocolgetParentLoggergetServerNamegetUrlgetURLgetUsersetDatabasesetDatabaseNamesetLoginTimeoutsetLogWritersetPasswordsetPropertiessetUrlsetURLsetUser

Constructor Detail

JDBCDataSourceback to summary
public JDBCDataSource()

Method Detail

getConnectionback to summary
public Connection getConnection() throws SQLException

Implements javax.sql.DataSource.getConnection.

Retrieves a new connection using the properties that have already been set.

Returns:Connection

a connection to the data source

Exceptions
SQLException:
if a database access error occurs
getConnectionback to summary
public Connection getConnection(String username, String password) throws SQLException

Implements javax.sql.DataSource.getConnection.

Retrieves a new connection using the given username and password, and the database url that has been set. No other properties are used for the connection

Parameters
username:String

the database user on whose behalf the connection is being made

password:String

the user's password

Returns:Connection

a connection to the data source

Exceptions
SQLException:
if a database access error occurs
getConnectionback to summary
private Connection getConnection(String url, Properties props) throws SQLException
getReferenceback to summary
public Reference getReference() throws NamingException

Implements javax.naming.Referenceable.getReference.

Retrieves the Reference of this object.

Returns:Reference

The non-null Reference of this object.

Exceptions
NamingException:
If a naming exception was encountered while retrieving the reference.
isWrapperForback to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Parameters
iface:Class<?>

a Class defining an interface.

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does.

Exceptions
SQLException:
if an error occurs while determining whether this is a wrapper for an object with the given interface.
Since
JDK 1.6, HSQLDB 2.0
unwrapback to summary
public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Parameters
iface:Class<T>

A Class defining an interface that the result must implement.

Returns:T

an object that implements the interface. May be a proxy for the actual implementing object.

Annotations
@SuppressWarnings:unchecked
Exceptions
SQLException:
If no object found that implements the interface
Since
JDK 1.6, HSQLDB 2.0