Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mule.umo
Interface UMOEvent  view UMOEvent download UMOEvent.java


public interface UMOEvent

UMOEvent represents any data event occuring in the Mule environment. All data sent or received within the mule environment will be passed between components as an UMOEvent.

The UMOEvent holds some data and provides helper methods for obtaining the data in a format that the receiving Mule UMO understands. The event can also maintain any number of properties that can be set and retrieved by Mule UMO components.

Version:
$Revision: 1.6 $

Method Summary
 org.mule.util.UUID getId()
          Every event in the system is assigned a universally unique id (UUID).
 java.lang.Object getMessage()
           
 byte[] getMessageAsBytes()
           
 java.lang.String getMessageAsString()
           
 UMOEvent getPreviousEvent()
           
 java.util.HashMap getProperties()
           
 java.lang.Object getProperty(java.lang.String name)
          Gets a property from the event
 java.lang.Object getProperty(java.lang.String name, java.lang.Object defaultValue)
          Gets a property from the event
 java.util.Iterator getPropertyNames()
           
 UMOProviderDescriptor getProvider()
           
 long getTimeout()
           
 java.lang.Object getTransformedMessage()
           
 byte[] getTransformedMessageAsBytes()
           
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets a property on the event
 

Method Detail

getMessage

public java.lang.Object getMessage()

getMessageAsBytes

public byte[] getMessageAsBytes()
                         throws UMOException

getTransformedMessage

public java.lang.Object getTransformedMessage()
                                       throws org.mule.umo.transformer.TransformerException

getTransformedMessageAsBytes

public byte[] getTransformedMessageAsBytes()
                                    throws org.mule.umo.transformer.TransformerException

getMessageAsString

public java.lang.String getMessageAsString()
                                    throws UMOException

getId

public org.mule.util.UUID getId()
Every event in the system is assigned a universally unique id (UUID). This id is not used by the system but can be used by developers


getPreviousEvent

public UMOEvent getPreviousEvent()

getProperty

public java.lang.Object getProperty(java.lang.String name)
Gets a property from the event


getProperty

public java.lang.Object getProperty(java.lang.String name,
                                    java.lang.Object defaultValue)
Gets a property from the event


setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Sets a property on the event


getPropertyNames

public java.util.Iterator getPropertyNames()

getProperties

public java.util.HashMap getProperties()

getTimeout

public long getTimeout()

getProvider

public UMOProviderDescriptor getProvider()