Package org.apache.derby.jdbc
Class EmbedXAResource
java.lang.Object
org.apache.derby.jdbc.EmbedXAResource
- All Implemented Interfaces:
XAResource
Implements XAResource
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate EmbedPooledConnection
private XAXactId
private LanguageConnectionContext
private ResourceAdapter
private int
The value of the transaction timeout on this resource.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 TypeMethodDescriptionprivate void
checkUserCredentials
(EmbedXAResource original) Compares the user name and password of the XAResource with user name and password of this and throws XAException if there is a mismatchprivate void
Checks if currently associated connection is active throws exception if notprivate static void
Close an underlying connection object when there is no active XAResource to hand it to.final void
Commit the global transaction specified by xid.final void
Ends the work performed on behalf of a transaction branch.final void
Tell the resource manager to forget about a heuristically completed transaction branch.private static ContextManager
Privileged lookup of the ContextManager.private static ContextService
Privileged lookup of the ContextService.(package private) Xid
Resturns currently active xidprivate long
Returns the default value for the transaction timeout in milliseconds setted up by the system properties.private LanguageConnectionContext
Gets the LanguageConnectionContext for this connection.private LanguageConnectionContext
Privileged LCC lookup.private XATransactionState
getTransactionState
(XAXactId xid_im) Returns the XATransactionState of the the transactionint
Obtain the current transaction timeout value set for this XAResource instance.final boolean
isSameRM
(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.final int
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.final Xid[]
recover
(int flag) Obtain a list of prepared transaction branches from a resource manager.(package private) void
removeXATransaction
(XAXactId xid_im) Removes the xid from currently active transactions(package private) void
returnConnectionToResource
(XATransactionState tranState, XAXactId xid_im) Return an underlying connection object back to its XAResource if possible.final void
Inform the resource manager to roll back work done on behalf of a transaction branch(package private) void
setCurrentXid
(XAXactId aCurrentXid) boolean
setTransactionTimeout
(int seconds) Set the current transaction timeout value for this XAResource instance.final void
Start work on behalf of a transaction branch specified in xid If TMJOIN is specified, the start is for joining a transaction previously seen by the resource manager.private static XAException
Map a SQL exception to appropriate XAException.private static XAException
Map a Standard exception to appropriate XAException.
-
Field Details
-
con
-
ra
-
currentXid
-
timeoutSeconds
private int timeoutSecondsThe value of the transaction timeout on this resource. -
lcc
-
-
Constructor Details
-
EmbedXAResource
EmbedXAResource(EmbedPooledConnection con, ResourceAdapter ra)
-
-
Method Details
-
commit
Commit the global transaction specified by xid.- Specified by:
commit
in interfaceXAResource
- Parameters:
xid
- A global transaction identifieronePhase
- If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.- Throws:
XAException
- An error has occurred. Possible XAExceptions are XA_HEURHAZ, XA_HEURCOM, XA_HEURRB, XA_HEURMIX, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.If the resource manager did not commit the transaction and the paramether onePhase is set to true, the resource manager may throw one of the XA_RB* exceptions. Upon return, the resource manager has rolled back the branch's work and has released all held resources.
-
end
Ends the work performed on behalf of a transaction branch. The resource manager disassociates 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*.
-
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.
-
getTransactionTimeout
public int 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.
-
isSameRM
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.- Specified by:
isSameRM
in interfaceXAResource
- 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:
XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.
-
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 throw the appropriate XAException.
- Throws:
XAException
- An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.
-
forget
Tell the resource manager to forget about a heuristically 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.
-
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.
-
getDefaultXATransactionTimeout
Returns the default value for the transaction timeout in milliseconds setted up by the system properties.- Throws:
XAException
-
start
Start work on behalf of a transaction branch specified in xid If TMJOIN is specified, the start is for joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start is to resume a suspended transaction specified in the parameter xid. If neither TMJOIN nor TMRESUME is specified and the transaction specified by xid has previously been seen by the resource manager, the resource manager throws the XAException exception with XAER_DUPID error code.- 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.
-
getCurrentXid
Xid getCurrentXid()Resturns currently active xid- Returns:
- Xid
-
getTransactionState
Returns the XATransactionState of the the transaction- Parameters:
xid_im
-- Returns:
- XATransactionState
-
checkUserCredentials
Compares the user name and password of the XAResource with user name and password of this and throws XAException if there is a mismatch- Parameters:
original
- EmbedXAResource- Throws:
XAException
-
checkXAActive
Checks if currently associated connection is active throws exception if not- Throws:
XAException
-
wrapInXAException
Map a SQL exception to appropriate XAException. Return the mapped XAException. -
wrapInXAException
Map a Standard exception to appropriate XAException. Return the mapped XAException. -
returnConnectionToResource
Return an underlying connection object back to its XAResource if possible. If not close the connection.- Parameters:
tranState
-xid_im
-
-
closeUnusedConnection
Close an underlying connection object when there is no active XAResource to hand it to.- Parameters:
conn
-
-
removeXATransaction
Removes the xid from currently active transactions- Parameters:
xid_im
-
-
setCurrentXid
-
getContextService
Privileged lookup of the ContextService. Must be private so that user code can't call this entry point. -
getContextManager
Privileged lookup of the ContextManager. Must be private so that user code can't call this entry point. -
getLanguageConnectionContext
Gets the LanguageConnectionContext for this connection. -
getLanguageConnectionContext
private LanguageConnectionContext getLanguageConnectionContext(EmbedPooledConnection conn) throws SQLException Privileged LCC lookup. Must be private so that user code can't call this entry point.- Throws:
SQLException
-