public interface MessageReceiver extends Lifecycle, Connectable
MessageReceiver
is used to receive data from an external system.
Typically an implementation of this interface will also implement the listener
interface for the external system. For example to listen to a JMS destination the
developer would also implement javax.jms.MessageListener. The endpoint (which
creates the MessageReceiver) will then register the receiver with the JMS
server. Where a listener interface is not availiable the derived
MessageReceiver
will implement the code necessary to receive
data from the external system. For example, the file endpoint will poll a
specified directory for its data.PHASE_NAME
PHASE_NAME
PHASE_NAME
PHASE_NAME
Modifier and Type | Method and Description |
---|---|
Connector |
getConnector() |
InboundEndpoint |
getEndpoint() |
EndpointURI |
getEndpointURI()
The endpointUri that this receiver listens on
|
String |
getReceiverKey() |
Service |
getService() |
MuleMessage |
routeMessage(MuleMessage message) |
MuleMessage |
routeMessage(MuleMessage message,
boolean synchronous) |
MuleMessage |
routeMessage(MuleMessage message,
boolean synchronous,
OutputStream outputStream) |
MuleMessage |
routeMessage(MuleMessage message,
OutputStream outputStream) |
MuleMessage |
routeMessage(MuleMessage message,
Transaction trans,
boolean synchronous) |
MuleMessage |
routeMessage(MuleMessage message,
Transaction trans,
boolean synchronous,
OutputStream outputStream) |
void |
setConnector(Connector connector) |
void |
setEndpoint(InboundEndpoint endpoint) |
void |
setReceiverKey(String key) |
void |
setService(Service service) |
initialise
dispose
connect, disconnect, getConnectionDescription, isConnected
InboundEndpoint getEndpoint()
Service getService()
void setEndpoint(InboundEndpoint endpoint)
endpoint
- the endpoint to listen onImmutableEndpoint
void setService(Service service)
service
- the service to associate with the receiver. When data is
received the service dispatchEvent
or
sendEvent
is used to dispatch the data to the
relivant UMO.void setConnector(Connector connector)
Connector getConnector()
EndpointURI getEndpointURI()
String getReceiverKey()
void setReceiverKey(String key)
MuleMessage routeMessage(MuleMessage message) throws MuleException
MuleException
MuleMessage routeMessage(MuleMessage message, boolean synchronous) throws MuleException
MuleException
MuleMessage routeMessage(MuleMessage message, Transaction trans, boolean synchronous) throws MuleException
MuleException
MuleMessage routeMessage(MuleMessage message, OutputStream outputStream) throws MuleException
MuleException
MuleMessage routeMessage(MuleMessage message, boolean synchronous, OutputStream outputStream) throws MuleException
MuleException
MuleMessage routeMessage(MuleMessage message, Transaction trans, boolean synchronous, OutputStream outputStream) throws MuleException
MuleException
Copyright © 2003–2013 MuleSource, Inc.. All rights reserved.