org.mule.umo
Interface UMOComponent

All Superinterfaces:
Disposable, Initialisable, Lifecycle, java.lang.Runnable, java.io.Serializable, Startable, Stoppable
All Known Implementing Classes:
MuleComponent

public interface UMOComponent
extends java.lang.Runnable, java.io.Serializable, Lifecycle, Initialisable

UMOComponent is the interal repesentation of a Mule Managed component. It is responsible for managing the interaction of events to and from the component as well as managing pooled resources.

Version:
$Revision: 1.1.1.1 $
Author:
Ross Mason

Method Summary
 void dispatchEvent(UMOEvent event)
          Makes an asynhronous event call to the component.
 UMODescriptor getDescriptor()
           
 void pause()
          Pauses event processing for theComponent.
 void resume()
          Resumes the Component that has been paused.
 UMOMessage sendEvent(UMOEvent event)
          Makes a synhronous event call to the component.
 
Methods inherited from interface java.lang.Runnable
run
 
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.lifecycle.Initialisable
initialise
 

Method Detail

getDescriptor

public UMODescriptor getDescriptor()
Returns:
the UMODescriptor associated with the component
See Also:
UMODescriptor

dispatchEvent

public void dispatchEvent(UMOEvent event)
                   throws UMOException
Makes an asynhronous event call to the component.

Parameters:
event - the event to consume
Throws:
UMOException - if the event fails to be processed

sendEvent

public UMOMessage sendEvent(UMOEvent event)
                     throws UMOException
Makes a synhronous event call to the component. This event will be consumed by the component and a result returned.

Parameters:
event - the event to consume
Returns:
a UMOMessage containing the resulting message and properties
Throws:
UMOException - if the event fails to be processed

pause

public void pause()
           throws UMOException
Pauses event processing for theComponent. Unlike stop(), a paused component will still consume messages from the underlying transport, but those messages will be queued until the component is resumed. In order to persist these queued messages you can set the 'recoverableMode' property on the Muleconfiguration to true. this causes all internal queues to store their state.

Throws:
UMOException - if the component failed to pause.
See Also:
MuleConfiguration

resume

public void resume()
            throws UMOException
Resumes the Component that has been paused. If the component is not paused nothing is executed.

Throws:
UMOException - if the component failed to resume


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