|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MuleEvent
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 MuleEvent.
MuleMessage
Field Summary | |
---|---|
static int |
TIMEOUT_DO_NOT_WAIT
|
static int |
TIMEOUT_NOT_SET_VALUE
|
static int |
TIMEOUT_WAIT_FOREVER
|
Method Summary | ||
---|---|---|
void |
captureReplyToDestination()
Set the reply-to destination from the current message, and remove it from the message, to prevent any further propagation. |
|
void |
clearFlowVariables()
|
|
void |
clearSessionVariables()
|
|
Credentials |
getCredentials()
|
|
String |
getEncoding()
Gets the encoding for this message. |
|
MessageExchangePattern |
getExchangePattern()
Returns the message exchange pattern for this event |
|
FlowConstruct |
getFlowConstruct()
Retrieves the service for the current event |
|
|
getFlowVariable(String key)
|
|
Set<String> |
getFlowVariableNames()
|
|
String |
getId()
Every event in the system is assigned a universally unique id (UUID). |
|
MuleMessage |
getMessage()
Returns the message payload for this event |
|
byte[] |
getMessageAsBytes()
Returns the contents 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 |
|
String |
getMessageSourceName()
Returns the message source name if it has one, otherwise returns toString() of the URI returned be getMessageSourceURI() |
|
URI |
getMessageSourceURI()
Returns the URI of the MessageSource that recieved or generated the message being processed. |
|
MuleContext |
getMuleContext()
Returns the muleContext for the Mule node that this event was received in |
|
OutputStream |
getOutputStream()
An outputstream the can optionally be used write response data to an incoming message. |
|
ProcessingTime |
getProcessingTime()
Returns the times spent processing this event (so far) |
|
Object |
getProperty(String name)
Deprecated. |
|
Object |
getProperty(String name,
Object defaultValue)
Deprecated. |
|
Object |
getReplyToDestination()
Return the destination (if any) that will be passed to the reply-to handler. |
|
ReplyToHandler |
getReplyToHandler()
Return the replyToHandler (if any) that will be used to perform async reply |
|
MuleSession |
getSession()
Retrieves the service session for the current event |
|
|
getSessionVariable(String key)
|
|
Set<String> |
getSessionVariableNames()
|
|
int |
getTimeout()
The number of milliseconds to wait for a return event when running synchronously. |
|
boolean |
isStopFurtherProcessing()
Determines whether the default processing for this event will be executed. |
|
boolean |
isSynchronous()
|
|
boolean |
isTransacted()
Returns true is this event is being processed in a transaction |
|
void |
removeFlowVariable(String key)
|
|
void |
removeSessionVariable(String key)
|
|
void |
setFlowVariable(String key,
Object value)
|
|
void |
setMessage(MuleMessage message)
|
|
void |
setSessionVariable(String key,
Object value)
|
|
void |
setStopFurtherProcessing(boolean stopFurtherProcessing)
Determines whether the default processing for this event will be executed. |
|
void |
setTimeout(int timeout)
The number of milliseconds to wait for a return event when running synchronously. |
|
Object |
transformMessage()
Deprecated. Since Mule 3.0 this method does nothing. The message is already transformed before the event reaches a component IF you need to have access to the original message, the must be no transformations before the component, this means that any 'connector-level' transfromers will have to be explicitly overriden via the service overrides on the connector. |
|
|
transformMessage(Class<T> outputType)
Transforms the message into the requested format. |
|
|
transformMessage(DataType<T> outputType)
Transforms the message into the requested format. |
|
byte[] |
transformMessageToBytes()
Deprecated. use transformMessage(org.mule.api.transformer.DataType) instead |
|
String |
transformMessageToString()
Returns the message transformed into it's recognised or expected format and then into a String. |
Field Detail |
---|
static final int TIMEOUT_WAIT_FOREVER
static final int TIMEOUT_DO_NOT_WAIT
static final int TIMEOUT_NOT_SET_VALUE
Method Detail |
---|
MuleMessage getMessage()
Credentials getCredentials()
byte[] getMessageAsBytes() throws MuleException
MuleException
- if the message cannot be converted into an array of bytes@Deprecated Object transformMessage() throws TransformerException
TransformerException
- if a failure occurs in the transformerTransformer
<T> T transformMessage(Class<T> outputType) throws TransformerException
outputType
- The requested output type.
TransformerException
- if a failure occurs in the transformerif the transform fails or the outputtype is null
<T> T transformMessage(DataType<T> outputType) throws TransformerException
outputType
- The requested output type.
TransformerException
- if a failure occurs in the transformerif the transform fails or the outputtype is null
@Deprecated byte[] transformMessageToBytes() throws TransformerException
transformMessage(org.mule.api.transformer.DataType)
instead
TransformerException
- if a failure occurs in the transformerTransformer
String transformMessageToString() throws TransformerException
TransformerException
- if a failure occurs in the transformerTransformer
String getMessageAsString() throws MuleException
MuleException
- if the message cannot be converted into a stringString getMessageAsString(String encoding) throws MuleException
encoding
- the encoding to use when converting the message to string
MuleException
- if the message cannot be converted into a stringString getId()
@Deprecated Object getProperty(String name)
name
- the property name
@Deprecated Object getProperty(String name, Object defaultValue)
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
MuleSession getSession()
FlowConstruct getFlowConstruct()
boolean isStopFurtherProcessing()
org.mule.api.lifecycle.Callable
or calling RequestContext.getEventContext
to
obtain the MuleEventContext for the current thread. The user can programmatically control how events
are dispached.
MuleContext
,
MuleEventContext
,
Callable
void setStopFurtherProcessing(boolean stopFurtherProcessing)
org.mule.api.lifecycle.Callable
or calling RequestContext.getEventContext
to
obtain the MuleEventContext for the current thread. The user can programmatically control how events
are dispached.
stopFurtherProcessing
- the value to set.int getTimeout()
void setTimeout(int timeout)
timeout
- the event timeout in millisecondsOutputStream getOutputStream()
String getEncoding()
MuleContext getMuleContext()
ProcessingTime getProcessingTime()
MessageExchangePattern getExchangePattern()
boolean isTransacted()
URI getMessageSourceURI()
URI
of the MessageSource that recieved or generated the message being processed.
String getMessageSourceName()
ReplyToHandler getReplyToHandler()
Object getReplyToDestination()
void captureReplyToDestination()
boolean isSynchronous()
void setMessage(MuleMessage message)
<T> T getFlowVariable(String key)
void setFlowVariable(String key, Object value)
void removeFlowVariable(String key)
Set<String> getFlowVariableNames()
void clearFlowVariables()
<T> T getSessionVariable(String key)
void setSessionVariable(String key, Object value)
void removeSessionVariable(String key)
Set<String> getSessionVariableNames()
void clearSessionVariables()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |