org.mule.providers.dq
Class DQMessageAdapter

java.lang.Object
  extended byorg.mule.providers.AbstractMessageAdapter
      extended byorg.mule.providers.dq.DQMessageAdapter
All Implemented Interfaces:
Serializable, UMOMessageAdapter

public class DQMessageAdapter
extends AbstractMessageAdapter

DQMessageAdapter provides a wrapper for a DataQueue Message. Users can obtain the contents of the message through the payload property.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mule.providers.AbstractMessageAdapter
attachments, encoding, exceptionPayload, id, logger, properties
 
Constructor Summary
DQMessageAdapter(Object message)
          Constructor
 
Method Summary
 Object getPayload()
           
 byte[] getPayloadAsBytes()
          Converts the message implementation into a byte array representation
 String getPayloadAsString(String encoding)
          Converts the message implementation into a String representation
 
Methods inherited from class org.mule.providers.AbstractMessageAdapter
addAttachment, addProperties, clearProperties, convertToBytes, getAttachment, getAttachmentNames, getBooleanProperty, getCorrelationGroupSize, getCorrelationId, getCorrelationSequence, getDoubleProperty, getEncoding, getExceptionPayload, getIntProperty, getLongProperty, getPayloadAsString, getProperty, getProperty, getPropertyNames, getReplyTo, getStringProperty, getUniqueId, removeAttachment, removeProperty, setBooleanProperty, setCorrelationGroupSize, setCorrelationId, setCorrelationSequence, setDoubleProperty, setEncoding, setExceptionPayload, setIntProperty, setLongProperty, setProperty, setReplyTo, setStringProperty, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DQMessageAdapter

public DQMessageAdapter(Object message)
                 throws MessageTypeNotSupportedException
Constructor

Parameters:
message - The message
Method Detail

getPayload

public final Object getPayload()
Returns:
the current message
See Also:
UMOMessageAdapter.getPayload()

getPayloadAsBytes

public final byte[] getPayloadAsBytes()
                               throws Exception
Description copied from interface: UMOMessageAdapter
Converts the message implementation into a byte array representation

Returns:
byte array of the message
Throws:
Exception - Implemetation may throw an endpoint specific exception
See Also:
UMOMessageAdapter.getPayloadAsBytes()

getPayloadAsString

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

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


Copyright © 2003-2006 MuleSource Inc.. All Rights Reserved.