Package com.webmethods.jms

Interface WmSession

All Superinterfaces:

java.lang.Runnable, javax.jms.Session

All Known Implementing Classes:

WmClusterQueueSessionImpl, WmClusterSessionImpl, WmClusterTopicSessionImpl, WmClusterXAQueueSessionImpl, WmClusterXASessionImpl, WmClusterXATopicSessionImpl, WmCompositeClusterQueueSessionImpl, WmCompositeClusterSessionImpl, WmCompositeClusterTopicSessionImpl, WmCompositeClusterXAQueueSessionImpl, WmCompositeClusterXASessionImpl, WmCompositeClusterXATopicSessionImpl, WmQueueSessionImpl, WmSessionImpl, WmTopicSessionImpl, WmXAQueueSessionImpl, WmXASessionImpl, WmXATopicSessionImpl

public interface WmSession
extends javax.jms.Session

Interface defining webMethods extensions to javax.jms.Session and its subclasses.

Field Summary

Fields inherited from interface javax.jms.Session

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Method Summary

Modifier and Type	Method	Description
WmFileMessage	createFileMessage()	Creates a WmFileMessage object.
javax.jms.ExceptionListener	getExceptionListener()	Gets the ExceptionListener object for this session.
void	setExceptionListener(javax.jms.ExceptionListener listener)	Sets an exception listener for this session.

Methods inherited from interface javax.jms.Session

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

Method Detail

getExceptionListener

javax.jms.ExceptionListener getExceptionListener()
                                          throws javax.jms.JMSException

Gets the ExceptionListener object for this session.

Returns:

the ExceptionListener for this session, or null. if no ExceptionListener is associated with this session.

Throws:

javax.jms.JMSException - if the JMS provider fails to get the ExceptionListener for this session.

See Also:

setExceptionListener(javax.jms.ExceptionListener)

setExceptionListener

void setExceptionListener(javax.jms.ExceptionListener listener)
                   throws javax.jms.JMSException

Sets an exception listener for this session.

If an exception is thrown by a user-defined MessageListener's run() method from one of the session's MessageConsumers, it informs the sessions's ExceptionListener, if one has been registered. It does this by calling the listener's onException method, passing it a JMSException object with a linked exception containing the exception thrown by the MessageListener's run() method.

Parameters:

listener - the exception listener

Throws:

javax.jms.JMSException - if the JMS provider fails to set the exception listener for this session.

See Also:

getExceptionListener()

createFileMessage

WmFileMessage createFileMessage()
                         throws javax.jms.JMSException

Creates a WmFileMessage object. A WmFileMessage object is used to stream a file that is to large to load into memory.

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.