Package com.webmethods.jms.impl

Class WmXASessionImpl

java.lang.Object

com.webmethods.locks.Node

com.webmethods.jms.impl.WmSessionImpl

com.webmethods.jms.impl.WmXASessionImpl

All Implemented Interfaces:

WmSession, java.lang.Runnable, javax.jms.Session, javax.jms.XASession, javax.transaction.xa.XAResource

Direct Known Subclasses:

WmXAQueueSessionImpl, WmXATopicSessionImpl

public class WmXASessionImpl
extends WmSessionImpl
implements javax.jms.XASession, javax.transaction.xa.XAResource

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.jms.impl.WmSessionImpl

WmSessionImpl.SessionDispatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_transactionComplete

Fields inherited from class com.webmethods.jms.impl.WmSessionImpl

_acknowledgeMode, _closed, _closeInProgress, _connection, _currentAsyncMessage, _isXA, _logApi, _messageConsumers, _messageListener, _messageProducers, _messageQueue, _newMessageListeners, _sessionDispatcher, _sessionDispatcherCount, _sessionReconnect, _sessionSubscriberMessageConsumers, _transacted, _transactionID, _transactionTimeout, _xid, brokerName, DEFAULT_TRANSACTION_TIMEOUT

Fields inherited from class com.webmethods.locks.Node

_lockManager

Fields inherited from interface javax.jms.Session

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WmXASessionImpl(WmConnectionImpl connection)
	WmXASessionImpl(WmConnectionImpl connection, boolean transacted, int ackMode)

Method Summary

Modifier and Type	Method	Description
void	commit()	Commits all messages done in this transaction and releases any locks currently held.
void	commit(javax.transaction.xa.Xid xid, boolean onePhase)	Commits the global transaction specified by xid.
protected static WmXASessionImpl	createXASession(WmConnectionImpl connection, boolean transacted, int ackMode)
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)	Tells the resource manager to forget about a heuristically completed transaction branch.
javax.jms.Session	getSession()	Gets the session associated with this XASession.
boolean	getTransacted()	Indicates whether the session is in transacted mode.
int	getTransactionTimeout()	Obtains the current transaction timeout value set for this XAResource instance.
javax.transaction.xa.XAResource	getXAResource()	Returns an XA resource to the caller.
boolean	isSameRM(javax.transaction.xa.XAResource xaResource)	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.
boolean	isTransactionComplete()	Flag to determine if the current XA transaction is completed.
void	negativeAckMessageQueue()
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)	Obtains a list of prepared transaction branches from a resource manager.
void	rollback()	Rolls back any messages done in this transaction and releases any locks currently held.
void	rollback(javax.transaction.xa.Xid xid)	Informs the resource manager to roll back work done on behalf of a transaction branch.
boolean	setTransactionTimeout(int seconds)	Sets the current transaction timeout value for this XAResource instance.
void	start(javax.transaction.xa.Xid xid, int flags)	Starts work on behalf of a transaction branch specified in xid.

Methods inherited from class com.webmethods.jms.impl.WmSessionImpl

addMessageConsumer, addMessageProducer, addMessageToQueue, addSessionSubscriberMessageConsumer, checkCreateConsumer, checkCreateDurableConsumer, checkCreateProducer, checkForClusteringSupport, checkState, close, closeMessageConsumers, closeMessageProducers, createBrowser, createBrowser, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableSubscriber, createDurableSubscriber, createFileMessage, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createPublisher, createQueue, createQueueBrowserImpl, createReceiver, createReceiver, createSender, createStreamMessage, createSubscriber, createSubscriber, createTemporaryQueue, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, get_messageQueue, get_transactionID, getAcknowledgeMode, getBrokerName, getConnection, getDurableSubscriber, getExceptionListener, getMessageConsumers, getMessageListener, getSessionDispatcherThreadID, getTemporaryQueueName, getTemporaryTopicName, invokeExceptionListener, isTransacted, prepare, prepare, publish, publish, recover, recoverInternal, removeMessageConsumer, removeMessageProducer, removeSessionSubscriberMessageConsumer, run, sessionAcknowledge, sessionAcknowledgeInternal, setCurrentAsynMessage, setExceptionListener, setMessageListener, setMessageListener, setMessageQueue, start, stop, toString, unsubscribe, unsubscribe, validAcknowledgeMode

Methods inherited from class com.webmethods.locks.Node

getLockManager, getParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Session

close, createBrowser, createBrowser, createBytesMessage, createConsumer, createConsumer, createConsumer, createDurableSubscriber, createDurableSubscriber, createMapMessage, createMessage, createObjectMessage, createObjectMessage, createProducer, createQueue, createStreamMessage, createTemporaryQueue, createTemporaryTopic, createTextMessage, createTextMessage, createTopic, getAcknowledgeMode, getMessageListener, recover, run, setMessageListener, unsubscribe

Field Detail

_transactionComplete

protected boolean _transactionComplete

Constructor Detail

WmXASessionImpl

public WmXASessionImpl(WmConnectionImpl connection,
                       boolean transacted,
                       int ackMode)
                throws javax.jms.JMSException

Throws:

javax.jms.JMSException

WmXASessionImpl

protected WmXASessionImpl(WmConnectionImpl connection)

Method Detail

createXASession

protected static WmXASessionImpl createXASession(WmConnectionImpl connection,
                                                 boolean transacted,
                                                 int ackMode)
                                          throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getSession

public javax.jms.Session getSession()
                             throws javax.jms.JMSException

Gets the session associated with this XASession.

Specified by:

getSession in interface javax.jms.XASession

Returns:

the session object

Throws:

javax.jms.JMSException - if an internal error occurs.

getXAResource

public javax.transaction.xa.XAResource getXAResource()

Returns an XA resource to the caller.

Specified by:

getXAResource in interface javax.jms.XASession

Returns:

an XA resource to the caller

getTransacted

public boolean getTransacted()
                      throws javax.jms.JMSException

Indicates whether the session is in transacted mode.

Specified by:

getTransacted in interface javax.jms.Session

Specified by:

getTransacted in interface javax.jms.XASession

Overrides:

getTransacted in class WmSessionImpl

Returns:

true if the session is in transacted mode

Throws:

javax.jms.JMSException - if the JMS provider fails to return the transaction mode due to some internal error.

commit

public void commit()
            throws javax.jms.JMSException

Commits all messages done in this transaction and releases any locks currently held.

Specified by:

commit in interface javax.jms.Session

Specified by:

commit in interface javax.jms.XASession

Overrides:

commit in class WmSessionImpl

Throws:

javax.jms.JMSException - if the JMS provider fails to commit the transaction due to some internal error.

javax.jms.TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.

javax.jms.IllegalStateException - if the method is not called by a transacted session.

rollback

public void rollback()
              throws javax.jms.JMSException

Rolls back any messages done in this transaction and releases any locks currently held.

Specified by:

rollback in interface javax.jms.Session

Specified by:

rollback in interface javax.jms.XASession

Overrides:

rollback in class WmSessionImpl

Throws:

javax.jms.JMSException - if the JMS provider fails to roll back the transaction due to some internal error.

javax.jms.IllegalStateException - if the method is not called by a transacted session.

getTransactionTimeout

public int getTransactionTimeout()
                          throws javax.transaction.xa.XAException

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.

Specified by:

getTransactionTimeout in interface javax.transaction.xa.XAResource

Returns:

the transaction timeout value in seconds

Throws:

javax.transaction.xa.XAException - An error has occurred. Possible exception values are XAER_RMERR and XAER_RMFAIL.

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws javax.transaction.xa.XAException

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.

Specified by:

setTransactionTimeout in interface javax.transaction.xa.XAResource

Parameters:

seconds - The transaction timeout value in seconds

Returns:

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

isSameRM

public boolean isSameRM(javax.transaction.xa.XAResource xaResource)
                 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 interface javax.transaction.xa.XAResource

Parameters:

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

recover

public javax.transaction.xa.Xid[] recover(int flag)
                                   throws javax.transaction.xa.XAException

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.

Specified by:

recover in interface javax.transaction.xa.XAResource

Parameters:

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

Returns:

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.

Throws:

javax.transaction.xa.XAException - An error has occurred. Possible values are XAER_RMERR, XAER_RMFAIL, XAER_INVAL, and XAER_PROTO.

forget

public void forget(javax.transaction.xa.Xid xid)
            throws javax.transaction.xa.XAException

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

Specified by:

forget in interface javax.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.

prepare

public 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 interface javax.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.

commit

public void commit(javax.transaction.xa.Xid xid,
                   boolean onePhase)
            throws javax.transaction.xa.XAException

Commits the global transaction specified by xid. If the resource manager did not commit the transaction and the parameter 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.

Specified by:

commit in interface javax.transaction.xa.XAResource

Parameters:

xid - A global transaction identifier

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

negativeAckMessageQueue

public void negativeAckMessageQueue()
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

rollback

public void rollback(javax.transaction.xa.Xid xid)
              throws javax.transaction.xa.XAException

Informs the resource manager to roll back work done on behalf of a transaction branch. If the transaction branch is already marked rollback-only 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.

Specified by:

rollback in interface javax.transaction.xa.XAResource

Parameters:

xid - A global transaction identifier.

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.

end

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

Specified by:

end in interface javax.transaction.xa.XAResource

Parameters:

xid - A global transaction identifier that is the same as the identifier 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_RMFAIL, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB*.

start

public void start(javax.transaction.xa.Xid xid,
                  int flags)
           throws javax.transaction.xa.XAException

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.

Specified by:

start in interface javax.transaction.xa.XAResource

Parameters:

xid - A global transaction identifier to be associated with the resource.

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

isTransactionComplete

public boolean isTransactionComplete()

Flag to determine if the current XA transaction is completed. If true,the parent Cluster XA session can then switch to a new broker XA Session on the next transaction