org.mule.transport.jms
Class JmsMessageDispatcher

java.lang.Object
  org.mule.transport.AbstractTransportMessageHandler
      org.mule.transport.AbstractMessageDispatcher
          org.mule.transport.jms.JmsMessageDispatcher

All Implemented Interfaces:

org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.LifecycleStateEnabled, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.processor.MessageProcessor, org.mule.api.transport.Connectable, org.mule.api.transport.MessageDispatcher

public class JmsMessageDispatcher
extends org.mule.transport.AbstractMessageDispatcher

JmsMessageDispatcher is responsible for dispatching messages to JMS destinations. All JMS semantics apply and settings such as replyTo and QoS properties are read from the event properties or defaults are used (according to the JMS specification)

Nested Class Summary

protected class

JmsMessageDispatcher.ReplyToListener

Field Summary

Fields inherited from class org.mule.transport.AbstractMessageDispatcher

defaultOutboundTransformers, defaultResponseTransformers

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

Fields inherited from interface org.mule.api.transport.MessageDispatcher

RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

JmsMessageDispatcher(org.mule.api.endpoint.OutboundEndpoint endpoint)

Method Summary

protected void	applyOutboundTransformers(org.mule.api.MuleEvent event)
protected org.mule.api.MuleMessage	createMessageWithJmsMessagePayload(javax.jms.Message jmsMessage)
protected javax.jms.MessageConsumer	createReplyToConsumer(javax.jms.Message currentMessage, org.mule.api.MuleEvent event, javax.jms.Session session, javax.jms.Destination replyTo, boolean topic)
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispatch(org.mule.api.MuleEvent event)
protected void	doDispose()
protected org.mule.api.MuleMessage	doSend(org.mule.api.MuleEvent event)
protected javax.jms.Destination	getReplyToDestination(javax.jms.Message message, javax.jms.Session session, org.mule.api.MuleEvent event, boolean remoteSync, boolean topic)
protected void	handleMultiTx(javax.jms.Session session) Deprecated.
protected boolean	isDisableTemporaryDestinations()
protected boolean	isHandleReplyTo(javax.jms.Message msg, org.mule.api.MuleEvent event) Some JMS implementations do not support ReplyTo or require some further fiddling of the message
protected void	preTransformMessage(org.mule.api.MuleMessage message) This method is called before the current message is transformed.
protected void	processMessage(javax.jms.Message msg, org.mule.api.MuleEvent event) This method is called once the JMS message is created.

Methods inherited from class org.mule.transport.AbstractMessageDispatcher

applyResponseTransformers, createLifecycleManager, getDispatcherName, getEndpoint, getWorkManager, process, returnResponse, returnResponse

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, connectHandler, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, doStart, doStartHandler, doStop, getConnectEventId, getConnectionDescription, getConnector, getLifecycleState, initialise, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopped, isStopping, passivate, setEndpoint, start, stop, toString, validate, validateConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.MessageDispatcher

activate, createMuleMessage, createMuleMessage, getConnector, passivate, validate

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, getConnectionDescription, isConnected, validateConnection

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Startable

start

Methods inherited from interface org.mule.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Constructor Detail

JmsMessageDispatcher

public JmsMessageDispatcher(org.mule.api.endpoint.OutboundEndpoint endpoint)

Method Detail

doDispatch

protected void doDispatch(org.mule.api.MuleEvent event)
                   throws Exception

Specified by:

doDispatch in class org.mule.transport.AbstractMessageDispatcher

Throws:

Exception

doConnect

protected void doConnect()
                  throws Exception

Overrides:

doConnect in class org.mule.transport.AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Overrides:

doDisconnect in class org.mule.transport.AbstractTransportMessageHandler

Throws:

Exception

isDisableTemporaryDestinations

protected boolean isDisableTemporaryDestinations()

createMessageWithJmsMessagePayload

protected org.mule.api.MuleMessage createMessageWithJmsMessagePayload(javax.jms.Message jmsMessage)
                                                               throws Exception

Throws:

Exception

preTransformMessage

protected void preTransformMessage(org.mule.api.MuleMessage message)
                            throws Exception

This method is called before the current message is transformed. It can be used to do any message body or header processing before the transformer is called.

Parameters:

message - the current MuleMessage Being processed

Throws:

Exception

handleMultiTx

@Deprecated
protected void handleMultiTx(javax.jms.Session session)
                      throws Exception

Deprecated.

Throws:

Exception

doSend

protected org.mule.api.MuleMessage doSend(org.mule.api.MuleEvent event)
                                   throws Exception

Specified by:

doSend in class org.mule.transport.AbstractMessageDispatcher

Throws:

Exception

doDispose

protected void doDispose()

Overrides:

doDispose in class org.mule.transport.AbstractTransportMessageHandler

processMessage

protected void processMessage(javax.jms.Message msg,
                              org.mule.api.MuleEvent event)
                       throws javax.jms.JMSException

This method is called once the JMS message is created. It allows subclasses to alter the message if necessary.

Parameters:

msg - The JMS message that will be sent

event - the current event

Throws:

javax.jms.JMSException - if the JmsMessage cannot be written to, this should not happen because the JMSMessage passed in will always be newly created

isHandleReplyTo

protected boolean isHandleReplyTo(javax.jms.Message msg,
                                  org.mule.api.MuleEvent event)
                           throws javax.jms.JMSException

Some JMS implementations do not support ReplyTo or require some further fiddling of the message

Parameters:

msg - The JMS message that will be sent

event - the current event

Returns:

true if this request should honour any JMSReplyTo settings on the message

Throws:

javax.jms.JMSException - if the JmsMessage cannot be written to, this should not happen because the JMSMessage passed in will always be newly created

createReplyToConsumer

protected javax.jms.MessageConsumer createReplyToConsumer(javax.jms.Message currentMessage,
                                                          org.mule.api.MuleEvent event,
                                                          javax.jms.Session session,
                                                          javax.jms.Destination replyTo,
                                                          boolean topic)
                                                   throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getReplyToDestination

protected javax.jms.Destination getReplyToDestination(javax.jms.Message message,
                                                      javax.jms.Session session,
                                                      org.mule.api.MuleEvent event,
                                                      boolean remoteSync,
                                                      boolean topic)
                                               throws javax.jms.JMSException,
                                                      org.mule.api.endpoint.EndpointException,
                                                      org.mule.api.lifecycle.InitialisationException

Throws:

javax.jms.JMSException

org.mule.api.endpoint.EndpointException

org.mule.api.lifecycle.InitialisationException

applyOutboundTransformers

protected void applyOutboundTransformers(org.mule.api.MuleEvent event)
                                  throws org.mule.api.MuleException

Overrides:

applyOutboundTransformers in class org.mule.transport.AbstractMessageDispatcher

Throws:

org.mule.api.MuleException