org.mule.transport

Class AbstractMessageDispatcher

java.lang.Object

org.mule.transport.AbstractConnectable

org.mule.transport.AbstractMessageDispatcher

All Implemented Interfaces:

ExceptionListener, Disposable, Connectable, MessageDispatcher, MessageDispatching

Direct Known Subclasses:

HttpClientMessageDispatcher, JmsMessageDispatcher, ProcessMessageDispatcher, QuartzMessageDispatcher, RmiMessageDispatcher, StdioMessageDispatcher, TcpMessageDispatcher, UdpMessageDispatcher, UnsupportedMessageDispatcher, VMMessageDispatcher

public abstract class AbstractMessageDispatcher
extends AbstractConnectable
implements MessageDispatcher

Provide a default dispatch (client) support for handling threads lifecycle and validation.

Field Summary

Fields inherited from class org.mule.transport.AbstractConnectable

connected, connecting, connectionStrategy, connector, disposed, endpoint, logger

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

PHASE_NAME

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

RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY

Constructor Summary

Constructors

Constructor and Description
AbstractMessageDispatcher(OutboundEndpoint endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(MuleEvent event) Dispatches an event from the endpoint to the external system
protected abstract void	doDispatch(MuleEvent event)
protected abstract MuleMessage	doSend(MuleEvent event)
protected boolean	isTransactionRollback() Checks to see if the current transaction has been rolled back
MuleMessage	send(MuleEvent event) Sends an event from the endpoint to the external system
protected boolean	useRemoteSync(MuleEvent event) RemoteSync causes the message dispatch to wait for a response to an event on a response channel after it sends the event.

Methods inherited from class org.mule.transport.AbstractConnectable

activate, connect, disconnect, dispose, disposeAndLogException, doConnect, doDisconnect, doDispose, exceptionThrown, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, isConnected, isDoThreading, passivate, reconnect, toString, validate

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, getConnector, passivate, validate

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

dispose

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

connect, disconnect, getConnectionDescription, isConnected

Constructor Detail

AbstractMessageDispatcher

public AbstractMessageDispatcher(OutboundEndpoint endpoint)

Method Detail

dispatch

public final void dispatch(MuleEvent event)
                    throws DispatchException

Description copied from interface: MessageDispatching

Dispatches an event from the endpoint to the external system

Specified by:

dispatch in interface MessageDispatching

Parameters:

event - The event to dispatch

Throws:

DispatchException - if the event fails to be dispatched

send

public final MuleMessage send(MuleEvent event)
                       throws DispatchException

Description copied from interface: MessageDispatching

Sends an event from the endpoint to the external system

Specified by:

send in interface MessageDispatching

Parameters:

event - The event to send

Returns:

event the response form the external system wrapped in a MuleEvent

Throws:

DispatchException - if the event fails to be dispatched

useRemoteSync

protected boolean useRemoteSync(MuleEvent event)

RemoteSync causes the message dispatch to wait for a response to an event on a response channel after it sends the event. The following rules apply to RemoteSync 1. The connector has to support remoteSync. Some transports do not have the notion of a response channel 2. Check if the endpoint has been configured for remoteSync 3. Check if the REMOTE_SYNC message header has been set 4. Finally, if the current service has a response router configured, that the router will handle the response channel event and we should not try and receive a response in the Message dispatcher If remotesync should not be used we must remove the REMOTE_SYNC header Note the MuleClient will automatically set the REMOTE_SYNC header when client.send(..) is called so that results are returned from remote invocations too.

Parameters:

event - the current event

Returns:

true if a response channel should be used to get a resposne from the event dispatch.

isTransactionRollback

protected boolean isTransactionRollback()

Checks to see if the current transaction has been rolled back

Returns:

doDispatch

protected abstract void doDispatch(MuleEvent event)
                            throws Exception

Throws:

Exception

doSend

protected abstract MuleMessage doSend(MuleEvent event)
                               throws Exception

Throws:

Exception