|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
UMOMessage
Field Summary | |
---|---|
static int |
TIMEOUT_DO_NOT_WAIT
|
static int |
TIMEOUT_NOT_SET_VALUE
|
static int |
TIMEOUT_WAIT_FOREVER
|
Method Summary | |
---|---|
UMOComponent |
getComponent()
Retrieves the component for the current event |
UMOCredentials |
getCredentials()
|
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). |
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,
boolean exhaustiveSearch)
Gets a property associated with the current event. |
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 |
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 |
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 |
---|
static final int TIMEOUT_WAIT_FOREVER
static final int TIMEOUT_DO_NOT_WAIT
static final int TIMEOUT_NOT_SET_VALUE
Method Detail |
---|
UMOMessage getMessage()
UMOCredentials getCredentials()
byte[] getMessageAsBytes() throws UMOException
UMOException
- if the message cannot be converted into an array of bytesObject getTransformedMessage() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
byte[] getTransformedMessageAsBytes() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
String getTransformedMessageAsString() throws TransformerException
TransformerException
- if a failure occurs in the transformerUMOTransformer
String getMessageAsString() throws UMOException
UMOException
- if the message cannot be converted into a stringString getTransformedMessageAsString(String encoding) throws TransformerException
encoding
- the encoding to use when converting the message to string
TransformerException
- if a failure occurs in the transformerUMOTransformer
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 stringString getId()
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
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
UMOImmutableEndpoint getEndpoint()
UMOSession getSession()
UMOComponent getComponent()
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
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.boolean isSynchronous()
void setSynchronous(boolean value)
value
- true if the event is synchronousint getTimeout()
void setTimeout(int timeout)
timeout
- the event timeout in millisecondsOutputStream getOutputStream()
boolean isStreaming()
String getEncoding()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |