org.mule.providers.http.servlet
Class HttpRequestMessageAdapter

java.lang.Object
  org.mule.providers.AbstractMessageAdapter
      org.mule.providers.http.servlet.HttpRequestMessageAdapter

All Implemented Interfaces:

Serializable, org.mule.umo.provider.UMOMessageAdapter

public class HttpRequestMessageAdapter
extends org.mule.providers.AbstractMessageAdapter

HttpRequestMessageAdapter is a Mule message adapter for javax.servletHttpServletRequest objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mule.providers.AbstractMessageAdapter

attachments, encoding, exceptionPayload, id, logger, properties

Constructor Summary

HttpRequestMessageAdapter(Object message)

Method Summary

Object	getPayload()
byte[]	getPayloadAsBytes()
String	getPayloadAsString(String encoding) Converts the message implementation into a String representation
Object	getReplyTo() Sets a replyTo address for this message.
HttpServletRequest	getRequest()
String	getUniqueId()
boolean	isBinary()
protected boolean	isText(String contentType)
void	setReplyTo(Object replyTo) Sets a replyTo address for this message.

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, getStringProperty, removeAttachment, removeProperty, setBooleanProperty, setCorrelationGroupSize, setCorrelationId, setCorrelationSequence, setDoubleProperty, setEncoding, setExceptionPayload, setIntProperty, setLongProperty, setProperty, setStringProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpRequestMessageAdapter

public HttpRequestMessageAdapter(Object message)
                          throws org.mule.umo.MessagingException

Throws:

org.mule.umo.MessagingException

Method Detail

getPayload

public Object getPayload()

isBinary

public boolean isBinary()

getPayloadAsBytes

public byte[] getPayloadAsBytes()
                         throws Exception

Throws:

Exception

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

getRequest

public HttpServletRequest getRequest()

getUniqueId

public String getUniqueId()

Specified by:

getUniqueId in interface org.mule.umo.provider.UMOMessageAdapter

Overrides:

getUniqueId in class org.mule.providers.AbstractMessageAdapter

isText

protected boolean isText(String contentType)

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 org.mule.umo.provider.UMOMessageAdapter

Overrides:

setReplyTo in class org.mule.providers.AbstractMessageAdapter

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 org.mule.umo.provider.UMOMessageAdapter

Overrides:

getReplyTo in class org.mule.providers.AbstractMessageAdapter

Returns:

the endpointUri url to reply to or null if one has not been set