Package org.apache.derby.client.net
Class NetXAResource
java.lang.Object
org.apache.derby.client.net.NetXAResource
- All Implemented Interfaces:
XAResource
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) NetXACallInfo[]
(package private) NetConnection
(package private) SqlException
private static final int
private boolean
(package private) NetXAConnection
(package private) static final ClientXid
private int
The value of the transaction timeout in seconds.(package private) static final int
private static final int
private static final int
private static final int
private static final int
(package private) static final int
private static final int
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
Fields inherited from interface javax.transaction.xa.XAResource
TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
private void
void
Ends the work performed on behalf of a transaction branch.void
Tell the resource manager to forget about a heuristically (MANUALLY) completed transaction branch.private int
Get XAException.errorCode from SqlException For disconnect exception, return XAER_RMFAIL For other exceptions return XAER_RMERR For server side SQLExceptions during XA operations the errorCode has already been determined and wrapped in an XAException for return to the client.int
Obtain the current transaction timeout value set for this XAResource instance.private String
getXAExceptionText
(int rc) private String
getXAFuncStr
(int xaFunc) boolean
isSameRM
(XAResource xares) boolean
int
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.private String
processLocalHost
(String serverName) Xid[]
recover
(int flag) Obtain a list of prepared transaction branches from a resource manager.void
Inform the resource manager to roll back work done on behalf of a transaction branchvoid
setKeepCurrentIsolationLevel
(boolean flag) boolean
setTransactionTimeout
(int seconds) Set the current transaction timeout value for this XAResource instance.private void
setXaStateForXAException
(int rc) Reset the transaction branch association state to XA_T0_NOT_ASSOCIATED for XAER_RM* and XA_RB* Exceptions.void
Start work on behalf of a transaction branch specified in xidprivate void
throwXAException
(int rc) protected int
xaRetValErrorAccumSQL
(NetXACallInfo callInfo, int currentRC) static boolean
-
Field Details
-
INITIAL_CALLINFO_ELEMENTS
private static final int INITIAL_CALLINFO_ELEMENTS- See Also:
-
nullXid
-
XAFUNC_COMMIT
static final int XAFUNC_COMMIT- See Also:
-
XAFUNC_END
private static final int XAFUNC_END- See Also:
-
XAFUNC_FORGET
private static final int XAFUNC_FORGET- See Also:
-
XAFUNC_PREPARE
private static final int XAFUNC_PREPARE- See Also:
-
XAFUNC_RECOVER
private static final int XAFUNC_RECOVER- See Also:
-
XAFUNC_ROLLBACK
static final int XAFUNC_ROLLBACK- See Also:
-
XAFUNC_START
private static final int XAFUNC_START- See Also:
-
XAFUNCSTR_NONE
- See Also:
-
XAFUNCSTR_COMMIT
- See Also:
-
XAFUNCSTR_END
- See Also:
-
XAFUNCSTR_FORGET
- See Also:
-
XAFUNCSTR_PREPARE
- See Also:
-
XAFUNCSTR_RECOVER
- See Also:
-
XAFUNCSTR_ROLLBACK
- See Also:
-
XAFUNCSTR_START
- See Also:
-
exceptionsOnXA
SqlException exceptionsOnXA -
netXAConn_
NetXAConnection netXAConn_ -
conn_
NetConnection conn_ -
keepIsolationLevel
private boolean keepIsolationLevel -
callInfoArray_
NetXACallInfo[] callInfoArray_ -
timeoutSeconds
private int timeoutSecondsThe value of the transaction timeout in seconds.
-
-
Constructor Details
-
NetXAResource
-
-
Method Details
-
commit
- Specified by:
commit
in interfaceXAResource
- Throws:
XAException
-
getSqlExceptionXAErrorCode
Get XAException.errorCode from SqlException For disconnect exception, return XAER_RMFAIL For other exceptions return XAER_RMERR For server side SQLExceptions during XA operations the errorCode has already been determined and wrapped in an XAException for return to the client. see EmbedXAResource.wrapInXAException- Parameters:
sqle
- SqlException to evaluate.- Returns:
- XAException.XAER_RMFAIL for disconnect exception, XAException.XAER_RMERR for other exceptions.
-
end
Ends the work performed on behalf of a transaction branch. The resource manager dissociates the XA resource from the transaction branch specified and let the transaction be completed. If TMSUSPEND is specified in flags, the transaction branch is temporarily suspended in incomplete state. The transaction context is in suspened state and must be resumed via start with TMRESUME specified. If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as rollback-only If TMSUCCESS is specified, the portion of work has completed successfully.- Specified by:
end
in interfaceXAResource
- Parameters:
xid
- A global transaction identifier that is the same as what was used previously in the start method.flags
- One of TMSUCCESS, TMFAIL, or TMSUSPEND- Throws:
XAException
- An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.
-
forget
Tell the resource manager to forget about a heuristically (MANUALLY) completed transaction branch.- Specified by:
forget
in interfaceXAResource
- Parameters:
xid
- A global transaction identifier- Throws:
XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
-
getTransactionTimeout
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 0; otherwise, the value used in the previous setTransactionTimeout call is returned.- Specified by:
getTransactionTimeout
in interfaceXAResource
- Returns:
- the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout.
- Throws:
XAException
-
prepare
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.- Specified by:
prepare
in interfaceXAResource
- Parameters:
xid
- A global transaction identifier- Returns:
- A value indicating the resource manager's vote on the outcome of the transaction. The possible values are: XA_RDONLY or XA_OK. If the resource manager wants to roll back the transaction, it should do so by raising an appropriate XAException in the prepare method.
- Throws:
XAException
- An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
-
recover
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.- Specified by:
recover
in interfaceXAResource
- 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:
XAException
- An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.
-
rollback
Inform the resource manager to roll back work done on behalf of a transaction branch- Specified by:
rollback
in interfaceXAResource
- Parameters:
xid
- A global transaction identifier- Throws:
XAException
- An error has occurred
-
setTransactionTimeout
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.- Specified by:
setTransactionTimeout
in interfaceXAResource
- Parameters:
seconds
- the transaction timeout value in seconds. Value of 0 means the reasource manager's default value. Value of Integer.MAX_VALUE means no timeout.- Returns:
- true if transaction timeout value is set successfully; otherwise false.
- Throws:
XAException
- - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.
-
setKeepCurrentIsolationLevel
public void setKeepCurrentIsolationLevel(boolean flag) -
keepCurrentIsolationLevel
public boolean keepCurrentIsolationLevel() -
start
Start work on behalf of a transaction branch specified in xid- Specified by:
start
in interfaceXAResource
- Parameters:
xid
- A global transaction identifier to be associated with the resourceflags
- One of TMNOFLAGS, TMJOIN, or TMRESUME- Throws:
XAException
- An error has occurred. Possible exceptions * are XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
-
getXAExceptionText
-
throwXAException
- Throws:
XAException
-
setXaStateForXAException
private void setXaStateForXAException(int rc) Reset the transaction branch association state to XA_T0_NOT_ASSOCIATED for XAER_RM* and XA_RB* Exceptions. All other exceptions leave the state unchanged- Parameters:
rc
- // return code from XAException- Throws:
XAException
-
isSameRM
- Specified by:
isSameRM
in interfaceXAResource
- Throws:
XAException
-
xidsEqual
-
connectionClosedFailure
- Throws:
XAException
-
getXAFuncStr
-
xaRetValErrorAccumSQL
-
processLocalHost
-