org.mule.impl
Class MuleMessage

java.lang.Object
  extended by org.mule.impl.MuleMessage
All Implemented Interfaces:
Serializable, ThreadSafeAccess, UMOMessageAdapter, UMOMessage

public class MuleMessage
extends Object
implements UMOMessage, ThreadSafeAccess

MuleMessage is a wrapper that contains a payload and properties associated with the payload.

See Also:
Serialized Form

Field Summary
protected  UMOExceptionPayload exceptionPayload
           
 
Constructor Summary
MuleMessage(Object message)
           
MuleMessage(Object message, Map properties)
           
MuleMessage(Object message, UMOMessageAdapter previous)
           
 
Method Summary
 void addAttachment(String name, DataHandler dataHandler)
           
 void addProperties(Map properties)
          Adds a map of properties to be associated with this message
 void assertAccess(boolean write)
          This method may be called before data in the object are accessed.
 void clearProperties()
          Removes all properties on this message
 UMOMessageAdapter getAdapter()
           
 DataHandler getAttachment(String name)
           
 Set getAttachmentNames()
           
 boolean getBooleanProperty(String name, boolean defaultValue)
          Gets a boolean property from the event
 int getCorrelationGroupSize()
          Determines how many messages are in the correlation group
 String getCorrelationId()
          Sets a correlationId for this message.
 int getCorrelationSequence()
          Gets the sequence or ordering number for this message in the the correlation group (as defined by the correlationId)
 double getDoubleProperty(String name, double defaultValue)
          Gets a double property from the event
 String getEncoding()
          Gets the encoding for the current message.
 UMOExceptionPayload getExceptionPayload()
          If an error occurred during the processing of this message this will return a ErrorPayload that contains the root exception and Mule error code, plus any other releated info
 int getIntProperty(String name, int defaultValue)
          Gets an integer property from the event
 long getLongProperty(String name, long defaultValue)
          Gets a long property from the event
 Object getPayload()
           
 byte[] getPayloadAsBytes()
          Converts the payload implementation into a String representation
 String getPayloadAsString()
          Converts the payload implementation into a String representation
 String getPayloadAsString(String encoding)
          Converts the message implementation into a String representation
 Object getProperty(String key)
          Gets a property of the payload implementation
 Object getProperty(String name, Object defaultValue)
          Gets a property from the event
 Set getPropertyNames()
           
 Object getReplyTo()
          Sets a replyTo address for this message.
 String getStringProperty(String name, String defaultValue)
          Gets a String property from the event
 String getUniqueId()
          gets the unique identifier for the message.
 ThreadSafeAccess newThreadCopy()
           
 void removeAttachment(String name)
           
 Object removeProperty(String key)
          Removes a property on this message
 void resetAccessControl()
          This method should ONLY be used in the construction of composite ThreadSafeAccess instances.
 void setBooleanProperty(String name, boolean value)
          Sets a boolean property on the event
 void setCorrelationGroupSize(int size)
          Determines how many messages are in the correlation group
 void setCorrelationId(String id)
          Sets a correlationId for this message.
 void setCorrelationSequence(int sequence)
          Gets the sequence or ordering number for this message in the the correlation group (as defined by the correlationId)
 void setDoubleProperty(String name, double value)
          Sets a double property on the event
 void setEncoding(String encoding)
          Sets the encoding for this message
 void setExceptionPayload(UMOExceptionPayload exceptionPayload)
          If an error occurs while processing this message, a ErrorPayload is attached which contains the root exception and Mule error code, plus any other releated info
 void setIntProperty(String name, int value)
          Sets a integerproperty on the event
 void setLongProperty(String name, long value)
          Sets a long property on the event
 void setProperty(String key, Object value)
          Gets a property of the payload implementation
 void setReplyTo(Object replyTo)
          Sets a replyTo address for this message.
 void setStringProperty(String name, String value)
          Sets a String property on the event
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

exceptionPayload

protected UMOExceptionPayload exceptionPayload
Constructor Detail

MuleMessage

public MuleMessage(Object message)

MuleMessage

public MuleMessage(Object message,
                   Map properties)

MuleMessage

public MuleMessage(Object message,
                   UMOMessageAdapter previous)
Method Detail

getAdapter

public UMOMessageAdapter getAdapter()
Specified by:
getAdapter in interface UMOMessage

getProperty

public Object getProperty(String key)
Gets a property of the payload implementation

Specified by:
getProperty in interface UMOMessageAdapter
Parameters:
key - the key on which to lookup the property value
Returns:
the property value or null if the property does not exist

removeProperty

public Object removeProperty(String key)
Description copied from interface: UMOMessageAdapter
Removes a property on this message

Specified by:
removeProperty in interface UMOMessageAdapter
Parameters:
key - the property key to remove
Returns:
the removed property value or null if the property did not exist

setProperty

public void setProperty(String key,
                        Object value)
Gets a property of the payload implementation

Specified by:
setProperty in interface UMOMessageAdapter
Parameters:
key - the key on which to associate the value
value - the property value

getPayloadAsString

public String getPayloadAsString()
                          throws Exception
Converts the payload implementation into a String representation

Specified by:
getPayloadAsString in interface UMOMessageAdapter
Returns:
String representation of the payload
Throws:
Exception - Implemetation may throw an endpoint specific exception

getPayloadAsString

public String getPayloadAsString(String encoding)
                          throws Exception
Converts the message implementation into a String representation

Specified by:
getPayloadAsString in interface UMOMessageAdapter
Parameters:
encoding - The encoding to use when transforming the message (if necessary). The parameter is used when converting from a byte array
Returns:
String representation of the message payload
Throws:
Exception - Implementation may throw an endpoint specific exception

getPropertyNames

public Set getPropertyNames()
Specified by:
getPropertyNames in interface UMOMessageAdapter
Returns:
all properties on this payload

getPayloadAsBytes

public byte[] getPayloadAsBytes()
                         throws Exception
Converts the payload implementation into a String representation

Specified by:
getPayloadAsBytes in interface UMOMessageAdapter
Returns:
String representation of the payload
Throws:
Exception - Implemetation may throw an endpoint specific exception

getPayload

public Object getPayload()
Specified by:
getPayload in interface UMOMessageAdapter
Returns:
the current payload

addProperties

public void addProperties(Map properties)
Description copied from interface: UMOMessageAdapter
Adds a map of properties to be associated with this message

Specified by:
addProperties in interface UMOMessageAdapter
Parameters:
properties - the properties add to this message

clearProperties

public void clearProperties()
Description copied from interface: UMOMessageAdapter
Removes all properties on this message

Specified by:
clearProperties in interface UMOMessageAdapter

getDoubleProperty

public double getDoubleProperty(String name,
                                double defaultValue)
Gets a double property from the event

Specified by:
getDoubleProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

setDoubleProperty

public void setDoubleProperty(String name,
                              double value)
Sets a double property on the event

Specified by:
setDoubleProperty in interface UMOMessageAdapter
Parameters:
name - the property name or key
value - the property value

getUniqueId

public String getUniqueId()
Description copied from interface: UMOMessageAdapter
gets the unique identifier for the message. It's up to the implementation to ensure a unique id

Specified by:
getUniqueId in interface UMOMessageAdapter
Returns:
a unique message id. The Id should never be null. If the underlying transport does not have the notion of a message Id, one shuold be generated. The generated Id should be a UUID.

getProperty

public Object getProperty(String name,
                          Object defaultValue)
Description copied from interface: UMOMessageAdapter
Gets a property from the event

Specified by:
getProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

getIntProperty

public int getIntProperty(String name,
                          int defaultValue)
Description copied from interface: UMOMessageAdapter
Gets an integer property from the event

Specified by:
getIntProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

getLongProperty

public long getLongProperty(String name,
                            long defaultValue)
Description copied from interface: UMOMessageAdapter
Gets a long property from the event

Specified by:
getLongProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

getBooleanProperty

public boolean getBooleanProperty(String name,
                                  boolean defaultValue)
Description copied from interface: UMOMessageAdapter
Gets a boolean property from the event

Specified by:
getBooleanProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

setBooleanProperty

public void setBooleanProperty(String name,
                               boolean value)
Description copied from interface: UMOMessageAdapter
Sets a boolean property on the event

Specified by:
setBooleanProperty in interface UMOMessageAdapter
Parameters:
name - the property name or key
value - the property value

setIntProperty

public void setIntProperty(String name,
                           int value)
Description copied from interface: UMOMessageAdapter
Sets a integerproperty on the event

Specified by:
setIntProperty in interface UMOMessageAdapter
Parameters:
name - the property name or key
value - the property value

setLongProperty

public void setLongProperty(String name,
                            long value)
Description copied from interface: UMOMessageAdapter
Sets a long property on the event

Specified by:
setLongProperty in interface UMOMessageAdapter
Parameters:
name - the property name or key
value - the property value

setCorrelationId

public void setCorrelationId(String id)
Sets a correlationId for this message. The correlation Id can be used by components in the system to manage message relations

transport protocol. As such not all messages will support the notion of a correlationId i.e. tcp or file. In this situation the correlation Id is set as a property of the message where it's up to developer to keep the association with the message. For example if the message is serialised to xml the correlationId will be available in the message.

Specified by:
setCorrelationId in interface UMOMessageAdapter
Parameters:
id - the Id reference for this relationship

getCorrelationId

public String getCorrelationId()
Sets a correlationId for this message. The correlation Id can be used by components in the system to manage message relations.

The correlationId is associated with the message using the underlying transport protocol. As such not all messages will support the notion of a correlationId i.e. tcp or file. In this situation the correlation Id is set as a property of the message where it's up to developer to keep the association with the message. For example if the message is serialised to xml the correlationId will be available in the message.

Specified by:
getCorrelationId in interface UMOMessageAdapter
Returns:
the correlationId for this message or null if one hasn't been set

setReplyTo

public void setReplyTo(Object replyTo)
Sets a replyTo address for this message. This is useful in an asynchronous environment where the caller doesn't wait for a response and the response needs to be routed somewhere for further processing. The value of this field can be any valid endpointUri url.

Specified by:
setReplyTo in interface UMOMessageAdapter
Parameters:
replyTo - the endpointUri url to reply to

getReplyTo

public Object getReplyTo()
Sets a replyTo address for this message. This is useful in an asynchronous environment where the caller doesn't wait for a response and the response needs to be routed somewhere for further processing. The value of this field can be any valid endpointUri url.

Specified by:
getReplyTo in interface UMOMessageAdapter
Returns:
the endpointUri url to reply to or null if one has not been set

getCorrelationSequence

public int getCorrelationSequence()
Gets the sequence or ordering number for this message in the the correlation group (as defined by the correlationId)

Specified by:
getCorrelationSequence in interface UMOMessageAdapter
Returns:
the sequence number or -1 if the sequence is not important

setCorrelationSequence

public void setCorrelationSequence(int sequence)
Gets the sequence or ordering number for this message in the the correlation group (as defined by the correlationId)

Specified by:
setCorrelationSequence in interface UMOMessageAdapter
Parameters:
sequence - the sequence number or -1 if the sequence is not important

getCorrelationGroupSize

public int getCorrelationGroupSize()
Determines how many messages are in the correlation group

Specified by:
getCorrelationGroupSize in interface UMOMessageAdapter
Returns:
total messages in this group or -1 if the size is not known

setCorrelationGroupSize

public void setCorrelationGroupSize(int size)
Determines how many messages are in the correlation group

Specified by:
setCorrelationGroupSize in interface UMOMessageAdapter
Parameters:
size - the total messages in this group or -1 if the size is not known

getExceptionPayload

public UMOExceptionPayload getExceptionPayload()
Description copied from interface: UMOMessageAdapter
If an error occurred during the processing of this message this will return a ErrorPayload that contains the root exception and Mule error code, plus any other releated info

Specified by:
getExceptionPayload in interface UMOMessageAdapter
Returns:
The exception payload (if any) attached to this message

setExceptionPayload

public void setExceptionPayload(UMOExceptionPayload exceptionPayload)
Description copied from interface: UMOMessageAdapter
If an error occurs while processing this message, a ErrorPayload is attached which contains the root exception and Mule error code, plus any other releated info

Specified by:
setExceptionPayload in interface UMOMessageAdapter
Parameters:
exceptionPayload - The exception payloaad to attach to this message

toString

public String toString()
Overrides:
toString in class Object

addAttachment

public void addAttachment(String name,
                          DataHandler dataHandler)
                   throws Exception
Specified by:
addAttachment in interface UMOMessageAdapter
Throws:
Exception

removeAttachment

public void removeAttachment(String name)
                      throws Exception
Specified by:
removeAttachment in interface UMOMessageAdapter
Throws:
Exception

getAttachment

public DataHandler getAttachment(String name)
Specified by:
getAttachment in interface UMOMessageAdapter

getAttachmentNames

public Set getAttachmentNames()
Specified by:
getAttachmentNames in interface UMOMessageAdapter

getEncoding

public String getEncoding()
Gets the encoding for the current message. For potocols that send encoding Information with the message, this method should be overriden to expose the transport encoding, otherwise the default encoding in the Mule configuration will be used

Specified by:
getEncoding in interface UMOMessageAdapter
Returns:
the encoding for this message. This method must never return null

setEncoding

public void setEncoding(String encoding)
Sets the encoding for this message

Specified by:
setEncoding in interface UMOMessageAdapter
Parameters:
encoding - the encoding to use

getStringProperty

public String getStringProperty(String name,
                                String defaultValue)
Gets a String property from the event

Specified by:
getStringProperty in interface UMOMessageAdapter
Parameters:
name - the name or key of the property
defaultValue - a default value if the property doesn't exist in the event
Returns:
the property value or the defaultValue if the property does not exist

setStringProperty

public void setStringProperty(String name,
                              String value)
Sets a String property on the event

Specified by:
setStringProperty in interface UMOMessageAdapter
Parameters:
name - the property name or key
value - the property value

newThreadCopy

public ThreadSafeAccess newThreadCopy()
Specified by:
newThreadCopy in interface ThreadSafeAccess
Returns:
A new instance of the implementing class, unbound to any thread and mutable.

resetAccessControl

public void resetAccessControl()
Description copied from interface: ThreadSafeAccess
This method should ONLY be used in the construction of composite ThreadSafeAccess instances. For example, a ThreadSafeAccess UMOEvent contains a ThreadSafeAccess UMOMessageAdapter. During the construction of the event, the message adapter may be bound to the contructing thread. Calling this method releases that binding so that the event as a whole can be passed to a new thread unbound.

Specified by:
resetAccessControl in interface ThreadSafeAccess

assertAccess

public void assertAccess(boolean write)
Description copied from interface: ThreadSafeAccess
This method may be called before data in the object are accessed. It should verify that the access policy is followed correctly (if not, a runtime exception may be thrown).

Specified by:
assertAccess in interface ThreadSafeAccess
Parameters:
write - True if the access will mutate values.


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.