org.mule.api.transport
Interface MessageDispatcher

All Superinterfaces:
Connectable, Disposable, Initialisable, MessageDispatching, Startable, Stoppable
All Known Implementing Classes:
AbstractMessageDispatcher, AxisMessageDispatcher, AxisWsdlMessageDispatcher, CxfMessageDispatcher, CxfWsdlMessageDispatcher, EjbMessageDispatcher, FileMessageDispatcher, FtpMessageDispatcher, HttpClientMessageDispatcher, JdbcMessageDispatcher, JmsMessageDispatcher, ProcessMessageDispatcher, QuartzMessageDispatcher, RmiMessageDispatcher, SmtpMessageDispatcher, StdioMessageDispatcher, TcpMessageDispatcher, UdpMessageDispatcher, UnsupportedMessageDispatcher, VMMessageDispatcher, XmppMessageDispatcher

public interface MessageDispatcher
extends Connectable, MessageDispatching

Combine MessageDispatching with various lifecycle methods for the actual instances doing message sending.


Field Summary
 
Fields inherited from interface org.mule.api.lifecycle.Initialisable
PHASE_NAME
 
Fields inherited from interface org.mule.api.lifecycle.Disposable
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.transport.MessageDispatching
RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY
 
Method Summary
 void activate()
          This method can perform necessary state updates before any of the MessageDispatching methods are invoked.
 Connector getConnector()
          Gets the connector for this dispatcher
 OutboundEndpoint getEndpoint()
           
 void passivate()
          After sending a message, the dispatcher can use this method e.g.
 boolean validate()
          Determines whether this dispatcher can be reused after message sending.
 
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.Disposable
dispose
 
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.transport.MessageDispatching
dispatch, send
 

Method Detail

activate

void activate()
This method can perform necessary state updates before any of the MessageDispatching methods are invoked.

See Also:
MessageDispatcherFactory#activate(org.mule.api.endpoint.ImmutableEndpoint, MessageDispatcher)}

passivate

void passivate()
After sending a message, the dispatcher can use this method e.g. to clean up its internal state (if it has any) or return pooled resources to whereever it got them during activate().

See Also:
MessageDispatcherFactory#passivate(org.mule.api.endpoint.ImmutableEndpoint, MessageDispatcher)}

validate

boolean validate()
Determines whether this dispatcher can be reused after message sending.

Returns:
true if this dispatcher can be reused, false otherwise (for example when Disposable.dispose() has been called because an Exception was raised)

getConnector

Connector getConnector()
Gets the connector for this dispatcher

Returns:
the connector for this dispatcher

getEndpoint

OutboundEndpoint getEndpoint()
Returns:
the endpoint which we are dispatching events to


Copyright © 2003-2009 MuleSource, Inc.. All Rights Reserved.