Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> umo >> [ impl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mule.umo.impl
Class MuleEvent  

java.lang.Object
  java.util.EventObject
      org.mule.umo.impl.MuleEvent

All Implemented Interfaces:

java.io.Serializable, org.mule.umo.UMOEvent

---

public class MuleEvent

extends java.util.EventObject

implements org.mule.umo.UMOEvent

MuleEvent 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.10 $

---

Field Summary
private  org.mule.umo.provider.UMOMessageAdapter	adapter           The message adapter used to read the message payload of the event
private  org.mule.util.UUID	id           the Universally Unique ID for the event
private static org.apache.commons.logging.Log	log           The logger for this class
private  org.mule.umo.UMOEvent	previous           The previous event to this event
private  org.mule.umo.UMOProviderDescriptor	provider           The provider associated with the event

 

Fields inherited from class java.util.EventObject

source

 

Constructor Summary

MuleEvent(java.lang.Object message, org.mule.umo.UMOProviderDescriptor provider, org.mule.umo.UMOEvent previousEvent)           Contructor.

 

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()
org.mule.umo.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()
org.mule.umo.UMOProviderDescriptor	getProvider()
long	getTimeout()
java.lang.Object	getTransformedMessage()
byte[]	getTransformedMessageAsBytes()
java.lang.Object	rollbackTransform()           When a transform is performed on an event payload is is done within a transformer session.
void	setProperty(java.lang.String name, java.lang.Object value)           Sets a property on the event
java.lang.String	toString()           Converts the event to a String.

 

Methods inherited from class java.util.EventObject

getSource

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

log

private static final transient org.apache.commons.logging.Log log

The logger for this class

---

provider

private transient org.mule.umo.UMOProviderDescriptor provider

The provider associated with the event

---

id

private org.mule.util.UUID id

the Universally Unique ID for the event

---

previous

private transient org.mule.umo.UMOEvent previous

The previous event to this event

---

adapter

private transient org.mule.umo.provider.UMOMessageAdapter adapter

The message adapter used to read the message payload of the event

Constructor Detail

MuleEvent

public MuleEvent(java.lang.Object message,
                 org.mule.umo.UMOProviderDescriptor provider,
                 org.mule.umo.UMOEvent previousEvent)
          throws org.mule.MuleException

Contructor.

Method Detail

getMessage

public java.lang.Object getMessage()

Specified by:

getMessage in interface org.mule.umo.UMOEvent

---

getMessageAsBytes

public byte[] getMessageAsBytes()
                         throws org.mule.MuleException

Specified by:

getMessageAsBytes in interface org.mule.umo.UMOEvent

---

getTransformedMessage

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

Specified by:

getTransformedMessage in interface org.mule.umo.UMOEvent

---

rollbackTransform

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

When a transform is performed on an event payload is is done within a transformer session. this method allows the rollback of a transformation

---

getTransformedMessageAsBytes

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

Specified by:

getTransformedMessageAsBytes in interface org.mule.umo.UMOEvent

---

getMessageAsString

public java.lang.String getMessageAsString()
                                    throws org.mule.MuleException

Specified by:

getMessageAsString in interface org.mule.umo.UMOEvent

---

getId

public org.mule.util.UUID getId()

Description copied from interface: org.mule.umo.UMOEvent

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

Specified by:

getId in interface org.mule.umo.UMOEvent

---

getPreviousEvent

public org.mule.umo.UMOEvent getPreviousEvent()

Specified by:

getPreviousEvent in interface org.mule.umo.UMOEvent

---

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from interface: org.mule.umo.UMOEvent

Gets a property from the event

Specified by:

getProperty in interface org.mule.umo.UMOEvent

---

getProperty

public java.lang.Object getProperty(java.lang.String name,
                                    java.lang.Object defaultValue)

Description copied from interface: org.mule.umo.UMOEvent

Gets a property from the event

Specified by:

getProperty in interface org.mule.umo.UMOEvent

---

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Description copied from interface: org.mule.umo.UMOEvent

Sets a property on the event

Specified by:

setProperty in interface org.mule.umo.UMOEvent

---

getPropertyNames

public java.util.Iterator getPropertyNames()

Specified by:

getPropertyNames in interface org.mule.umo.UMOEvent

---

getProperties

public java.util.HashMap getProperties()

Specified by:

getProperties in interface org.mule.umo.UMOEvent

---

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface org.mule.umo.UMOEvent

---

getProvider

public org.mule.umo.UMOProviderDescriptor getProvider()

Specified by:

getProvider in interface org.mule.umo.UMOEvent

---

toString

public java.lang.String toString()

Description copied from class: java.util.EventObject

Converts the event to a String. The format is not specified, but by observation, the JDK uses: getClass().getName() + "[source=" + source + "]";.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> umo >> [ impl overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---