JDBCXADataSource.java
/* Copyright (c) 2001-2024, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.hsqldb.jdbc.pool;
import java.io.Serializable;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.naming.NamingException;
import javax.naming.Reference;
import javax.naming.Referenceable;
import javax.naming.StringRefAddr;
import javax.sql.CommonDataSource;
import javax.sql.XAConnection;
import javax.sql.XADataSource;
import javax.transaction.xa.Xid;
import org.hsqldb.error.Error;
import org.hsqldb.error.ErrorCode;
import org.hsqldb.jdbc.JDBCCommonDataSource;
import org.hsqldb.jdbc.JDBCConnection;
import org.hsqldb.jdbc.JDBCDriver;
import org.hsqldb.jdbc.JDBCUtil;
/**
* Connection factory for JDBCXAConnections.
* For use by XA data source factories, not by end users.<p>
*
* The {@link org.hsqldb.jdbc.JDBCDataSourceFactory} can be used to get
* instances of this class.<p>
*
* The methods of the superclass, {@link org.hsqldb.jdbc.JDBCCommonDataSource},
* are used for settings the HyperSQL server and user.
*
* @version 2.3.3
* @since HSQLDB 2.0.0
* @author Blaine Simpson (blaine dot simpson at admc dot com)
* @see javax.sql.XADataSource
* @see org.hsqldb.jdbc.pool.JDBCXAConnection
*/
public class JDBCXADataSource extends JDBCCommonDataSource
implements XADataSource, Serializable, Referenceable, CommonDataSource {
/**
* Get new XAConnection connection, to be managed by a connection manager.
*
* @throws SQLException on error
*/
public XAConnection getXAConnection() throws SQLException {
// Comment out before public release:
/*
System.err.print("Executing " + getClass().getName()
+ ".getXAConnection()...");
*/
// Use JDBCDriver directly so there is no need to register with DriverManager
JDBCConnection connection = (JDBCConnection) JDBCDriver.getConnection(
url,
connectionProps);
JDBCXAConnection xaConnection = new JDBCXAConnection(this, connection);
return xaConnection;
}
/**
* Gets a new XAConnection after validating the given username
* and password.
*
* @see #getXAConnection()
*
* @param user String which must match the 'user' configured for this
* JDBCXADataSource.
* @param password String which must match the 'password' configured
* for this JDBCXADataSource.
* @throws SQLException on error
*/
public XAConnection getXAConnection(
String user,
String password)
throws SQLException {
if (user == null || password == null) {
throw JDBCUtil.nullArgument();
}
if (user.equals(this.user) && password.equals(this.password)) {
return getXAConnection();
}
throw JDBCUtil.sqlException(Error.error(ErrorCode.X_28000));
}
/**
* Retrieves the Reference of this object.
*
* @return The non-null javax.naming.Reference of this object.
* @throws NamingException If a naming exception was encountered
* while retrieving the reference.
*/
public Reference getReference() throws NamingException {
String cname = "org.hsqldb.jdbc.JDBCDataSourceFactory";
Reference ref = new Reference(getClass().getName(), cname, null);
ref.add(new StringRefAddr("database", getDatabase()));
ref.add(new StringRefAddr("user", getUser()));
ref.add(new StringRefAddr("password", password));
ref.add(
new StringRefAddr("loginTimeout", Integer.toString(loginTimeout)));
return ref;
}
// ------------------------ internal implementation ------------------------
private HashMap<Xid, JDBCXAResource> resources = new HashMap<Xid,
JDBCXAResource>();
private ReentrantReadWriteLock lock = new ReentrantReadWriteLock(true);
public void addResource(Xid xid, JDBCXAResource xaResource) {
lock.writeLock().lock();
try {
resources.put(xid, xaResource);
} finally {
lock.writeLock().unlock();
}
}
public JDBCXADataSource() throws SQLException {
//
}
public JDBCXAResource removeResource(Xid xid) {
lock.writeLock().lock();
try {
return resources.remove(xid);
} finally {
lock.writeLock().unlock();
}
}
/**
* Return the list of transactions currently <I>in prepared or
* heuristically completed states</I>.
* Need to find out what non-prepared states they are considering
* <I>heuristically completed</I>.
*
* @see javax.transaction.xa.XAResource#recover(int)
*/
Xid[] getPreparedXids() {
lock.writeLock().lock();
try {
Iterator<Xid> it = resources.keySet().iterator();
Xid curXid;
HashSet<Xid> preparedSet = new HashSet<Xid>();
while (it.hasNext()) {
curXid = it.next();
if ((resources.get(curXid)).state
== JDBCXAResource.XA_STATE_PREPARED) {
preparedSet.add(curXid);
}
}
Xid[] array = new Xid[preparedSet.size()];
preparedSet.toArray(array);
return array;
} finally {
lock.writeLock().unlock();
}
}
/**
* This is needed so that XAResource.commit() and
* XAResource.rollback() may be applied to the right Connection
* (which is not necessarily that associated with that XAResource
* object).
*
* @see javax.transaction.xa.XAResource#commit(Xid, boolean)
* @see javax.transaction.xa.XAResource#rollback(Xid)
*/
JDBCXAResource getResource(Xid xid) {
lock.readLock().lock();
try {
return resources.get(xid);
} finally {
lock.readLock().unlock();
}
}
}