|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
UMOMessage
Field Summary | |
static int |
TIMEOUT_DO_NOT_WAIT
|
static int |
TIMEOUT_WAIT_FOREVER
|
Method Summary | |
boolean |
getBooleanProperty(java.lang.String name,
boolean defaultValue)
Gets a Boolean property associated with the current event. |
UMOComponent |
getComponent()
Retrieves the component for the current event |
double |
getDoubleProperty(java.lang.String name,
double defaultValue)
Gets a Double property associated with the current event. |
UMOEndpoint |
getEndpoint()
Gets the endpoint associated with this event |
java.lang.String |
getId()
Every event in the system is assigned a universally unique id (UUID). |
int |
getIntProperty(java.lang.String name,
int defaultValue)
Gets an Integer property associated with the current event. |
long |
getLongProperty(java.lang.String name,
long defaultValue)
Gets a Long property associated with the current event. |
UMOMessage |
getMessage()
Returns the message payload for this event |
byte[] |
getMessageAsBytes()
Reterns the conents of the message as a byte array. |
java.lang.String |
getMessageAsString()
Returns the message contents as a string |
java.io.OutputStream |
getOutputStream()
An outputstream the can optionally be used write response data to an incoming message. |
java.util.Map |
getProperties()
Returns a map of properties associated with the event |
java.lang.Object |
getProperty(java.lang.String name)
Gets a property associated with the current event. |
java.lang.Object |
getProperty(java.lang.String name,
java.lang.Object defaultValue)
Gets a property associated with the current event. |
UMOSession |
getSession()
Retrieves the component session for the current event |
int |
getTimeout()
The number of milliseconds to wait for a return event when running synchronously. |
java.lang.Object |
getTransformedMessage()
Returns the message transformed into it's recognised or expected format. |
byte[] |
getTransformedMessageAsBytes()
Returns the message transformed into it's recognised or expected format and then into an array of bytes. |
java.lang.String |
getTransformedMessageAsString()
Returns the message transformed into it's recognised or expected format and then into a String. |
boolean |
isStopFurtherProcessing()
Determines whether the default processing for this event will be executed. |
boolean |
isSynchronous()
Determines whether the was sent synchrounously or not |
java.lang.Object |
removeProperty(java.lang.Object key)
Removes a property from the event |
void |
setBooleanProperty(java.lang.String name,
boolean value)
Sets a Boolean property associated with the current event. |
void |
setDoubleProperty(java.lang.String name,
double value)
Sets a Double property associated with the current event. |
void |
setIntProperty(java.lang.String name,
int value)
Sets an Integer property associated with the current event. |
void |
setLongProperty(java.lang.String name,
long value)
Sets a Long property associated with the current event. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Sets a property associated with the current event. |
void |
setStopFurtherProcessing(boolean stopFurtherProcessing)
Determines whether the default processing for this event will be executed. |
void |
setSynchronous(boolean value)
Determines whether the was sent synchrounously or not |
void |
setTimeout(int timeout)
The number of milliseconds to wait for a return event when running synchronously. |
Field Detail |
public static final int TIMEOUT_WAIT_FOREVER
public static final int TIMEOUT_DO_NOT_WAIT
Method Detail |
public UMOMessage getMessage()
public byte[] getMessageAsBytes() throws UMOException
UMOException
- if the message cannot be converted into an array of bytespublic java.lang.Object getTransformedMessage() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
public byte[] getTransformedMessageAsBytes() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
public java.lang.String getTransformedMessageAsString() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
public java.lang.String getMessageAsString() throws UMOException
UMOException
- if the message cannot be converted into a stringpublic java.lang.String getId()
public java.lang.Object getProperty(java.lang.String name)
event.getMessage().getProperty(...)
name
- the property name
public java.lang.Object getProperty(java.lang.String name, java.lang.Object defaultValue)
event.getMessage().getProperty(..., ...)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
public int getIntProperty(java.lang.String name, int defaultValue)
event.getMessage().getIntProperty(..., ...)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
public long getLongProperty(java.lang.String name, long defaultValue)
event.getMessage().getLongProperty(..., ...)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
public double getDoubleProperty(java.lang.String name, double defaultValue)
event.getMessage().getDoubleProperty(..., ...)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
public boolean getBooleanProperty(java.lang.String name, boolean defaultValue)
event.getMessage().getbooleanProperty(..., ...)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
public void setProperty(java.lang.String name, java.lang.Object value)
event.getMessage().setProperty(..., ...)
name
- the property name or keyvalue
- the property valuepublic void setBooleanProperty(java.lang.String name, boolean value)
event.getMessage().setBooleanProperty(..., ...)
name
- the property name or keyvalue
- the property valuepublic void setIntProperty(java.lang.String name, int value)
event.getMessage().setIntProperty(..., ...)
name
- the property name or keyvalue
- the property valuepublic void setLongProperty(java.lang.String name, long value)
event.getMessage().setLongProperty(..., ...)
name
- the property name or keyvalue
- the property valuepublic void setDoubleProperty(java.lang.String name, double value)
event.getMessage().setDoubleProperty(..., ...)
name
- the property name or keyvalue
- the property valuepublic java.util.Map getProperties()
public UMOEndpoint getEndpoint()
public UMOSession getSession()
public UMOComponent getComponent()
public boolean isStopFurtherProcessing()
org.mule.umo.lifecycle.Callable
or calling UMOManager.getEventContext
to obtain the UMOEventContext for the current thread. The user can programmatically control
how events are dispached.
UMOManager
,
UMOEventContext
,
Callable
public void setStopFurtherProcessing(boolean stopFurtherProcessing)
org.mule.umo.lifecycle.Callable
or calling UMOManager.getEventContext
to obtain the UMOEventContext for the current thread. The user can programmatically control
how events are dispached.
stopFurtherProcessing
- the value to set.public boolean isSynchronous()
public void setSynchronous(boolean value)
value
- true if the event is synchronouspublic int getTimeout()
public void setTimeout(int timeout)
timeout
- the event timeout in millisecondspublic java.io.OutputStream getOutputStream()
public java.lang.Object removeProperty(java.lang.Object key)
key
- the property key to remove
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |