|
|||||||||||
| 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_NOT_SET_VALUE
|
static int |
TIMEOUT_WAIT_FOREVER
|
| Method Summary | |
boolean |
getBooleanProperty(String name,
boolean defaultValue)
Deprecated. use event.getMessage().getProperty() |
UMOComponent |
getComponent()
Retrieves the component for the current event |
UMOCredentials |
getCredentials()
|
double |
getDoubleProperty(String name,
double defaultValue)
Deprecated. use event.getMessage().getProperty() |
String |
getEncoding()
Gets the encoding for this message. |
UMOImmutableEndpoint |
getEndpoint()
Gets the endpoint associated with this event |
String |
getId()
Every event in the system is assigned a universally unique id (UUID). |
int |
getIntProperty(String name,
int defaultValue)
Deprecated. use event.getMessage().getProperty() |
long |
getLongProperty(String name,
long defaultValue)
Deprecated. use event.getMessage().getProperty() |
UMOMessage |
getMessage()
Returns the message payload for this event |
byte[] |
getMessageAsBytes()
Reterns the conents of the message as a byte array. |
String |
getMessageAsString()
Returns the message contents as a string If necessary this will use the encoding set on the event |
String |
getMessageAsString(String encoding)
Returns the message contents as a string |
OutputStream |
getOutputStream()
An outputstream the can optionally be used write response data to an incoming message. |
Object |
getProperty(String name)
Deprecated. use event.getMessage().getProperty() |
Object |
getProperty(String name,
boolean exhaustiveSearch)
Gets a property associated with the current event. |
Object |
getProperty(String name,
Object defaultValue)
Deprecated. use event.getMessage().getProperty() |
Object |
getProperty(String name,
Object defaultValue,
boolean exhaustiveSearch)
Gets a property associated with the current event. |
UMOSession |
getSession()
Retrieves the component session for the current event |
String |
getStringProperty(String name,
String defaultValue)
Deprecated. use event.getMessage().getStringProperty() |
int |
getTimeout()
The number of milliseconds to wait for a return event when running synchronously. |
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. |
String |
getTransformedMessageAsString()
Returns the message transformed into it's recognised or expected format and then into a String. |
String |
getTransformedMessageAsString(String encoding)
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 |
isStreaming()
Determines whether the event flow is being streamed |
boolean |
isSynchronous()
Determines whether the was sent synchrounously or not |
Object |
removeProperty(String key)
Deprecated. use event.getMessage().removeProperty() |
void |
setBooleanProperty(String name,
boolean value)
Deprecated. use event.getMessage().setBooleanProperty() |
void |
setDoubleProperty(String name,
double value)
Deprecated. use event.getMessage().setDoubleProperty() |
void |
setIntProperty(String name,
int value)
Deprecated. use event.getMessage().setIntProperty() |
void |
setLongProperty(String name,
long value)
Deprecated. use event.getMessage().setLongProperty() |
void |
setProperty(String name,
Object value)
Deprecated. use event.getMessage().setProperty() |
void |
setStopFurtherProcessing(boolean stopFurtherProcessing)
Determines whether the default processing for this event will be executed. |
void |
setStringProperty(String name,
String value)
Deprecated. use event.getMessage().setStringProperty() |
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
public static final int TIMEOUT_NOT_SET_VALUE
| Method Detail |
public UMOMessage getMessage()
public UMOCredentials getCredentials()
public byte[] getMessageAsBytes()
throws UMOException
UMOException - if the message cannot be converted into an array of bytes
public 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 String getTransformedMessageAsString()
throws TransformerException
TransformerException - if a failure occurs in the transformerUMOTransformer
public String getMessageAsString()
throws UMOException
UMOException - if the message cannot be converted into a string
public String getTransformedMessageAsString(String encoding)
throws TransformerException
encoding - the encoding to use when converting the message to string
TransformerException - if a failure occurs in the transformerUMOTransformer
public String getMessageAsString(String encoding)
throws UMOException
encoding - the encoding to use when converting the message to string
UMOException - if the message cannot be converted into a stringpublic String getId()
public Object getProperty(String name)
event.getMessage().getProperty(...)
name - the property name
public Object getProperty(String name,
boolean exhaustiveSearch)
exhaustiveSearch is true, the endpoint and connector associated
with the event will also be searched for the property.
name - the property nameexhaustiveSearch - also search the endpoint and connector for the
property
public Object getProperty(String name,
Object defaultValue)
event.getMessage().getProperty(..., ...)
name - the property namedefaultValue - a default value if the property doesn't exist in the event
public Object getProperty(String name,
Object defaultValue,
boolean exhaustiveSearch)
exhaustiveSearch is true, the endpoint and connector associated
with the event will also be searched for the property.
name - the property namedefaultValue - a default value if the property doesn't exist in the eventexhaustiveSearch - also search the endpoint and connector for the
property
public int getIntProperty(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(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(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(String name,
boolean defaultValue)
event.getMessage().getbooleanProperty(..., ...)
name - the property namedefaultValue - a default value if the property doesn't exist in the event
public String getStringProperty(String name,
String defaultValue)
event.getMessage().getStringProperty(..., ...)
name - the property namedefaultValue - a default value if the property doesn't exist in the event
public void setProperty(String name,
Object value)
event.getMessage().setProperty(..., ...)
name - the property name or keyvalue - the property value
public void setBooleanProperty(String name,
boolean value)
event.getMessage().setBooleanProperty(..., ...)
name - the property name or keyvalue - the property value
public void setIntProperty(String name,
int value)
event.getMessage().setIntProperty(..., ...)
name - the property name or keyvalue - the property value
public void setLongProperty(String name,
long value)
event.getMessage().setLongProperty(..., ...)
name - the property name or keyvalue - the property value
public void setDoubleProperty(String name,
double value)
event.getMessage().setDoubleProperty(..., ...)
name - the property name or keyvalue - the property value
public void setStringProperty(String name,
String value)
event.getMessage().setStringProperty(..., ...)
name - the property name or keyvalue - the property valuepublic UMOImmutableEndpoint 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,
Callablepublic 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 OutputStream getOutputStream()
public Object removeProperty(String key)
key - the property key to remove
public boolean isStreaming()
public String getEncoding()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||