|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.mule.DefaultMuleEvent
public class DefaultMuleEvent
DefaultMuleEvent
represents any data event occurring in the Mule
environment. All data sent or received within the Mule environment will be passed
between components as an MuleEvent.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.mule.api.ThreadSafeAccess |
---|
ThreadSafeAccess.AccessControl |
Nested classes/interfaces inherited from interface org.mule.util.store.DeserializationPostInitialisable |
---|
DeserializationPostInitialisable.Implementation |
Field Summary | |
---|---|
protected String[] |
ignoredPropertyOverrides
|
Fields inherited from class java.util.EventObject |
---|
source |
Fields inherited from interface org.mule.api.MuleEvent |
---|
TIMEOUT_DO_NOT_WAIT, TIMEOUT_NOT_SET_VALUE, TIMEOUT_WAIT_FOREVER |
Fields inherited from interface org.mule.api.ThreadSafeAccess |
---|
READ, WRITE |
Constructor Summary | |
---|---|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
FlowConstruct service,
MuleEvent previousEvent)
Properties cache that only reads properties once from the inbound message and merges them with any properties on the endpoint. |
|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
MuleEvent previousEvent,
MuleSession session)
|
|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
MuleSession session)
|
|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
MuleSession session,
ProcessingTime time)
|
|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
MuleSession session,
ResponseOutputStream outputStream)
|
|
DefaultMuleEvent(MuleMessage message,
ImmutableEndpoint endpoint,
MuleSession session,
ResponseOutputStream outputStream,
ProcessingTime time)
|
|
DefaultMuleEvent(MuleMessage message,
MuleEvent rewriteEvent)
A helper constructor used to rewrite an event payload |
Method Summary | ||
---|---|---|
void |
assertAccess(boolean write)
This method may be called before data in the object are accessed. |
|
boolean |
equals(Object o)
|
|
protected void |
fillProperties(MuleEvent previousEvent)
|
|
protected String |
generateEventId()
|
|
Credentials |
getCredentials()
|
|
String |
getEncoding()
Gets the encoding for this message. |
|
ImmutableEndpoint |
getEndpoint()
Gets the endpoint associated with this event |
|
FlowConstruct |
getFlowConstruct()
Gets the recipient service of this event |
|
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 for logging |
|
MuleContext |
getMuleContext()
Returns the muleContext for the Mule node that this event was received in |
|
OutputStream |
getOutputStream()
An output stream can optionally be used to write response data to an incoming message. |
|
ProcessingTime |
getProcessingTime()
Returns the times spent processing this event (so far) |
|
Object |
getProperty(String name)
Deprecated. use appropriate scope-aware calls on the MuleMessage (via event.getMessage()) |
|
Object |
getProperty(String name,
Object defaultValue)
Deprecated. use appropriate scope-aware calls on the MuleMessage (via event.getMessage()) |
|
MuleSession |
getSession()
Retrieves the service session for the current event |
|
int |
getTimeout()
The number of milliseconds to wait for a return event when running synchronously. |
|
int |
hashCode()
|
|
protected boolean |
ignoreProperty(String key)
This method is used to determine if a property on the previous event should be ignored for the next event. |
|
boolean |
isStopFurtherProcessing()
Determines whether the default processing for this event will be executed |
|
ThreadSafeAccess |
newThreadCopy()
|
|
void |
resetAccessControl()
This method should ONLY be used in the construction of composite ThreadSafeAccess instances. |
|
protected void |
setCredentials()
|
|
void |
setStopFurtherProcessing(boolean stopFurtherProcessing)
Setting this parameter will stop the Mule framework from processing this event in the standard way. |
|
void |
setTimeout(int timeout)
The number of milliseconds to wait for a return event when running synchronously. |
|
String |
toString()
|
|
Object |
transformMessage()
Deprecated. |
|
|
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. |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected String[] ignoredPropertyOverrides
Constructor Detail |
---|
public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, FlowConstruct service, MuleEvent previousEvent)
message
- endpoint
- service
- previousEvent
- public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, MuleEvent previousEvent, MuleSession session)
public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, MuleSession session)
public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, MuleSession session, ProcessingTime time)
public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, MuleSession session, ResponseOutputStream outputStream)
public DefaultMuleEvent(MuleMessage message, ImmutableEndpoint endpoint, MuleSession session, ResponseOutputStream outputStream, ProcessingTime time)
public DefaultMuleEvent(MuleMessage message, MuleEvent rewriteEvent)
message
- The message to use as the current payload of the eventrewriteEvent
- the previous event that will be used as a template for this eventMethod Detail |
---|
protected void fillProperties(MuleEvent previousEvent)
protected boolean ignoreProperty(String key)
key
- The name of the property to ignore
protected void setCredentials()
public Credentials getCredentials()
getCredentials
in interface MuleEvent
public MuleMessage getMessage()
MuleEvent
getMessage
in interface MuleEvent
public byte[] getMessageAsBytes() throws DefaultMuleException
MuleEvent
getMessageAsBytes
in interface MuleEvent
DefaultMuleException
public <T> T transformMessage(Class<T> outputType) throws TransformerException
MuleEvent
transformMessage
in interface MuleEvent
outputType
- The requested output type.
TransformerException
- if a failure occurs in the transformerif the transform fails or the outputtype is null
public <T> T transformMessage(DataType<T> outputType) throws TransformerException
MuleEvent
transformMessage
in interface MuleEvent
outputType
- The requested output type.
TransformerException
- if a failure occurs in the transformerif the transform fails or the outputtype is null
@Deprecated public byte[] transformMessageToBytes() throws TransformerException
transformMessage(org.mule.api.transformer.DataType)
instead
transformMessageToBytes
in interface MuleEvent
TransformerException
- if an unsupported encoding is being used or if
the result message is not a String byte[] or Seializable objectTransformer
public String transformMessageToString() throws TransformerException
transformMessageToString
in interface MuleEvent
TransformerException
- if a failure occurs in
the transformerTransformer
public String getMessageAsString() throws MuleException
MuleEvent
getMessageAsString
in interface MuleEvent
MuleException
- if the message cannot be converted into a stringpublic String getMessageAsString(String encoding) throws MuleException
getMessageAsString
in interface MuleEvent
encoding
- the encoding to use when converting bytes to a string, if necessary
MuleException
- if the message cannot be converted into a
stringpublic String getId()
MuleEvent
getId
in interface MuleEvent
@Deprecated public Object getProperty(String name)
MuleEvent
getProperty
in interface MuleEvent
name
- the property name
getMessage()
@Deprecated public Object getProperty(String name, Object defaultValue)
MuleEvent
getProperty
in interface MuleEvent
name
- the property namedefaultValue
- a default value if the property doesn't exist in the event
getMessage()
public ImmutableEndpoint getEndpoint()
MuleEvent
getEndpoint
in interface MuleEvent
public String toString()
toString
in class EventObject
protected String generateEventId()
public MuleSession getSession()
MuleEvent
getSession
in interface MuleEvent
public FlowConstruct getFlowConstruct()
getFlowConstruct
in interface MuleEvent
public boolean isStopFurtherProcessing()
isStopFurtherProcessing
in interface MuleEvent
MuleContext
,
MuleEventContext
,
Callable
public void setStopFurtherProcessing(boolean stopFurtherProcessing)
setStopFurtherProcessing
in interface MuleEvent
stopFurtherProcessing
- The stopFurtherProcessing to set.public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int getTimeout()
MuleEvent
getTimeout
in interface MuleEvent
public void setTimeout(int timeout)
MuleEvent
setTimeout
in interface MuleEvent
timeout
- the event timeout in millisecondspublic OutputStream getOutputStream()
getOutputStream
in interface MuleEvent
public String getEncoding()
getEncoding
in interface MuleEvent
public MuleContext getMuleContext()
MuleEvent
getMuleContext
in interface MuleEvent
public ThreadSafeAccess newThreadCopy()
newThreadCopy
in interface ThreadSafeAccess
public void resetAccessControl()
ThreadSafeAccess
resetAccessControl
in interface ThreadSafeAccess
public void assertAccess(boolean write)
ThreadSafeAccess
assertAccess
in interface ThreadSafeAccess
write
- True if the access will mutate values.@Deprecated public Object transformMessage() throws TransformerException
MuleEvent
transformMessage
in interface MuleEvent
TransformerException
- if a failure occurs in the transformerTransformer
public ProcessingTime getProcessingTime()
MuleEvent
getProcessingTime
in interface MuleEvent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |