Package net.sourceforge.jtds.jdbc
Class XASupport
java.lang.Object
net.sourceforge.jtds.jdbc.XASupport
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
FieldsModifier and TypeFieldDescriptionprivate static final String
xa_open login string unique to jTDS.private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
The Resource Manager ID allocated by jTDSprivate static final int
private static final int
private static final int
Set this field to 1 to enable XA tracing. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
raiseXAException
(int errorCode) Construct and throw anXAException
with an explanatory message and the XA error code set.static void
raiseXAException
(SQLException sqle) Construct and throw anXAException
with an explanatory message derived from theSQLException
and the XA error code set toXAER_RMFAIL
.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
-
XA_RMID
private static final int XA_RMIDThe Resource Manager ID allocated by jTDS- See Also:
-
TM_ID
xa_open login string unique to jTDS.- See Also:
-
XA_OPEN
private static final int XA_OPEN- See Also:
-
XA_CLOSE
private static final int XA_CLOSE- See Also:
-
XA_START
private static final int XA_START- See Also:
-
XA_END
private static final int XA_END- See Also:
-
XA_ROLLBACK
private static final int XA_ROLLBACK- See Also:
-
XA_PREPARE
private static final int XA_PREPARE- See Also:
-
XA_COMMIT
private static final int XA_COMMIT- See Also:
-
XA_RECOVER
private static final int XA_RECOVER- See Also:
-
XA_FORGET
private static final int XA_FORGET- See Also:
-
XA_COMPLETE
private static final int XA_COMPLETE- See Also:
-
XA_TRACE
private static final int XA_TRACESet this field to 1 to enable XA tracing.- See Also:
-
-
Constructor Details
-
XASupport
private XASupport()
-
-
Method Details
-
xa_open
Invoke the xa_open routine on the SQL Server.- Parameters:
connection
- the parent XAConnection object- Returns:
- the XA connection ID allocated by xp_jtdsxa
- Throws:
SQLException
-
xa_close
Invoke the xa_close routine on the SQL Server.- Parameters:
connection
- JDBC Connection to be enlisted in the transactionxaConId
- the connection ID allocated by the server- Throws:
SQLException
-
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 transactionxaConId
- the connection ID allocated by the serverxid
- the XA Transaction ID objectflags
- XA Flags for start command- Throws:
XAException
- if an error condition occurs
-
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 transactionxaConId
- the connection ID allocated by the serverxid
- the XA Transaction ID objectflags
- XA Flags for start command- Throws:
XAException
- if an error condition occurs
-
xa_prepare
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
. - Throws:
XAException
- if an error condition occurs
-
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 transactionxaConId
- the connection ID allocated by the serverxid
- the XA Transaction ID objectonePhase
-true
if single phase commit required- Throws:
XAException
- if an error condition occurs
-
xa_rollback
Invoke the xa_rollback routine on the SQL Server.- Parameters:
connection
- JDBC Connection enlisted in the transactionxaConId
- the connection ID allocated by the serverxid
- the XA Transaction ID object- Throws:
XAException
- if an error condition occurs
-
xa_recover
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 transactionxaConId
- the connection ID allocated by the serverflags
- XA Flags for start command- Returns:
- transactions to recover as a
Xid[]
- Throws:
XAException
- if an error condition occurs
-
xa_forget
Invoke the xa_forget routine on the SQL Server.- Parameters:
connection
- JDBC Connection enlisted in the transactionxaConId
- the connection ID allocated by the serverxid
- the XA Transaction ID object- Throws:
XAException
- if an error condition occurs
-
raiseXAException
Construct and throw anXAException
with an explanatory message derived from theSQLException
and the XA error code set toXAER_RMFAIL
.- Parameters:
sqle
- The SQLException.- Throws:
XAException
- exception derived from the code>SQLException
-
raiseXAException
Construct and throw anXAException
with an explanatory message and the XA error code set.- Parameters:
errorCode
- the XA Error code- Throws:
XAException
- the constructed exception
-
toBytesXid
Format an XA transaction ID into a 140 byte array.- Parameters:
xid
- the XA transaction ID- Returns:
- the formatted ID as a
byte[]
-