ehcache-core 2.10.9.2 · net.sf.ehcache.transaction.xa.EhcacheXAResourceImpl

Modifier and Type	Field and Description
private final Ehcache	cache
private final OperationObserver<XaCommitOutcome>	commitObserver
private final ElementValueComparator	comparator
private volatile Xid	currentXid
private final List<XAExecutionListener>	listeners
private static final Logger	LOG
private static final long	MILLISECOND_PER_SECOND
private final XARequestProcessor	processor
private final OperationObserver<XaRecoveryOutcome>	recoveryObserver
private final OperationObserver<XaRollbackOutcome>	rollbackObserver
private final SoftLockManager	softLockManager
private final TransactionIDFactory	transactionIDFactory
private volatile int	transactionTimeout
private final TransactionManager	txnManager
private final Store	underlyingStore
private final ConcurrentMap<Xid, XATransactionContext>	xidToContextMap

Access	Constructor and Description
public	EhcacheXAResourceImpl(Ehcache the cache cache, Store the underlying store underlyingStore, TransactionManagerLookup the transaction manager lookup txnManagerLookup, SoftLockManager the soft lock manager softLockManager, TransactionIDFactory the transaction ID factory transactionIDFactory, ElementValueComparator the element value comparator comparator, OperationObserver<XaCommitOutcome> commitObserver, OperationObserver<XaRollbackOutcome> rollbackObserver, OperationObserver<XaRecoveryOutcome> recoveryObserver) Constructor

Method Summary

Modifier and Type	Method and Description
public void	addTwoPcExecutionListener(XAExecutionListener the XAExecutionListener listener) Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.addTwoPcExecutionListener. Add a listener which will be called back according to the 2PC lifecycle
public 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. Commits the global transaction specified by xid.
public void	commitInternal(Xid a XID xid, boolean true if onePhase, false otherwise onePhase) The commit implementation
public XATransactionContext	createTransactionContext() Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.createTransactionContext. Obtain the already associated `XATransactionContext` with the current Transaction, or create a new one should none be there yet.
public void	end(Xid A global transaction identifier that is the same as the identifier used previously in the `start` method. xid, int One of TMSUCCESS, TMFAIL, or TMSUSPEND. flag) Implements javax.transaction.xa.XAResource.end. Ends the work performed on behalf of a transaction branch.
private void	fireAfterCommitOrRollback()
private void	fireBeforePrepare()
public void	forget(Xid A global transaction identifier. xid) Implements javax.transaction.xa.XAResource.forget. Tells the resource manager to forget about a heuristically completed transaction branch.
public void	forgetInternal(Xid a XID xid) The forget implementation
public String	getCacheName() Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCacheName. Getter to the name of the cache wrapped by this XAResource
public XATransactionContext	getCurrentTransactionContext() Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCurrentTransactionContext. Gets the current `XATransactionContext` associated with this resource
public int	getTransactionTimeout() Implements javax.transaction.xa.XAResource.getTransactionTimeout. Obtains the current transaction timeout value set for this XAResource instance.
public boolean	isSameRM(XAResource An XAResource object whose resource manager instance is to be compared with the resource manager instance of the target object. xaResource) 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 resource manager instance represented by the parameter xares.
public int	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 int	Returns: XA_OK or XA_RDONLY prepareInternal(Xid a XID xid) The prepare implementation
private static String	prettyPrintXAResourceFlags(int flags)
public Xid[]	recover(int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. flags) Implements javax.transaction.xa.XAResource.recover. Obtains a list of prepared transaction branches from a resource manager.
public void	rollback(Xid A global transaction identifier. xid) Implements javax.transaction.xa.XAResource.rollback. Informs the resource manager to roll back work done on behalf of a transaction branch.
public void	rollbackInternal(Xid a XID xid) The rollback implementation
public boolean	setTransactionTimeout(int The transaction timeout value in seconds. timeout) Implements javax.transaction.xa.XAResource.setTransactionTimeout. Sets the current transaction timeout value for this `XAResource` instance.
public void	start(Xid A global transaction identifier to be associated with the resource. xid, int One of TMNOFLAGS, TMJOIN, or TMRESUME. flag) Implements javax.transaction.xa.XAResource.start. Starts work on behalf of a transaction branch specified in `xid`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

cache	back to summary
private final Ehcache cache

commitObserver	back to summary
private final OperationObserver<XaCommitOutcome> commitObserver

comparator	back to summary
private final ElementValueComparator comparator

currentXid	back to summary
private volatile Xid currentXid

listeners	back to summary
private final List<XAExecutionListener> listeners

LOG	back to summary
private static final Logger LOG

MILLISECOND_PER_SECOND	back to summary
private static final long MILLISECOND_PER_SECOND

processor	back to summary
private final XARequestProcessor processor

recoveryObserver	back to summary
private final OperationObserver<XaRecoveryOutcome> recoveryObserver

rollbackObserver	back to summary
private final OperationObserver<XaRollbackOutcome> rollbackObserver

softLockManager	back to summary
private final SoftLockManager softLockManager

transactionIDFactory	back to summary
private final TransactionIDFactory transactionIDFactory

transactionTimeout	back to summary
private volatile int transactionTimeout

txnManager	back to summary
private final TransactionManager txnManager

underlyingStore	back to summary
private final Store underlyingStore

xidToContextMap	back to summary
private final ConcurrentMap<Xid, XATransactionContext> xidToContextMap

EhcacheXAResourceImpl	back to summary
public EhcacheXAResourceImpl(Ehcache cache, Store underlyingStore, TransactionManagerLookup txnManagerLookup, SoftLockManager softLockManager, TransactionIDFactory transactionIDFactory, ElementValueComparator comparator, OperationObserver<XaCommitOutcome> commitObserver, OperationObserver<XaRollbackOutcome> rollbackObserver, OperationObserver<XaRecoveryOutcome> recoveryObserver) Constructor Parameters cache:Ehcache the cache underlyingStore:Store the underlying store txnManagerLookup:TransactionManagerLookup the transaction manager lookup softLockManager:SoftLockManager the soft lock manager transactionIDFactory:TransactionIDFactory the transaction ID factory comparator:ElementValueComparator the element value comparator

Method Detail

addTwoPcExecutionListener	back to summary
public void addTwoPcExecutionListener(XAExecutionListener listener) Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.addTwoPcExecutionListener. Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.addTwoPcExecutionListener. Add a listener which will be called back according to the 2PC lifecycle Parameters listener:XAExecutionListener the XAExecutionListener

addTwoPcExecutionListener

back to summary

public void addTwoPcExecutionListener(XAExecutionListener listener)

Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.addTwoPcExecutionListener.

Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.addTwoPcExecutionListener.

Add a listener which will be called back according to the 2PC lifecycle

Parameters

listener:XAExecutionListener: the XAExecutionListener

commit	back to summary
public void commit(Xid xid, boolean onePhase) throws XAException Implements javax.transaction.xa.XAResource.commit. Doc from javax.transaction.xa.XAResource.commit. Commits 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 void commit(Xid xid, boolean onePhase) throws XAException

Implements javax.transaction.xa.XAResource.commit.

Doc from javax.transaction.xa.XAResource.commit.

Commits 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.

commitInternal	back to summary
public void commitInternal(Xid xid, boolean onePhase) throws XAException The commit implementation Parameters xid:Xid a XID onePhase:boolean true if onePhase, false otherwise Exceptions XAException: when an error occurs

commitInternal

back to summary

public void commitInternal(Xid xid, boolean onePhase) throws XAException

The commit implementation

Parameters

xid:Xid: a XID
onePhase:boolean: true if onePhase, false otherwise

Exceptions

XAException:: when an error occurs

createTransactionContext back to summary

createTransactionContext	back to summary
public XATransactionContext createTransactionContext() throws SystemException, RollbackException Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.createTransactionContext. Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.createTransactionContext. Obtain the already associated `XATransactionContext` with the current Transaction, or create a new one should none be there yet. Returns:XATransactionContext The associated Transaction associated `XATransactionContext` Exceptions SystemException: Thrown if the associated transaction manager encounters an unexpected error condition. RollbackException: Thrown if the resource has to be enlisted with the transaction, while it is marked for rollback only.

public XATransactionContext createTransactionContext() throws SystemException, RollbackException

Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.createTransactionContext.

Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.createTransactionContext.

Obtain the already associated XATransactionContext with the current Transaction, or create a new one should none be there yet.

Returns:XATransactionContext

The associated Transaction associated XATransactionContext

Exceptions

SystemException:: Thrown if the associated transaction manager encounters an unexpected error condition.
RollbackException:: Thrown if the resource has to be enlisted with the transaction, while it is marked for rollback only.

end back to summary

end	back to summary
public void end(Xid xid, int flag) throws XAException Implements javax.transaction.xa.XAResource.end. Doc from 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 lets the transaction complete. If TMSUSPEND is specified in the flags, the transaction branch is temporarily suspended in an incomplete state. The transaction context is in a suspended state and must be resumed via the `start` method 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 the identifier used previously in the `start` method. flag: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*.

public void end(Xid xid, int flag) throws XAException

Implements javax.transaction.xa.XAResource.end.

Doc from 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 lets the transaction complete.

If TMSUSPEND is specified in the flags, the transaction branch is temporarily suspended in an incomplete state. The transaction context is in a suspended state and must be resumed via the start method 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 the identifier used previously in the start method.
flag: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*.

fireAfterCommitOrRollback	back to summary
private void fireAfterCommitOrRollback()

fireBeforePrepare	back to summary
private void fireBeforePrepare()

forget	back to summary
public void forget(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.forget. Doc from javax.transaction.xa.XAResource.forget. Tells 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 void forget(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.forget.

Doc from javax.transaction.xa.XAResource.forget.

Tells 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.

forgetInternal	back to summary
public void forgetInternal(Xid xid) throws XAException The forget implementation Parameters xid:Xid a XID Exceptions XAException: when an error occurs

forgetInternal

back to summary

public void forgetInternal(Xid xid) throws XAException

The forget implementation

Parameters

xid:Xid: a XID

Exceptions

XAException:: when an error occurs

getCacheName back to summary

getCacheName	back to summary
public String getCacheName() Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCacheName. Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.getCacheName. Getter to the name of the cache wrapped by this XAResource Returns:String `net.sf.ehcache.Ehcache#getName` value

public String getCacheName()

Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCacheName.

Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.getCacheName.

Getter to the name of the cache wrapped by this XAResource

Returns:String: net.sf.ehcache.Ehcache#getName value

getCurrentTransactionContext back to summary

getCurrentTransactionContext	back to summary
public XATransactionContext getCurrentTransactionContext() Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCurrentTransactionContext. Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.getCurrentTransactionContext. Gets the current `XATransactionContext` associated with this resource Returns:XATransactionContext the current `XATransactionContext`, or null if none

public XATransactionContext getCurrentTransactionContext()

Implements net.sf.ehcache.transaction.xa.EhcacheXAResource.getCurrentTransactionContext.

Doc from net.sf.ehcache.transaction.xa.EhcacheXAResource.getCurrentTransactionContext.

Gets the current XATransactionContext associated with this resource

Returns:XATransactionContext: the current XATransactionContext, or null if none

getTransactionTimeout back to summary

getTransactionTimeout	back to summary
public int getTransactionTimeout() throws XAException Implements javax.transaction.xa.XAResource.getTransactionTimeout. Doc from javax.transaction.xa.XAResource.getTransactionTimeout. Obtains the current transaction timeout value set for this XAResource instance. If `XAResource.setTransactionTimeout` was not used prior to invoking this method, the return value is the default timeout set for the resource manager; otherwise, the value used in the previous `setTransactionTimeout` call is returned. Returns:int the transaction timeout value in seconds. Exceptions XAException: An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

public int getTransactionTimeout() throws XAException

Implements javax.transaction.xa.XAResource.getTransactionTimeout.

Doc from javax.transaction.xa.XAResource.getTransactionTimeout.

Obtains the current transaction timeout value set for this XAResource instance. If XAResource.setTransactionTimeout was not used prior to invoking this method, the return value is the default timeout set for the resource manager; otherwise, the value used in the previous setTransactionTimeout call is returned.

Returns:int

the transaction timeout value in seconds.

Exceptions

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

isSameRM	back to summary
public boolean isSameRM(XAResource xaResource) throws XAException Implements javax.transaction.xa.XAResource.isSameRM. Doc from 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 resource manager instance represented by the parameter xares. Parameters xaResource: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 and XAER_RMFAIL.

isSameRM

back to summary

public boolean isSameRM(XAResource xaResource) throws XAException

Implements javax.transaction.xa.XAResource.isSameRM.

Doc from 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 resource manager instance represented by the parameter xares.

Parameters

xaResource: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 and XAER_RMFAIL.

prepare	back to summary
public int prepare(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.prepare. Doc from 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 int prepare(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.prepare.

Doc from 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.

prepareInternal	back to summary
public int prepareInternal(Xid xid) throws XAException The prepare implementation Parameters xid:Xid a XID Returns:int XA_OK or XA_RDONLY Exceptions XAException: when an error occurs

prepareInternal

back to summary

public int prepareInternal(Xid xid) throws XAException

The prepare implementation

Parameters

xid:Xid: a XID

Returns:int

XA_OK or XA_RDONLY

Exceptions

XAException:: when an error occurs

prettyPrintXAResourceFlags	back to summary
private static String prettyPrintXAResourceFlags(int flags)

recover	back to summary
public Xid[] recover(int flags) throws XAException Implements javax.transaction.xa.XAResource.recover. Doc from javax.transaction.xa.XAResource.recover. Obtains 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 flags:int One of TMSTARTRSCAN, TMENDRSCAN, TMNOFLAGS. TMNOFLAGS must be used when no other flags are set in the parameter. Returns:Xid[] The resource manager returns zero or more XIDs of 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 Xid[] recover(int flags) throws XAException

Implements javax.transaction.xa.XAResource.recover.

Doc from javax.transaction.xa.XAResource.recover.

Obtains 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

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

Returns:Xid[]

The resource manager returns zero or more XIDs of 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.

rollback	back to summary
public void rollback(Xid xid) throws XAException Implements javax.transaction.xa.XAResource.rollback. Doc from javax.transaction.xa.XAResource.rollback. Informs 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 void rollback(Xid xid) throws XAException

Implements javax.transaction.xa.XAResource.rollback.

Doc from javax.transaction.xa.XAResource.rollback.

Informs 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.

rollbackInternal	back to summary
public void rollbackInternal(Xid xid) throws XAException The rollback implementation Parameters xid:Xid a XID Exceptions XAException: when an error occurs

rollbackInternal

back to summary

public void rollbackInternal(Xid xid) throws XAException

The rollback implementation

Parameters

xid:Xid: a XID

Exceptions

XAException:: when an error occurs

setTransactionTimeout back to summary

setTransactionTimeout	back to summary
public boolean setTransactionTimeout(int timeout) throws XAException Implements javax.transaction.xa.XAResource.setTransactionTimeout. Doc from javax.transaction.xa.XAResource.setTransactionTimeout. Sets 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 explicitly setting the transaction timeout value, this method returns false. Parameters timeout:int The transaction timeout value in seconds. Returns:boolean true if the 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.

public boolean setTransactionTimeout(int timeout) throws XAException

Implements javax.transaction.xa.XAResource.setTransactionTimeout.

Doc from javax.transaction.xa.XAResource.setTransactionTimeout.

Sets 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 explicitly setting the transaction timeout value, this method returns false.

Parameters

timeout:int: The transaction timeout value in seconds.

Returns:boolean

true if the 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

start	back to summary
public void start(Xid xid, int flag) throws XAException Implements javax.transaction.xa.XAResource.start. Doc from javax.transaction.xa.XAResource.start. Starts work on behalf of a transaction branch specified in `xid`. If TMJOIN is specified, the start applies to joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start applies to resuming 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. flag: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.

public void start(Xid xid, int flag) throws XAException

Implements javax.transaction.xa.XAResource.start.

Doc from javax.transaction.xa.XAResource.start.

Starts work on behalf of a transaction branch specified in xid. If TMJOIN is specified, the start applies to joining a transaction previously seen by the resource manager. If TMRESUME is specified, the start applies to resuming 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.
flag: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.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class EhcacheXAResourceImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail