oracle.jdbc.xa
Class OracleXAResource
oracle.jdbc.xa.OracleXAResource
- Direct Known Subclasses:
- OracleXAResource
- public abstract class OracleXAResource
Method Summary |
abstract void |
commit(javax.transaction.xa.Xid xid, boolean onePhase)
|
abstract void |
end(javax.transaction.xa.Xid xid, int flag)
|
abstract void |
forget(javax.transaction.xa.Xid xid)
|
int |
getTransactionTimeout()
Obtain the current transaction timeout value set for this XAResource instance. |
boolean |
isSameRM(javax.transaction.xa.XAResource xares)
This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares. |
abstract int |
prepare(javax.transaction.xa.Xid xid)
|
oracle.jdbc.xa.Xid[] |
recover(int flag)
Obtain a list of prepared transaction branches from a resource manager. |
abstract void |
rollback(javax.transaction.xa.Xid xid)
|
boolean |
setTransactionTimeout(int seconds)
Set the current transaction timeout value for this XAResource instance. |
abstract void |
start(javax.transaction.xa.Xid xid, int flag)
|
XA_OK
public static final int XA_OK
DEFAULT_XA_TIMEOUT
public static final short DEFAULT_XA_TIMEOUT
TMNOFLAGS
public static final int TMNOFLAGS
TMNOMIGRATE
public static final int TMNOMIGRATE
TMENDRSCAN
public static final int TMENDRSCAN
TMFAIL
public static final int TMFAIL
TMJOIN
public static final int TMJOIN
TMONEPHASE
public static final int TMONEPHASE
TMRESUME
public static final int TMRESUME
TMSTARTRSCAN
public static final int TMSTARTRSCAN
TMSUCCESS
public static final int TMSUCCESS
TMSUSPEND
public static final int TMSUSPEND
OracleXAResource
public OracleXAResource()
OracleXAResource
public OracleXAResource(java.sql.Connection pm_conn)
throws oracle.jdbc.xa.XAException
start
public abstract void start(javax.transaction.xa.Xid xid,
int flag)
throws oracle.jdbc.xa.XAException
end
public abstract void end(javax.transaction.xa.Xid xid,
int flag)
throws oracle.jdbc.xa.XAException
commit
public abstract void commit(javax.transaction.xa.Xid xid,
boolean onePhase)
throws oracle.jdbc.xa.XAException
prepare
public abstract int prepare(javax.transaction.xa.Xid xid)
throws oracle.jdbc.xa.XAException
forget
public abstract void forget(javax.transaction.xa.Xid xid)
throws oracle.jdbc.xa.XAException
rollback
public abstract void rollback(javax.transaction.xa.Xid xid)
throws oracle.jdbc.xa.XAException
recover
public oracle.jdbc.xa.Xid[] recover(int flag)
throws oracle.jdbc.xa.XAException
- Obtain a list of prepared transaction branches from a resource manager. The transaction manager calls this method during recovery to obtain the list of transaction branches that are currently in prepared or heuristically completed states.
-
- Parameters:
flag
- One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in flags.
- Returns:
- The resource manager returns zero or more XIDs for the transaction branches that are currently in a prepared or heuristically completed state. If an error occurs during the operation, the resource manager should raise the appropriate XAException.
- Throws:
- oracle.jdbc.xa.XAException - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.
getTransactionTimeout
public int getTransactionTimeout()
throws oracle.jdbc.xa.XAException
- Obtain the current transaction timeout value set for this XAResource instance. If XAResource.setTransactionTimeout was not use prior to invoking this method, the return value is the default timeout set fo the resource manager; otherwise, the value used in the previous setTransactionTimeout call is returned.
-
- Returns:
- the transaction timeout value in seconds.
- Throws:
- oracle.jdbc.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.
isSameRM
public boolean isSameRM(javax.transaction.xa.XAResource xares)
throws oracle.jdbc.xa.XAException
- This method is called to determine if the resource manager instance represented by the target object is the same as the resouce manager instance represented by the parameter xares.
-
- Parameters:
xares
- - An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object.
- Returns:
- true if it's the same RM instance; otherwise false.
- Throws:
- oracle.jdbc.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.
setTransactionTimeout
public boolean setTransactionTimeout(int seconds)
throws oracle.jdbc.xa.XAException
- Set the current transaction timeout value for this XAResource instance. Once set, this timeout value is effective until setTransactionTimeout is invoked again with a different value. To reset the timeout value to the default value used by the resource manager, set the value to zero. If the timeout operation is performed successfully, the method returns true; otherwise false. If a resource manager does not support transaction timeout value to be set explicitly, this method returns false.
-
- Parameters:
the
- - transaction timeout value in seconds.
- Throws:
- oracle.jdbc.xa.XAException - - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.