org.mule.transport.http

Class HttpMessageProcessTemplate

java.lang.Object

org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

org.mule.transport.http.HttpMessageProcessTemplate

All Implemented Interfaces:

org.mule.execution.EndPhaseTemplate, org.mule.execution.FlowProcessingPhaseTemplate, org.mule.execution.MessageProcessTemplate, org.mule.execution.RequestResponseFlowProcessingPhaseTemplate, org.mule.execution.ThrottlingPhaseTemplate, org.mule.execution.ValidationPhaseTemplate

Direct Known Subclasses:

HttpsMessageProcessTemplate

public class HttpMessageProcessTemplate
extends org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>
implements org.mule.execution.RequestResponseFlowProcessingPhaseTemplate, org.mule.execution.ThrottlingPhaseTemplate, org.mule.execution.EndPhaseTemplate

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_DISCARD_STATUS_CODE
static String	MESSAGE_THROTTLED_REASON_PHRASE
static String	X_RATE_LIMIT_LIMIT_HEADER
static String	X_RATE_LIMIT_REMAINING_HEADER
static String	X_RATE_LIMIT_RESET_HEADER

Fields inherited from class org.mule.transport.AbstractTransportMessageProcessTemplate

logger

Constructor Summary

Constructors

Constructor and Description
HttpMessageProcessTemplate(HttpMessageReceiver messageReceiver, HttpServerConnection httpServerConnection)

Method Summary

Methods

Modifier and Type	Method and Description
Object	acquireMessage()
void	afterFailureProcessingFlow(org.mule.api.MuleException exception)
void	awaitTermination()
org.mule.api.MuleEvent	beforeRouteEvent(org.mule.api.MuleEvent muleEvent)
protected org.mule.api.MuleMessage	createMessageFromSource(Object message)
void	discardInvalidMessage()
void	discardMessageOnThrottlingExceeded()
protected HttpResponse	doBad(RequestLine requestLine)
protected HttpServerConnection	getHttpServerConnection()
void	messageProcessingEnded()
protected String	processRelativePath(String contextPath, String path)
protected void	processRemoteAddresses(org.mule.api.MuleMessage muleMessage) For a given MuleMessage will set the MULE_REMOTE_CLIENT_ADDRESS property taking into consideration if the header X-Forwarded-For is present in the request or not.
void	sendFailureResponseToClient(org.mule.api.MessagingException messagingException)
void	sendResponseToClient(org.mule.api.MuleEvent responseMuleEvent)
void	setThrottlingPolicyStatistics(long remainingRequestInCurrentPeriod, long maximumRequestAllowedPerPeriod, long timeUntilNextPeriodInMillis)
protected HttpResponse	transformResponse(Object response)
boolean	validateMessage()

Methods inherited from class org.mule.transport.AbstractTransportMessageProcessTemplate

afterFailureProcessingFlow, afterRouteEvent, afterSuccessfulProcessingFlow, createEventFromMuleMessage, getConnector, getFlowConstruct, getInboundEndpoint, getMessageReceiver, getMuleContext, getMuleEvent, getOriginalMessage, getOutputStream, propagateRootMessageIdProperty, routeEvent, warnIfMuleClientSendUsed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.execution.FlowProcessingPhaseTemplate

afterFailureProcessingFlow, afterRouteEvent, afterSuccessfulProcessingFlow, getMuleEvent, getOriginalMessage, routeEvent

Methods inherited from interface org.mule.execution.ThrottlingPhaseTemplate

getMuleEvent

Field Detail

MESSAGE_DISCARD_STATUS_CODE

public static final int MESSAGE_DISCARD_STATUS_CODE

MESSAGE_THROTTLED_REASON_PHRASE

public static final String MESSAGE_THROTTLED_REASON_PHRASE

See Also:

Constant Field Values

X_RATE_LIMIT_LIMIT_HEADER

public static final String X_RATE_LIMIT_LIMIT_HEADER

See Also:

Constant Field Values

X_RATE_LIMIT_REMAINING_HEADER

public static final String X_RATE_LIMIT_REMAINING_HEADER

See Also:

Constant Field Values

X_RATE_LIMIT_RESET_HEADER

public static final String X_RATE_LIMIT_RESET_HEADER

See Also:

Constant Field Values

Constructor Detail

HttpMessageProcessTemplate

public HttpMessageProcessTemplate(HttpMessageReceiver messageReceiver,
                          HttpServerConnection httpServerConnection)

Method Detail

sendResponseToClient

public void sendResponseToClient(org.mule.api.MuleEvent responseMuleEvent)
                          throws org.mule.api.MuleException

Specified by:

sendResponseToClient in interface org.mule.execution.RequestResponseFlowProcessingPhaseTemplate

Throws:

org.mule.api.MuleException

sendFailureResponseToClient

public void sendFailureResponseToClient(org.mule.api.MessagingException messagingException)
                                 throws org.mule.api.MuleException

Specified by:

sendFailureResponseToClient in interface org.mule.execution.RequestResponseFlowProcessingPhaseTemplate

Throws:

org.mule.api.MuleException

afterFailureProcessingFlow

public void afterFailureProcessingFlow(org.mule.api.MuleException exception)
                                throws org.mule.api.MuleException

Specified by:

afterFailureProcessingFlow in interface org.mule.execution.FlowProcessingPhaseTemplate

Overrides:

afterFailureProcessingFlow in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

Throws:

org.mule.api.MuleException

beforeRouteEvent

public org.mule.api.MuleEvent beforeRouteEvent(org.mule.api.MuleEvent muleEvent)
                                        throws org.mule.api.MuleException

Specified by:

beforeRouteEvent in interface org.mule.execution.FlowProcessingPhaseTemplate

Overrides:

beforeRouteEvent in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

Throws:

org.mule.api.MuleException

transformResponse

protected HttpResponse transformResponse(Object response)
                                  throws org.mule.api.MuleException

Throws:

org.mule.api.MuleException

createMessageFromSource

protected org.mule.api.MuleMessage createMessageFromSource(Object message)
                                                    throws org.mule.api.MuleException

Overrides:

createMessageFromSource in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

Throws:

org.mule.api.MuleException

processRemoteAddresses

protected void processRemoteAddresses(org.mule.api.MuleMessage muleMessage)

For a given MuleMessage will set the MULE_REMOTE_CLIENT_ADDRESS property taking into consideration if the header X-Forwarded-For is present in the request or not. In case it is, this method will also set the MULE_PROXY_ADDRESS property. If a proxy address is not passed in X-Forwarded-For, the connection address will be set as MULE_PROXY_ADDRESS.

Parameters:

muleMessage - MuleMessage to be enriched

See Also:

https://en.wikipedia.org/wiki/X-Forwarded-For

processRelativePath

protected String processRelativePath(String contextPath,
                         String path)

acquireMessage

public Object acquireMessage()
                      throws org.mule.api.MuleException

Specified by:

acquireMessage in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

Throws:

org.mule.api.MuleException

validateMessage

public boolean validateMessage()

Specified by:

validateMessage in interface org.mule.execution.ValidationPhaseTemplate

Overrides:

validateMessage in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

discardInvalidMessage

public void discardInvalidMessage()
                           throws org.mule.api.MuleException

Specified by:

discardInvalidMessage in interface org.mule.execution.ValidationPhaseTemplate

Overrides:

discardInvalidMessage in class org.mule.transport.AbstractTransportMessageProcessTemplate<HttpMessageReceiver,HttpConnector>

Throws:

org.mule.api.MuleException

doBad

protected HttpResponse doBad(RequestLine requestLine)
                      throws org.mule.api.MuleException

Throws:

org.mule.api.MuleException

getHttpServerConnection

protected HttpServerConnection getHttpServerConnection()

discardMessageOnThrottlingExceeded

public void discardMessageOnThrottlingExceeded()
                                        throws org.mule.api.MuleException

Specified by:

discardMessageOnThrottlingExceeded in interface org.mule.execution.ThrottlingPhaseTemplate

Throws:

org.mule.api.MuleException

setThrottlingPolicyStatistics

public void setThrottlingPolicyStatistics(long remainingRequestInCurrentPeriod,
                                 long maximumRequestAllowedPerPeriod,
                                 long timeUntilNextPeriodInMillis)

Specified by:

setThrottlingPolicyStatistics in interface org.mule.execution.ThrottlingPhaseTemplate

messageProcessingEnded

public void messageProcessingEnded()

Specified by:

messageProcessingEnded in interface org.mule.execution.EndPhaseTemplate

awaitTermination

public void awaitTermination()
                      throws InterruptedException

Throws:

InterruptedException