Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.jdbc.EmbedXAResource

Modifier and Type	Field and 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.

Access	Constructor and Description
pack-priv	EmbedXAResource(EmbedPooledConnection con, ResourceAdapter ra)

Method Summary

Modifier and Type	Method and Description
private void	checkUserCredentials(EmbedXAResource 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 mismatch
private void	checkXAActive() Checks if currently associated connection is active throws exception if not
private static void	closeUnusedConnection(EmbedConnection conn) Close an underlying connection object when there is no active XAResource to hand it to.
public final synchronized void	commit(Xid A global transaction identifier xid, boolean If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid. onePhase) Implements javax.transaction.xa.XAResource.commit. Commit the global transaction specified by xid.
public final synchronized void	end(Xid A global transaction identifier that is the same as what was used previously in the start method. xid, int One of TMSUCCESS, TMFAIL, or TMSUSPEND flags) Implements javax.transaction.xa.XAResource.end. Ends the work performed on behalf of a transaction branch.
public final synchronized void	forget(Xid A global transaction identifier xid) Implements javax.transaction.xa.XAResource.forget. Tell the resource manager to forget about a heuristically completed transaction branch.
private static ContextManager	getContextManager(final EmbedConnection conn) Must be private so that user code can't call this entry point.
private static ContextService	getContextService() Must be private so that user code can't call this entry point.
pack-priv Xid	Returns: Xid getCurrentXid() Resturns currently active xid
private long	getDefaultXATransactionTimeout() Returns the default value for the transaction timeout in milliseconds setted up by the system properties.
private LanguageConnectionContext	getLanguageConnectionContext(final EmbedConnection conn) Gets the LanguageConnectionContext for this connection.
private LanguageConnectionContext	getLanguageConnectionContext(final EmbedPooledConnection conn) Must be private so that user code can't call this entry point.
private XATransactionState	Returns: XATransactionState getTransactionState(XAXactId xid_im) Returns the XATransactionState of the the transaction
public synchronized int	Returns: the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout. getTransactionTimeout() Implements javax.transaction.xa.XAResource.getTransactionTimeout. Obtain the current transaction timeout value set for this XAResource instance.
public final synchronized boolean	Returns: true if it's the same RM instance; otherwise false. isSameRM(XAResource An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object. xares) Implements javax.transaction.xa.XAResource.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.
public final synchronized int	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. prepare(Xid A global transaction identifier xid) Implements javax.transaction.xa.XAResource.prepare. Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.
public final synchronized Xid[]	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. recover(int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in flags. flag) Implements javax.transaction.xa.XAResource.recover. Obtain a list of prepared transaction branches from a resource manager.
pack-priv void	removeXATransaction(XAXactId xid_im) Removes the xid from currently active transactions
pack-priv void	returnConnectionToResource(XATransactionState tranState, XAXactId xid_im) Return an underlying connection object back to its XAResource if possible.
public final synchronized void	rollback(Xid A global transaction identifier xid) Implements javax.transaction.xa.XAResource.rollback. Inform the resource manager to roll back work done on behalf of a transaction branch
pack-priv void	setCurrentXid(XAXactId aCurrentXid)
public synchronized boolean	Returns: true if transaction timeout value is set successfully; otherwise false. setTransactionTimeout(int the transaction timeout value in seconds. Value of 0 means the reasource manager's default value. Value of Integer.MAX_VALUE means no timeout. seconds) Implements javax.transaction.xa.XAResource.setTransactionTimeout. Set the current transaction timeout value for this XAResource instance.
public final synchronized void	start(Xid A global transaction identifier to be associated with the resource xid, int One of TMNOFLAGS, TMJOIN, or TMRESUME flags) Implements javax.transaction.xa.XAResource.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.
private static XAException	wrapInXAException(SQLException se) Map a SQL exception to appropriate XAException.
private static XAException	wrapInXAException(StandardException se) Map a Standard exception to appropriate XAException.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

con	back to summary
private EmbedPooledConnection con

currentXid	back to summary
private XAXactId currentXid

lcc	back to summary
private LanguageConnectionContext lcc

ra	back to summary
private ResourceAdapter ra

timeoutSeconds	back to summary
private int timeoutSeconds The value of the transaction timeout on this resource.

EmbedXAResource	back to summary
pack-priv EmbedXAResource(EmbedPooledConnection con, ResourceAdapter ra)

Method Detail

checkUserCredentials	back to summary
private void checkUserCredentials(EmbedXAResource original) throws 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 EmbedXAResource

checkUserCredentials

back to summary

private void checkUserCredentials(EmbedXAResource original) throws 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: EmbedXAResource

checkXAActive	back to summary
private void checkXAActive() throws XAException Checks if currently associated connection is active throws exception if not

closeUnusedConnection	back to summary
private static void closeUnusedConnection(EmbedConnection conn) Close an underlying connection object when there is no active XAResource to hand it to.

commit	back to summary
public final synchronized void commit(Xid xid, boolean onePhase) throws XAException Implements javax.transaction.xa.XAResource.commit. Commit the global transaction specified by xid. Parameters xid:Xid A global transaction identifier onePhase:boolean If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid. Exceptions 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.

commit

back to summary

public final synchronized void commit(Xid xid, boolean onePhase) throws XAException

Implements javax.transaction.xa.XAResource.commit.

Commit the global transaction specified by xid.

Parameters

xid:Xid: A global transaction identifier
onePhase:boolean: If true, the resource manager should use a one-phase commit protocol to commit the work done on behalf of xid.

Exceptions

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	back to summary
public final synchronized void end(Xid xid, int flags) throws XAException Implements javax.transaction.xa.XAResource.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. Parameters xid:Xid A global transaction identifier that is the same as what was used previously in the start method. flags:int One of TMSUCCESS, TMFAIL, or TMSUSPEND Exceptions XAException: An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.

end

back to summary

public final synchronized void end(Xid xid, int flags) throws XAException

Implements javax.transaction.xa.XAResource.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.

Parameters

xid:Xid: A global transaction identifier that is the same as what was used previously in the start method.
flags:int: One of TMSUCCESS, TMFAIL, or TMSUSPEND

Exceptions

XAException:: An error has occurred. Possible XAException values are XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.

forget	back to summary
public final synchronized void forget(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.forget. Tell the resource manager to forget about a heuristically completed transaction branch. Parameters xid:Xid A global transaction identifier Exceptions XAException: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

forget

back to summary

public final synchronized void forget(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.forget.

Tell the resource manager to forget about a heuristically completed transaction branch.

Parameters

xid:Xid: A global transaction identifier

Exceptions

XAException:: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

getContextManager	back to summary
private static ContextManager getContextManager(final EmbedConnection conn) Must be private so that user code can't call this entry point.

getContextService	back to summary
private static ContextService getContextService() Must be private so that user code can't call this entry point.

getCurrentXid	back to summary
pack-priv Xid getCurrentXid() Resturns currently active xid Returns:Xid Xid

getCurrentXid

back to summary

pack-priv Xid getCurrentXid()

Resturns currently active xid

Returns:Xid: Xid

getDefaultXATransactionTimeout	back to summary
private long getDefaultXATransactionTimeout() throws XAException Returns the default value for the transaction timeout in milliseconds setted up by the system properties.

getLanguageConnectionContext	back to summary
private LanguageConnectionContext getLanguageConnectionContext(final EmbedConnection conn) Gets the LanguageConnectionContext for this connection.

getLanguageConnectionContext	back to summary
private LanguageConnectionContext getLanguageConnectionContext(final EmbedPooledConnection conn) throws SQLException Must be private so that user code can't call this entry point.

getTransactionState	back to summary
private XATransactionState getTransactionState(XAXactId xid_im) Returns the XATransactionState of the the transaction Returns:XATransactionState XATransactionState

getTransactionState

back to summary

private XATransactionState getTransactionState(XAXactId xid_im)

Returns the XATransactionState of the the transaction

Returns:XATransactionState: XATransactionState

getTransactionTimeout	back to summary
public synchronized int getTransactionTimeout() Implements javax.transaction.xa.XAResource.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. Returns:int the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout.

getTransactionTimeout

back to summary

public synchronized int getTransactionTimeout()

Implements javax.transaction.xa.XAResource.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.

Returns:int: the transaction timeout value in seconds. If the returned value is equal to Integer.MAX_VALUE it means no timeout.

isSameRM	back to summary
public final synchronized boolean isSameRM(XAResource xares) throws XAException Implements javax.transaction.xa.XAResource.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. Parameters xares:XAResource An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object. Returns:boolean true if it's the same RM instance; otherwise false. Exceptions XAException: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

isSameRM

back to summary

public final synchronized boolean isSameRM(XAResource xares) throws XAException

Implements javax.transaction.xa.XAResource.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.

Parameters

xares:XAResource: An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object.

Returns:boolean

true if it's the same RM instance; otherwise false.

Exceptions

XAException:: An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL.

prepare	back to summary
public final synchronized int prepare(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.prepare. Ask the resource manager to prepare for a transaction commit of the transaction specified in xid. Parameters xid:Xid A global transaction identifier Returns:int 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. Exceptions XAException: An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

prepare

back to summary

public final synchronized int prepare(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.prepare.

Ask the resource manager to prepare for a transaction commit of the transaction specified in xid.

Parameters

xid:Xid: A global transaction identifier

Returns:int

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.

Exceptions

XAException:: An error has occurred. Possible exception values are: XA_RB*, XAER_RMERR, XAER_RMFAIL, XAER_NOTA, XAER_INVAL, or XAER_PROTO.

recover	back to summary
public final synchronized Xid[] recover(int flag) throws XAException Implements javax.transaction.xa.XAResource.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. Parameters flag:int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in flags. Returns:Xid[] 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. Exceptions XAException: An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

recover

back to summary

public final synchronized Xid[] recover(int flag) throws XAException

Implements javax.transaction.xa.XAResource.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.

Parameters

flag:int: One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in flags.

Returns:Xid[]

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.

Exceptions

XAException:: An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

removeXATransaction	back to summary
pack-priv void removeXATransaction(XAXactId xid_im) Removes the xid from currently active transactions

returnConnectionToResource	back to summary
pack-priv void returnConnectionToResource(XATransactionState tranState, XAXactId xid_im) Return an underlying connection object back to its XAResource if possible. If not close the connection.

rollback	back to summary
public final synchronized void rollback(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.rollback. Inform the resource manager to roll back work done on behalf of a transaction branch Parameters xid:Xid A global transaction identifier Exceptions XAException: - An error has occurred

rollback

back to summary

public final synchronized void rollback(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.rollback.

Inform the resource manager to roll back work done on behalf of a transaction branch

Parameters

xid:Xid: A global transaction identifier

Exceptions

XAException:: - An error has occurred

setCurrentXid	back to summary
pack-priv void setCurrentXid(XAXactId aCurrentXid)

setTransactionTimeout	back to summary
public synchronized boolean setTransactionTimeout(int seconds) throws XAException Implements javax.transaction.xa.XAResource.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. Parameters seconds:int 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:boolean true if transaction timeout value is set successfully; otherwise false. Exceptions XAException: - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

setTransactionTimeout

back to summary

public synchronized boolean setTransactionTimeout(int seconds) throws XAException

Implements javax.transaction.xa.XAResource.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.

Parameters

seconds:int: 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:boolean

true if transaction timeout value is set successfully; otherwise false.

Exceptions

XAException:: - An error has occurred. Possible exception values are XAER_RMERR, XAER_RMFAIL, or XAER_INVAL.

start	back to summary
public final synchronized void start(Xid xid, int flags) throws XAException Implements javax.transaction.xa.XAResource.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. Parameters xid:Xid A global transaction identifier to be associated with the resource flags:int One of TMNOFLAGS, TMJOIN, or TMRESUME Exceptions 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.

start

back to summary

public final synchronized void start(Xid xid, int flags) throws XAException

Implements javax.transaction.xa.XAResource.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.

Parameters

xid:Xid: A global transaction identifier to be associated with the resource
flags:int: One of TMNOFLAGS, TMJOIN, or TMRESUME

Exceptions

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.

wrapInXAException	back to summary
private static XAException wrapInXAException(SQLException se) Map a SQL exception to appropriate XAException. Return the mapped XAException.

wrapInXAException	back to summary
private static XAException wrapInXAException(StandardException se) Map a Standard exception to appropriate XAException. Return the mapped XAException.

pack-priv Class EmbedXAResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail