org.mule.umo.provider
Interface UMOMessageReceiver

All Superinterfaces:
Disposable, Lifecycle, Startable, Stoppable, UMOConnectable
All Known Implementing Classes:
AbstractMessageReceiver

public interface UMOMessageReceiver
extends Lifecycle, UMOConnectable

UMOMessageReceiver 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 UMOMessageReceiver) will then register the receiver with the JMS server. Where a listener interface is not availiable the derived UMOMessageReceiver 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.


Method Summary
 UMOComponent getComponent()
           
 UMOConnector getConnector()
           
 UMOEndpoint getEndpoint()
           
 UMOEndpointURI getEndpointURI()
          The endpointUri that this receiver listens on
 String getReceiverKey()
           
 UMOMessage routeMessage(UMOMessage message)
           
 UMOMessage routeMessage(UMOMessage message, boolean synchronous)
           
 UMOMessage routeMessage(UMOMessage message, boolean synchronous, OutputStream outputStream)
           
 UMOMessage routeMessage(UMOMessage message, OutputStream outputStream)
           
 UMOMessage routeMessage(UMOMessage message, UMOTransaction trans, boolean synchronous)
           
 UMOMessage routeMessage(UMOMessage message, UMOTransaction trans, boolean synchronous, OutputStream outputStream)
           
 void setComponent(UMOComponent component)
           
 void setConnector(UMOConnector connector)
           
 void setEndpoint(UMOEndpoint endpoint)
           
 void setReceiverKey(String key)
           
 
Methods inherited from interface org.mule.umo.lifecycle.Startable
start
 
Methods inherited from interface org.mule.umo.lifecycle.Stoppable
stop
 
Methods inherited from interface org.mule.umo.lifecycle.Disposable
dispose
 
Methods inherited from interface org.mule.umo.provider.UMOConnectable
connect, disconnect, getConnectionDescription, isConnected
 

Method Detail

getEndpoint

public UMOEndpoint getEndpoint()
Returns:
the receivers endpoint

getComponent

public UMOComponent getComponent()
Returns:
the component associated with the receiver

setEndpoint

public void setEndpoint(UMOEndpoint endpoint)
Parameters:
endpoint - the endpoint to listen on
See Also:
UMOEndpoint

setComponent

public void setComponent(UMOComponent component)
Parameters:
component - the component to associate with the receiver. When data is received the component dispatchEvent or sendEvent is used to dispatch the data to the relivant UMO.

setConnector

public void setConnector(UMOConnector connector)

getConnector

public UMOConnector getConnector()

getEndpointURI

public UMOEndpointURI getEndpointURI()
The endpointUri that this receiver listens on

Returns:

getReceiverKey

public String getReceiverKey()

setReceiverKey

public void setReceiverKey(String key)

routeMessage

public UMOMessage routeMessage(UMOMessage message)
                        throws UMOException
Throws:
UMOException

routeMessage

public UMOMessage routeMessage(UMOMessage message,
                               boolean synchronous)
                        throws UMOException
Throws:
UMOException

routeMessage

public UMOMessage routeMessage(UMOMessage message,
                               UMOTransaction trans,
                               boolean synchronous)
                        throws UMOException
Throws:
UMOException

routeMessage

public UMOMessage routeMessage(UMOMessage message,
                               OutputStream outputStream)
                        throws UMOException
Throws:
UMOException

routeMessage

public UMOMessage routeMessage(UMOMessage message,
                               boolean synchronous,
                               OutputStream outputStream)
                        throws UMOException
Throws:
UMOException

routeMessage

public UMOMessage routeMessage(UMOMessage message,
                               UMOTransaction trans,
                               boolean synchronous,
                               OutputStream outputStream)
                        throws UMOException
Throws:
UMOException


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