org.mule.transport.http

Class HttpClientMessageDispatcher

java.lang.Object

org.mule.transport.AbstractTransportMessageHandler

org.mule.transport.AbstractMessageDispatcher

org.mule.transport.http.HttpClientMessageDispatcher

All Implemented Interfaces:

org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.LifecycleStateEnabled, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.processor.MessageProcessor, org.mule.api.transport.Connectable, org.mule.api.transport.MessageDispatcher

Direct Known Subclasses:

HttpsClientMessageDispatcher

public class HttpClientMessageDispatcher
extends org.mule.transport.AbstractMessageDispatcher

HttpClientMessageDispatcher dispatches Mule events over HTTP.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_STATUS_CODE_RANGE_START Range start for http error status codes.
protected HttpConnector	httpConnector
static int	REDIRECT_STATUS_CODE_RANGE_START

Fields inherited from class org.mule.transport.AbstractMessageDispatcher

defaultOutboundTransformers, defaultResponseTransformers

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, connector, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

Fields inherited from interface org.mule.api.transport.MessageDispatcher

RECEIVE_NO_WAIT, RECEIVE_WAIT_INDEFINITELY

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
HttpClientMessageDispatcher(org.mule.api.endpoint.OutboundEndpoint endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.commons.httpclient.HttpMethod	createEntityMethod(org.mule.api.MuleEvent event, Object body, org.apache.commons.httpclient.methods.EntityEnclosingMethod postMethod)
protected void	doConnect()
protected void	doDisconnect()
protected void	doDispatch(org.mule.api.MuleEvent event)
protected void	doDispose()
protected void	doInitialise()
protected org.mule.api.MuleMessage	doSend(org.mule.api.MuleEvent event)
protected org.apache.commons.httpclient.HttpMethod	execute(org.mule.api.MuleEvent event, org.apache.commons.httpclient.HttpMethod httpMethod)
protected org.apache.commons.httpclient.HostConfiguration	getHostConfig(URI uri)
protected org.apache.commons.httpclient.HttpMethod	getMethod(org.mule.api.MuleEvent event)
protected org.mule.api.MuleMessage	getResponseFromMethod(org.apache.commons.httpclient.HttpMethod httpMethod, org.mule.api.ExceptionPayload ep)
protected org.mule.api.MuleMessage	handleRedirect(org.apache.commons.httpclient.HttpMethod method, org.mule.api.MuleEvent event)
protected void	processCookies(org.mule.api.MuleEvent event)
protected boolean	returnException(org.mule.api.MuleEvent event, org.apache.commons.httpclient.HttpMethod httpMethod) An exception is thrown if http.status >= 400 and exceptions are not disabled through one of the following mechanisms in order of precedence: - setting to true the flow variable "http.disable.status.code.exception.check" - setting to true the outbound property "http.disable.status.code.exception.check" - setting to false the outbound endpoint attribute "exceptionOnMessageError"
protected void	setPropertyFromEndpoint(org.mule.api.MuleEvent event, org.mule.api.MuleMessage msg, String prop)

Methods inherited from class org.mule.transport.AbstractMessageDispatcher

applyOutboundTransformers, applyResponseTransformers, createLifecycleManager, getDispatcherName, getEndpoint, getWorkManager, process, returnResponse, returnResponse

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, connectHandler, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doStart, doStartHandler, doStop, getConnectEventId, getConnectionDescription, getConnector, getLifecycleState, initialise, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopped, isStopping, passivate, setEndpoint, start, stop, toString, validate, validateConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.MessageDispatcher

activate, createMuleMessage, createMuleMessage, getConnector, passivate, validate

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, getConnectionDescription, isConnected, validateConnection

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Startable

start

Methods inherited from interface org.mule.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Field Detail

ERROR_STATUS_CODE_RANGE_START

public static final int ERROR_STATUS_CODE_RANGE_START

Range start for http error status codes.

See Also:

Constant Field Values

REDIRECT_STATUS_CODE_RANGE_START

public static final int REDIRECT_STATUS_CODE_RANGE_START

See Also:

Constant Field Values

httpConnector

protected final HttpConnector httpConnector

Constructor Detail

HttpClientMessageDispatcher

public HttpClientMessageDispatcher(org.mule.api.endpoint.OutboundEndpoint endpoint)

Method Detail

doInitialise

protected void doInitialise()
                     throws org.mule.api.lifecycle.InitialisationException

Overrides:

doInitialise in class org.mule.transport.AbstractTransportMessageHandler

Throws:

org.mule.api.lifecycle.InitialisationException

doConnect

protected void doConnect()
                  throws Exception

Overrides:

doConnect in class org.mule.transport.AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Overrides:

doDisconnect in class org.mule.transport.AbstractTransportMessageHandler

Throws:

Exception

doDispatch

protected void doDispatch(org.mule.api.MuleEvent event)
                   throws Exception

Specified by:

doDispatch in class org.mule.transport.AbstractMessageDispatcher

Throws:

Exception

execute

protected org.apache.commons.httpclient.HttpMethod execute(org.mule.api.MuleEvent event,
                                               org.apache.commons.httpclient.HttpMethod httpMethod)
                                                    throws Exception

Throws:

Exception

processCookies

protected void processCookies(org.mule.api.MuleEvent event)

getMethod

protected org.apache.commons.httpclient.HttpMethod getMethod(org.mule.api.MuleEvent event)
                                                      throws org.mule.api.transformer.TransformerException

Throws:

org.mule.api.transformer.TransformerException

setPropertyFromEndpoint

protected void setPropertyFromEndpoint(org.mule.api.MuleEvent event,
                           org.mule.api.MuleMessage msg,
                           String prop)

createEntityMethod

protected org.apache.commons.httpclient.HttpMethod createEntityMethod(org.mule.api.MuleEvent event,
                                                          Object body,
                                                          org.apache.commons.httpclient.methods.EntityEnclosingMethod postMethod)
                                                               throws org.mule.api.transformer.TransformerException

Throws:

org.mule.api.transformer.TransformerException

doSend

protected org.mule.api.MuleMessage doSend(org.mule.api.MuleEvent event)
                                   throws Exception

Specified by:

doSend in class org.mule.transport.AbstractMessageDispatcher

Throws:

Exception

handleRedirect

protected org.mule.api.MuleMessage handleRedirect(org.apache.commons.httpclient.HttpMethod method,
                                      org.mule.api.MuleEvent event)
                                           throws HttpResponseException,
                                                  org.mule.api.MuleException,
                                                  IOException

Throws:

HttpResponseException

org.mule.api.MuleException

IOException

getResponseFromMethod

protected org.mule.api.MuleMessage getResponseFromMethod(org.apache.commons.httpclient.HttpMethod httpMethod,
                                             org.mule.api.ExceptionPayload ep)
                                                  throws IOException,
                                                         org.mule.api.MuleException

Throws:

IOException

org.mule.api.MuleException

returnException

protected boolean returnException(org.mule.api.MuleEvent event,
                      org.apache.commons.httpclient.HttpMethod httpMethod)

An exception is thrown if http.status >= 400 and exceptions are not disabled through one of the following mechanisms in order of precedence: - setting to true the flow variable "http.disable.status.code.exception.check" - setting to true the outbound property "http.disable.status.code.exception.check" - setting to false the outbound endpoint attribute "exceptionOnMessageError"

Returns:

if an exception should be thrown

getHostConfig

protected org.apache.commons.httpclient.HostConfiguration getHostConfig(URI uri)
                                                                 throws Exception

Throws:

Exception

doDispose

protected void doDispose()

Overrides:

doDispose in class org.mule.transport.AbstractTransportMessageHandler