org.firebirdsql.jdbc.FBDataSource Maven / Gradle / Ivy
Show all versions of jaybird Show documentation
/*
* Firebird Open Source J2ee connector - jdbc driver
*
* Distributable under LGPL license.
* You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* LGPL License for more details.
*
* This file was created by members of the firebird development team.
* All individual contributions remain the Copyright (C) of those
* individuals. Contributors to this file are either listed here or
* can be obtained from a CVS history command.
*
* All rights reserved.
*/
package org.firebirdsql.jdbc;
import java.io.PrintWriter;
import java.io.Serializable;
import java.sql.Connection;
import java.sql.SQLException;
import javax.naming.Reference;
import javax.resource.Referenceable;
import javax.resource.ResourceException;
import javax.resource.spi.ConnectionManager;
import javax.resource.spi.ManagedConnectionFactory;
import javax.sql.DataSource;
import org.firebirdsql.jca.FBConnectionRequestInfo;
import org.firebirdsql.jca.FBManagedConnectionFactory;
/**
* The class FBDataSource is a ConnectionFactory for jdbc
* Connection objects. All work is delegated to a ConnectionManager.
*
* @author David Jencks
* @version 1.0
*/
public class FBDataSource implements DataSource, Serializable, Referenceable {
private ConnectionManager cm;
private FBManagedConnectionFactory mcf;
transient private PrintWriter log;
private Reference jndiReference;
private int loginTimeout = 0;
// this constructor is needed to make BES happy.
public FBDataSource(ManagedConnectionFactory mcf, ConnectionManager cm) {
this((FBManagedConnectionFactory)mcf, cm);
}
public FBDataSource(FBManagedConnectionFactory mcf, ConnectionManager cm) {
this.mcf = mcf;
this.cm = cm;
}
/**
* Set the JNDI Reference for this DataSource.
*
* @param ref The JNDI reference for this DataSource
*/
public void setReference(Reference ref) {
this.jndiReference = ref;
}
/**
* Get the JNDI Reference for this DataSource.
*
* @return The JNDI reference
*/
public Reference getReference() {
return jndiReference;
}
/**
* Attempt to establish a database connection.
*
* @return a Connection to the database
* @exception SQLException if a database-access error occurs.
*/
public Connection getConnection() throws SQLException {
try {
return (Connection)cm.allocateConnection(mcf, mcf.getDefaultConnectionRequestInfo());
}
catch (ResourceException re) {
throw new FBSQLException("Problem getting connection: " + re);
}
}
/**
*
Attempt to establish a database connection.
*
* @param username the database user on whose behalf the Connection is
* being made
* @param password the user's password
* @return a Connection to the database
* @exception SQLException if a database-access error occurs.
*/
public Connection getConnection(String username, String password) throws SQLException {
try
{
//mcf makes a copy for us.
FBConnectionRequestInfo subjectCri = mcf.getDefaultConnectionRequestInfo();
subjectCri.setUserName(username);
subjectCri.setPassword(password);
return (Connection)cm.allocateConnection(mcf, subjectCri);
}
catch (ResourceException re) {
throw new FBSQLException(re);
}
}
/**
*
Get the log writer for this data source.
*
*
The log writer is a character output stream to which all logging
* and tracing messages for this data source object instance will be
* printed. This includes messages printed by the methods of this
* object, messages printed by methods of other objects manufactured
* by this object, and so on. Messages printed to a data source
* specific log writer are not printed to the log writer associated
* with the java.sql.Drivermanager class. When a DataSource object is
* created the log writer is initially null, in other words, logging
* is disabled.
*
* @return the log writer for this data source, null if disabled
*/
public PrintWriter getLogWriter() {
return log;
}
/**
*
Set the log writer for this data source.
*
*
The log writer is a character output stream to which all logging
* and tracing messages for this data source object instance will be
* printed. This includes messages printed by the methods of this
* object, messages printed by methods of other objects manufactured
* by this object, and so on. Messages printed to a data source
* specific log writer are not printed to the log writer associated
* with the java.sql.Drivermanager class. When a DataSource object is
* created the log writer is initially null, in other words, logging
* is disabled.
*
* @param out the new log writer; to disable, set to null
* @exception SQLException if a database-access error occurs.
*/
public void setLogWriter(PrintWriter out) {
log = out;
}
/**
*
Sets the maximum time in seconds that this data source will wait
* while attempting to connect to a database. A value of zero
* specifies that the timeout is the default system timeout
* if there is one; otherwise it specifies that there is no timeout.
* When a DataSource object is created the login timeout is
* initially zero.
*
* @param seconds the data source login time limit
* @exception SQLException if a database access error occurs.
*/
public void setLoginTimeout(int seconds) throws SQLException {
loginTimeout = seconds;
}
/**
* Gets the maximum time in seconds that this data source can wait
* while attempting to connect to a database. A value of zero
* means that the timeout is the default system timeout
* if there is one; otherwise it means that there is no timeout.
* When a DataSource object is created the login timeout is
* initially zero.
*
* @return the data source login time limit
* @exception SQLException if a database access error occurs.
*/
public int getLoginTimeout() throws SQLException {
return loginTimeout;
}
public boolean isWrapperFor(Class arg0) throws SQLException {
return arg0 != null && arg0.isAssignableFrom(FBDataSource.class);
}
public Object unwrap(Class arg0) throws SQLException {
if (!isWrapperFor(arg0))
throw new FBSQLException("No compatible class found.");
return this;
}
}