| org.mule.api.transport.MessageAdapter
All known Subclasses: org.mule.transport.AbstractMessageAdapter,
| MessageAdapter | | public interface MessageAdapter extends Serializable(Code) | | MessageAdapter provides a common abstraction of different
message implementations provided by different underlying technologies.
|
| Method Summary | |
| void | addAttachment(String name, DataHandler dataHandler)
Allows for arbitary data attachments to be associated with the Message. | | void | addProperties(Map properties)
| | void | clearProperties()
| | DataHandler | getAttachment(String name)
Retrieve an attachment with the given name. | | Set | getAttachmentNames()
Returns a set of the names of the attachments on this message. | | boolean | getBooleanProperty(String name, boolean defaultValue)
| | int | getCorrelationGroupSize()
| | String | getCorrelationId()
Sets a correlationId for this message. | | int | getCorrelationSequence()
| | double | getDoubleProperty(String name, double defaultValue)
| | String | getEncoding()
Gets the encoding for the current message. | | ExceptionPayload | getExceptionPayload()
| | int | getIntProperty(String name, int defaultValue)
| | long | getLongProperty(String name, long defaultValue)
| | Object | getPayload()
| | Object | getProperty(String key)
| | Object | getProperty(String name, Object defaultValue)
| | Set | getPropertyNames()
| | Object | getReplyTo()
Returns a replyTo address for this message. | | String | getStringProperty(String name, String defaultValue)
| | String | getUniqueId()
gets the unique identifier for the message. | | void | release()
Perform any clean up operations on the message resource. | | void | removeAttachment(String name)
Remove an attahcment form this message with the specifed name
Parameters:
name - the name of the attachment to remove. | | Object | removeProperty(String key)
| | void | setBooleanProperty(String name, boolean value)
| | void | setCorrelationGroupSize(int size)
| | void | setCorrelationId(String id)
Sets a correlationId for this message. | | void | setCorrelationSequence(int sequence)
| | void | setDoubleProperty(String name, double value)
| | void | setEncoding(String encoding)
| | void | setExceptionPayload(ExceptionPayload payload)
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)
| | void | setLongProperty(String name, long value)
| | void | setProperty(String key, Object value)
| | void | setProperty(String key, Object value, PropertyScope scope)
| | void | setReplyTo(Object replyTo)
Sets a replyTo address for this message. | | void | setStringProperty(String name, String value)
|
| addAttachment | | void addAttachment(String name, DataHandler dataHandler) throws Exception(Code) | | Allows for arbitary data attachments to be associated with the Message. These attachements work in the
same way that email attachments work. Attachments can be binary or text
Parameters:
name - the name to associate with the attachment
Parameters:
dataHandler - The attachment datahandler to use. This will be used to interract with the attachment data
throws:
Exception -
See Also: javax.activation.DataHandler |
| addProperties | | void addProperties(Map properties)(Code) | | Adds a map of properties to be associated with this message
Parameters:
properties - the properties add to this message |
| clearProperties | | void clearProperties()(Code) | | Removes all properties on this message
|
| getAttachment | | DataHandler getAttachment(String name)(Code) | | Retrieve an attachment with the given name. If the attachment does not exist, null will be returned
Parameters:
name - the name of the attachment to retrieve the attachment with the given name or null if the attachment does not exist
See Also: javax.activation.DataHandler |
| getAttachmentNames | | Set getAttachmentNames()(Code) | | Returns a set of the names of the attachments on this message. If there are no attachments an empty set will be
returned.
a set of the names of the attachments on this message. If there are no attachments an empty set will bereturned. |
| getBooleanProperty | | boolean getBooleanProperty(String name, boolean defaultValue)(Code) | | Gets a boolean property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getCorrelationGroupSize | | int getCorrelationGroupSize()(Code) | | Determines how many messages are in the correlation group
total messages in this group or -1 if the size is not known |
| getCorrelationId | | String getCorrelationId()(Code) | | 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.
the correlationId for this message or null if one hasn't been set |
| getCorrelationSequence | | int getCorrelationSequence()(Code) | | Gets the sequence or ordering number for this message in the the correlation
group (as defined by the correlationId)
the sequence number or -1 if the sequence is not important |
| getDoubleProperty | | double getDoubleProperty(String name, double defaultValue)(Code) | | Gets a double property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getEncoding | | String getEncoding()(Code) | | 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.
the encoding for this message. This method must never return null |
| getExceptionPayload | | ExceptionPayload getExceptionPayload()(Code) | | 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
The exception payload (if any) attached to this message |
| getIntProperty | | int getIntProperty(String name, int defaultValue)(Code) | | Gets an integer property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getLongProperty | | long getLongProperty(String name, long defaultValue)(Code) | | Gets a long property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getProperty | | Object getProperty(String key)(Code) | | Gets a property of the message implementation
Parameters:
key - the key on which to lookup the property value the property value or null if the property does not exist |
| getProperty | | Object getProperty(String name, Object defaultValue)(Code) | | Gets a property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getPropertyNames | | Set getPropertyNames()(Code) | | all property keys on this message |
| getReplyTo | | Object getReplyTo()(Code) | | Returns 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.
the endpointUri url to reply to or null if one has not been set |
| getStringProperty | | String getStringProperty(String name, String defaultValue)(Code) | | Gets a String property from the message
Parameters:
name - the name or key of the property
Parameters:
defaultValue - a default value if the property doesn't exist in the event the property value or the defaultValue if the property does not exist |
| getUniqueId | | String getUniqueId()(Code) | | gets the unique identifier for the message. It's up to the implementation to
ensure a unique id
a unique message id. The Id should never be null. If the underlyingtransport does not have the notion of a message Id, one shuold begenerated. The generated Id should be a UUID. |
| release | | void release()(Code) | | Perform any clean up operations on the message resource.
Typically this is used to esure that a message stream is closed
|
| removeAttachment | | void removeAttachment(String name) throws Exception(Code) | | Remove an attahcment form this message with the specifed name
Parameters:
name - the name of the attachment to remove. If the attachment does not exist, the request may be ignorred
throws:
Exception - different messaging systems handle attachments differnetly, as such some will throw an exceptionif an attahcment does dot exist. |
| removeProperty | | Object removeProperty(String key)(Code) | | Removes a property on this message
Parameters:
key - the property key to remove the removed property value or null if the property did not exist |
| setBooleanProperty | | void setBooleanProperty(String name, boolean value)(Code) | | Sets a boolean property on the message
Parameters:
name - the property name or key
Parameters:
value - the property value |
| setCorrelationGroupSize | | void setCorrelationGroupSize(int size)(Code) | | Determines how many messages are in the correlation group
Parameters:
size - the total messages in this group or -1 if the size is not known |
| setCorrelationId | | void setCorrelationId(String id)(Code) | | 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.
Parameters:
id - the Id reference for this relationship |
| setCorrelationSequence | | void setCorrelationSequence(int sequence)(Code) | | Gets the sequence or ordering number for this message in the the correlation
group (as defined by the correlationId)
Parameters:
sequence - the sequence number or -1 if the sequence is not important |
| setDoubleProperty | | void setDoubleProperty(String name, double value)(Code) | | Sets a double property on the message
Parameters:
name - the property name or key
Parameters:
value - the property value |
| setEncoding | | void setEncoding(String encoding)(Code) | | Sets the encoding for this message
Parameters:
encoding - the encoding to use |
| setExceptionPayload | | void setExceptionPayload(ExceptionPayload payload)(Code) | | 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.
Parameters:
payload - The exception payload to attach to this message |
| setIntProperty | | void setIntProperty(String name, int value)(Code) | | Sets a integerproperty on the message
Parameters:
name - the property name or key
Parameters:
value - the property value |
| setLongProperty | | void setLongProperty(String name, long value)(Code) | | Sets a long property on the message
Parameters:
name - the property name or key
Parameters:
value - the property value |
| setProperty | | void setProperty(String key, Object value)(Code) | | Set a property on the message
Parameters:
key - the key on which to associate the value
Parameters:
value - the property value |
| setProperty | | void setProperty(String key, Object value, PropertyScope scope)(Code) | | Set a property on the message
Parameters:
key - the key on which to associate the value
Parameters:
value - the property value
Parameters:
scope - The scope at which to set the property at
See Also: PropertyScope |
| setReplyTo | | void setReplyTo(Object replyTo)(Code) | | 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.
Parameters:
replyTo - the endpointUri url to reply to |
| setStringProperty | | void setStringProperty(String name, String value)(Code) | | Sets a String property on the message
Parameters:
name - the property name or key
Parameters:
value - the property value |
|
|