net.sourceforge.jtds.jdbc

Class XASupport


public class XASupport
extends java.lang.Object

This class contains static utility methods used to implement distributed transactions. For SQL Server 2000 the driver can provide true distributed transactions provided that the external stored procedure in JtdsXA.dll is installed. For other types of server only an emulation is available at this stage.

Field Summary

private static String
TM_ID
xa_open login string unique to jTDS.
private static int
XA_CLOSE
private static int
XA_COMMIT
private static int
XA_COMPLETE
private static int
XA_END
private static int
XA_FORGET
private static int
XA_OPEN
private static int
XA_PREPARE
private static int
XA_RECOVER
private static int
XA_RMID
The Resource Manager ID allocated by jTDS
private static int
XA_ROLLBACK
private static int
XA_START
private static int
XA_TRACE
Set this field to 1 to enable XA tracing.

Constructor Summary

XASupport()

Method Summary

static void
raiseXAException(SQLException sqle)
Construct and throw an XAException with an explanatory message derived from the SQLException and the XA error code set to XAER_RMFAIL.
static void
raiseXAException(int errorCode)
Construct and throw an XAException with an explanatory message and the XA error code set.
private static byte[]
toBytesXid(Xid xid)
Format an XA transaction ID into a 140 byte array.
static void
xa_close(Connection connection, int xaConId)
Invoke the xa_close routine on the SQL Server.
static void
xa_commit(Connection connection, int xaConId, Xid xid, boolean onePhase)
Invoke the xa_commit routine on the SQL Server.
static void
xa_end(Connection connection, int xaConId, Xid xid, int flags)
Invoke the xa_end routine on the SQL Server.
static void
xa_forget(Connection connection, int xaConId, Xid xid)
Invoke the xa_forget routine on the SQL Server.
static int
xa_open(Connection connection)
Invoke the xa_open routine on the SQL Server.
static int
xa_prepare(Connection connection, int xaConId, Xid xid)
Invoke the xa_prepare routine on the SQL Server.
static Xid[]
xa_recover(Connection connection, int xaConId, int flags)
Invoke the xa_recover routine on the SQL Server.
static void
xa_rollback(Connection connection, int xaConId, Xid xid)
Invoke the xa_rollback routine on the SQL Server.
static void
xa_start(Connection connection, int xaConId, Xid xid, int flags)
Invoke the xa_start routine on the SQL Server.

Field Details

TM_ID

private static final String TM_ID
xa_open login string unique to jTDS.

XA_CLOSE

private static final int XA_CLOSE
Field Value:
2

XA_COMMIT

private static final int XA_COMMIT
Field Value:
7

XA_COMPLETE

private static final int XA_COMPLETE
Field Value:
10

XA_END

private static final int XA_END
Field Value:
4

XA_FORGET

private static final int XA_FORGET
Field Value:
9

XA_OPEN

private static final int XA_OPEN
Field Value:
1

XA_PREPARE

private static final int XA_PREPARE
Field Value:
6

XA_RECOVER

private static final int XA_RECOVER
Field Value:
8

XA_RMID

private static final int XA_RMID
The Resource Manager ID allocated by jTDS
Field Value:
1

XA_ROLLBACK

private static final int XA_ROLLBACK
Field Value:
5

XA_START

private static final int XA_START
Field Value:
3

XA_TRACE

private static final int XA_TRACE
Set this field to 1 to enable XA tracing.
Field Value:
0

Constructor Details

XASupport

private XASupport()

Method Details

raiseXAException

public static void raiseXAException(SQLException sqle)
            throws XAException
Construct and throw an XAException with an explanatory message derived from the SQLException and the XA error code set to XAER_RMFAIL.
Parameters:
sqle - The SQLException.

raiseXAException

public static void raiseXAException(int errorCode)
            throws XAException
Construct and throw an XAException with an explanatory message and the XA error code set.
Parameters:
errorCode - the XA Error code

toBytesXid

private static byte[] toBytesXid(Xid xid)
Format an XA transaction ID into a 140 byte array.
Parameters:
xid - the XA transaction ID
Returns:
the formatted ID as a byte[]

xa_close

public static void xa_close(Connection connection,
                            int xaConId)
            throws SQLException
Invoke the xa_close routine on the SQL Server.
Parameters:
connection - JDBC Connection to be enlisted in the transaction
xaConId - the connection ID allocated by the server

xa_commit

public static void xa_commit(Connection connection,
                             int xaConId,
                             Xid xid,
                             boolean onePhase)
            throws XAException
Invoke the xa_commit routine on the SQL Server.
Parameters:
connection - JDBC Connection enlisted in the transaction
xaConId - the connection ID allocated by the server
xid - the XA Transaction ID object
onePhase - true if single phase commit required

xa_end

public static void xa_end(Connection connection,
                          int xaConId,
                          Xid xid,
                          int flags)
            throws XAException
Invoke the xa_end routine on the SQL Server.
Parameters:
connection - JDBC Connection enlisted in the transaction
xaConId - the connection ID allocated by the server
xid - the XA Transaction ID object
flags - XA Flags for start command

xa_forget

public static void xa_forget(Connection connection,
                             int xaConId,
                             Xid xid)
            throws XAException
Invoke the xa_forget routine on the SQL Server.
Parameters:
connection - JDBC Connection enlisted in the transaction
xaConId - the connection ID allocated by the server
xid - the XA Transaction ID object

xa_open

public static int xa_open(Connection connection)
            throws SQLException
Invoke the xa_open routine on the SQL Server.
Parameters:
connection - the parent XAConnection object
Returns:
the XA connection ID allocated by xp_jtdsxa

xa_prepare

public static int xa_prepare(Connection connection,
                             int xaConId,
                             Xid xid)
            throws XAException
Invoke the xa_prepare routine on the SQL Server.
Parameters:
connection - JDBC Connection enlisted in the transaction.
xaConId - The connection ID allocated by the server.
xid - The XA Transaction ID object.
Returns:
prepare status (XA_OK or XA_RDONLY) as an int.

xa_recover

public static Xid[] xa_recover(Connection connection,
                               int xaConId,
                               int flags)
            throws XAException
Invoke the xa_recover routine on the SQL Server.

This version of xa_recover will return all XIDs on the first call.

Parameters:
connection - JDBC Connection enlisted in the transaction
xaConId - the connection ID allocated by the server
flags - XA Flags for start command
Returns:
transactions to recover as a Xid[]

xa_rollback

public static void xa_rollback(Connection connection,
                               int xaConId,
                               Xid xid)
            throws XAException
Invoke the xa_rollback routine on the SQL Server.
Parameters:
connection - JDBC Connection enlisted in the transaction
xaConId - the connection ID allocated by the server
xid - the XA Transaction ID object

xa_start

public static void xa_start(Connection connection,
                            int xaConId,
                            Xid xid,
                            int flags)
            throws XAException
Invoke the xa_start routine on the SQL Server.
Parameters:
connection - JDBC Connection to be enlisted in the transaction
xaConId - the connection ID allocated by the server
xid - the XA Transaction ID object
flags - XA Flags for start command

Generated on June 12 2008