org.mule.providers.http
Class HttpMessageAdapter

java.lang.Object
  extended byorg.mule.providers.AbstractMessageAdapter
      extended byorg.mule.providers.http.HttpMessageAdapter
All Implemented Interfaces:
Serializable, ThreadSafeAccess, UMOMessageAdapter

public class HttpMessageAdapter
extends AbstractMessageAdapter

HttpMessageAdapter Wraps an incoming Http Request making the payload and headers available as standard message adapter.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mule.providers.AbstractMessageAdapter
attachments, DEFAULT_FAILFAST, encoding, exceptionPayload, id, logger, properties, READ, WRITE
 
Constructor Summary
protected HttpMessageAdapter(HttpMessageAdapter template)
           
  HttpMessageAdapter(Object message)
           
 
Method Summary
 org.apache.commons.httpclient.Header getHeader(String name)
           
 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
 Object getProperty(String key)
          Gets a property of the message implementation
 ThreadSafeAccess newThreadCopy()
          By default we return "this".
 
Methods inherited from class org.mule.providers.AbstractMessageAdapter
addAttachment, addProperties, assertAccess, clearProperties, convertToBytes, getAttachment, getAttachmentNames, getBooleanProperty, getCorrelationGroupSize, getCorrelationId, getCorrelationSequence, getDoubleProperty, getEncoding, getExceptionPayload, getIntProperty, getLongProperty, getPayloadAsString, getProperty, getPropertyNames, getReplyTo, getStringProperty, getUniqueId, isDisabled, newException, removeAttachment, removeProperty, resetAccessControl, 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

HttpMessageAdapter

public HttpMessageAdapter(Object message)
                   throws MessageTypeNotSupportedException

HttpMessageAdapter

protected HttpMessageAdapter(HttpMessageAdapter template)
Method Detail

getPayload

public Object getPayload()
Returns:
the current message

getPayloadAsBytes

public 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

getPayloadAsString

public String getPayloadAsString(String encoding)
                          throws Exception
Description copied from interface: UMOMessageAdapter
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

getProperty

public Object getProperty(String key)
Description copied from interface: UMOMessageAdapter
Gets a property of the message implementation

Specified by:
getProperty in interface UMOMessageAdapter
Overrides:
getProperty in class AbstractMessageAdapter

getHeader

public org.apache.commons.httpclient.Header getHeader(String name)

newThreadCopy

public ThreadSafeAccess newThreadCopy()
Description copied from class: AbstractMessageAdapter
By default we return "this". This allows older code to inter-operate but doesn't, of course, give the required safety. Subclasses should override this method. Re-writing the threading handling should remove this requirement....

Specified by:
newThreadCopy in interface ThreadSafeAccess
Overrides:
newThreadCopy in class AbstractMessageAdapter
Returns:
A new copy of this


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