Package org.apache.derby.jdbc
Class EmbedXAResource
- java.lang.Object
-
- org.apache.derby.jdbc.EmbedXAResource
-
- All Implemented Interfaces:
javax.transaction.xa.XAResource
class EmbedXAResource extends java.lang.Object implements javax.transaction.xa.XAResource
Implements XAResource
-
-
Field Summary
Fields Modifier and Type Field Description private EmbedPooledConnection
con
private XAXactId
currentXid
private LanguageConnectionContext
lcc
private ResourceAdapter
ra
private int
timeoutSeconds
The value of the transaction timeout on this resource.
-
Constructor Summary
Constructors Constructor Description EmbedXAResource(EmbedPooledConnection con, ResourceAdapter ra)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private 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
checkXAActive()
Checks if currently associated connection is active throws exception if notprivate static void
closeUnusedConnection(EmbedConnection conn)
Close an underlying connection object when there is no active XAResource to hand it to.void
commit(javax.transaction.xa.Xid xid, boolean onePhase)
Commit the global transaction specified by xid.void
end(javax.transaction.xa.Xid xid, int flags)
Ends the work performed on behalf of a transaction branch.void
forget(javax.transaction.xa.Xid xid)
Tell the resource manager to forget about a heuristically completed transaction branch.private static ContextManager
getContextManager(EmbedConnection conn)
Privileged lookup of the ContextManager.private static ContextService
getContextService()
Privileged lookup of the ContextService.(package private) javax.transaction.xa.Xid
getCurrentXid()
Resturns currently active xidprivate long
getDefaultXATransactionTimeout()
Returns the default value for the transaction timeout in milliseconds setted up by the system properties.private LanguageConnectionContext
getLanguageConnectionContext(EmbedConnection conn)
Gets the LanguageConnectionContext for this connection.private LanguageConnectionContext
getLanguageConnectionContext(EmbedPooledConnection conn)
Privileged LCC lookup.private XATransactionState
getTransactionState(XAXactId xid_im)
Returns the XATransactionState of the the transactionint
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.int
prepare(javax.transaction.xa.Xid xid)
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.javax.transaction.xa.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.void
rollback(javax.transaction.xa.Xid xid)
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.void
start(javax.transaction.xa.Xid xid, int flags)
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 javax.transaction.xa.XAException
wrapInXAException(java.sql.SQLException se)
Map a SQL exception to appropriate XAException.private static javax.transaction.xa.XAException
wrapInXAException(StandardException se)
Map a Standard exception to appropriate XAException.
-
-
-
Field Detail
-
con
private EmbedPooledConnection con
-
ra
private ResourceAdapter ra
-
currentXid
private XAXactId currentXid
-
timeoutSeconds
private int timeoutSeconds
The value of the transaction timeout on this resource.
-
lcc
private LanguageConnectionContext lcc
-
-
Constructor Detail
-
EmbedXAResource
EmbedXAResource(EmbedPooledConnection con, ResourceAdapter ra)
-
-
Method Detail
-
commit
public final void commit(javax.transaction.xa.Xid xid, boolean onePhase) throws javax.transaction.xa.XAException
Commit the global transaction specified by xid.- Specified by:
commit
in interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.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
public final void end(javax.transaction.xa.Xid xid, int flags) throws javax.transaction.xa.XAException
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 interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.XAException
- An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.
-
prepare
public final int prepare(javax.transaction.xa.Xid xid) throws javax.transaction.xa.XAException
Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.- Specified by:
prepare
in interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.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 interfacejavax.transaction.xa.XAResource
- Returns:
- the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout.
-
isSameRM
public final boolean isSameRM(javax.transaction.xa.XAResource xares) throws javax.transaction.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.- Specified by:
isSameRM
in interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.
-
recover
public final javax.transaction.xa.Xid[] recover(int flag) throws javax.transaction.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.- Specified by:
recover
in interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.XAException
- An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.
-
forget
public final void forget(javax.transaction.xa.Xid xid) throws javax.transaction.xa.XAException
Tell the resource manager to forget about a heuristically completed transaction branch.- Specified by:
forget
in interfacejavax.transaction.xa.XAResource
- Parameters:
xid
- A global transaction identifier- Throws:
javax.transaction.xa.XAException
- An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.
-
rollback
public final void rollback(javax.transaction.xa.Xid xid) throws javax.transaction.xa.XAException
Inform the resource manager to roll back work done on behalf of a transaction branch- Specified by:
rollback
in interfacejavax.transaction.xa.XAResource
- Parameters:
xid
- A global transaction identifier- Throws:
javax.transaction.xa.XAException
- - An error has occurred
-
setTransactionTimeout
public boolean setTransactionTimeout(int seconds) throws javax.transaction.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.- Specified by:
setTransactionTimeout
in interfacejavax.transaction.xa.XAResource
- 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:
javax.transaction.xa.XAException
- - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.
-
getDefaultXATransactionTimeout
private long getDefaultXATransactionTimeout() throws javax.transaction.xa.XAException
Returns the default value for the transaction timeout in milliseconds setted up by the system properties.- Throws:
javax.transaction.xa.XAException
-
start
public final void start(javax.transaction.xa.Xid xid, int flags) throws javax.transaction.xa.XAException
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 interfacejavax.transaction.xa.XAResource
- Parameters:
xid
- A global transaction identifier to be associated with the resourceflags
- One of TMNOFLAGS, TMJOIN, or TMRESUME- Throws:
javax.transaction.xa.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
javax.transaction.xa.Xid getCurrentXid()
Resturns currently active xid- Returns:
- Xid
-
getTransactionState
private XATransactionState getTransactionState(XAXactId xid_im)
Returns the XATransactionState of the the transaction- Parameters:
xid_im
-- Returns:
- XATransactionState
-
checkUserCredentials
private void checkUserCredentials(EmbedXAResource original) throws javax.transaction.xa.XAException
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:
javax.transaction.xa.XAException
-
checkXAActive
private void checkXAActive() throws javax.transaction.xa.XAException
Checks if currently associated connection is active throws exception if not- Throws:
javax.transaction.xa.XAException
-
wrapInXAException
private static javax.transaction.xa.XAException wrapInXAException(java.sql.SQLException se)
Map a SQL exception to appropriate XAException. Return the mapped XAException.
-
wrapInXAException
private static javax.transaction.xa.XAException wrapInXAException(StandardException se)
Map a Standard exception to appropriate XAException. Return the mapped XAException.
-
returnConnectionToResource
void returnConnectionToResource(XATransactionState tranState, XAXactId xid_im)
Return an underlying connection object back to its XAResource if possible. If not close the connection.- Parameters:
tranState
-xid_im
-
-
closeUnusedConnection
private static void closeUnusedConnection(EmbedConnection conn)
Close an underlying connection object when there is no active XAResource to hand it to.- Parameters:
conn
-
-
removeXATransaction
void removeXATransaction(XAXactId xid_im)
Removes the xid from currently active transactions- Parameters:
xid_im
-
-
setCurrentXid
void setCurrentXid(XAXactId aCurrentXid)
-
getContextService
private static ContextService getContextService()
Privileged lookup of the ContextService. Must be private so that user code can't call this entry point.
-
getContextManager
private static ContextManager getContextManager(EmbedConnection conn)
Privileged lookup of the ContextManager. Must be private so that user code can't call this entry point.
-
getLanguageConnectionContext
private LanguageConnectionContext getLanguageConnectionContext(EmbedConnection conn)
Gets the LanguageConnectionContext for this connection.
-
getLanguageConnectionContext
private LanguageConnectionContext getLanguageConnectionContext(EmbedPooledConnection conn) throws java.sql.SQLException
Privileged LCC lookup. Must be private so that user code can't call this entry point.- Throws:
java.sql.SQLException
-
-