org.mule.umo.provider
Interface UMOMessageReceiver

All Superinterfaces:
Disposable
All Known Implementing Classes:
AbstractMessageReceiver

public interface UMOMessageReceiver
extends Disposable

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 reciever 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 it's data.

Version:
$Revision: 1.1.1.1 $
Author:
Ross Mason

Method Summary
 void create(UMOConnector connector, UMOComponent component, UMOEndpoint endpoint)
          Creates the Message Receiver
 UMOComponent getComponent()
           
 UMOConnector getConnector()
           
 UMOEndpoint getEndpoint()
           
 UMOEndpointURI getEndpointURI()
          The endpointUri that this receiver listens on
 void handleException(java.lang.Object message, java.lang.Throwable exception)
           
 void setComponent(UMOComponent component)
           
 void setConnector(UMOConnector connector)
           
 void setEndpoint(UMOEndpoint endpoint)
           
 
Methods inherited from interface org.mule.umo.lifecycle.Disposable
dispose
 

Method Detail

create

public void create(UMOConnector connector,
                   UMOComponent component,
                   UMOEndpoint endpoint)
            throws InitialisationException
Creates the Message Receiver

Parameters:
connector - the endpoint that created this listener
component - the component to associate with the receiver. When data is recieved the component dispatchEvent or sendEvent is used to dispatch the data to the relivant UMO.
endpoint - the proivder contains the endpointUri on which the receiver will listen on. The endpointUri can be anything and is specific to the receiver implementation i.e. an email address, a directory, a jms destination or port address.
Throws:
InitialisationException
See Also:
UMOComponent, UMOEndpoint

getEndpoint

public UMOEndpoint getEndpoint()
Returns:
the receivers endpoint

handleException

public void handleException(java.lang.Object message,
                            java.lang.Throwable exception)
Parameters:
message -
exception -

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 recieved 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:


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.