public interface MessageReceiver extends Connectable, MessageSource
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 |
---|---|
MuleMessage |
createMuleMessage(Object transportMessage) |
MuleMessage |
createMuleMessage(Object transportMessage,
String encoding) |
InboundEndpoint |
getEndpoint() |
EndpointURI |
getEndpointURI()
The endpointUri that this receiver listens on
|
FlowConstruct |
getFlowConstruct() |
String |
getReceiverKey() |
MuleEvent |
routeMessage(MuleMessage message) |
MuleEvent |
routeMessage(MuleMessage message,
Transaction trans) |
MuleEvent |
routeMessage(MuleMessage message,
Transaction trans,
OutputStream outputStream) |
void |
setEndpoint(InboundEndpoint endpoint) |
void |
setReceiverKey(String key) |
connect, disconnect, getConnectionDescription, isConnected, validateConnection
initialise
dispose
setListener
InboundEndpoint getEndpoint()
FlowConstruct getFlowConstruct()
void setEndpoint(InboundEndpoint endpoint)
endpoint
- the endpoint to listen onImmutableEndpoint
EndpointURI getEndpointURI()
String getReceiverKey()
void setReceiverKey(String key)
MuleEvent routeMessage(MuleMessage message) throws MuleException
MuleException
MuleEvent routeMessage(MuleMessage message, Transaction trans) throws MuleException
MuleException
MuleEvent routeMessage(MuleMessage message, Transaction trans, OutputStream outputStream) throws MuleException
MuleException
MuleMessage createMuleMessage(Object transportMessage, String encoding) throws MuleException
MuleException
MuleMessage createMuleMessage(Object transportMessage) throws MuleException
MuleException
Copyright © 2003–2015 MuleSoft, Inc.. All rights reserved.