org.mule.module.http.internal.listener

Class HttpMessageProcessorTemplate

java.lang.Object

org.mule.module.http.internal.listener.HttpMessageProcessorTemplate

All Implemented Interfaces:

AsyncResponseFlowProcessingPhaseTemplate, MessageProcessTemplate, ThrottlingPhaseTemplate

public class HttpMessageProcessorTemplate
extends Object
implements AsyncResponseFlowProcessingPhaseTemplate, ThrottlingPhaseTemplate

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HttpMessageProcessorTemplate(MuleEvent sourceMuleEvent, MessageProcessor messageProcessor, HttpResponseReadyCallback responseReadyCallback, HttpResponseBuilder responseBuilder, HttpResponseBuilder errorResponseBuilder)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterFailureProcessingFlow(Exception exception) Call when the processing of the message through the flow fails in an exception strategy
protected HttpResponse	buildErrorResponse()
protected HttpResponse	buildResponse(MuleEvent muleEvent, HttpResponseBuilder responseBuilder, ResponseCompletionCallback responseCompletationCallback)
void	discardMessageOnThrottlingExceeded() Discards the message due to ThrottlingPolicy configured for the MessageSource is exceeded
protected HttpResponse	doBuildResponse(MuleEvent muleEvent, HttpResponseBuilder responseBuilder, ResponseCompletionCallback responseCompletationCallback)
MuleEvent	getMuleEvent()
MuleEvent	routeEvent(MuleEvent muleEvent) Routes the MuleEvent through the processors chain
void	sendFailureResponseToClient(MessagingException messagingException, ResponseCompletionCallback responseCompletationCallback)
void	sendResponseToClient(MuleEvent muleEvent, ResponseCompletionCallback responseCompletationCallback) Template method to send a response after processing the message.
void	setThrottlingPolicyStatistics(long remainingRequestInCurrentPeriod, long maximumRequestAllowedPerPeriod, long timeUntilNextPeriodInMillis) Set up throttling policy state to be used by the MessageSource for debugging or information purpose.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_DISCARD_STATUS_CODE

public static final int MESSAGE_DISCARD_STATUS_CODE

MESSAGE_DISCARD_MESSAGE_BODY

public static final String MESSAGE_DISCARD_MESSAGE_BODY

See Also:

Constant Field Values

MESSAGE_DISCARD_REASON_PHRASE

public static final String MESSAGE_DISCARD_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

HttpMessageProcessorTemplate

public HttpMessageProcessorTemplate(MuleEvent sourceMuleEvent,
                            MessageProcessor messageProcessor,
                            HttpResponseReadyCallback responseReadyCallback,
                            HttpResponseBuilder responseBuilder,
                            HttpResponseBuilder errorResponseBuilder)

Method Detail

getMuleEvent

public MuleEvent getMuleEvent()
                       throws MuleException

Specified by:

getMuleEvent in interface AsyncResponseFlowProcessingPhaseTemplate

Specified by:

getMuleEvent in interface ThrottlingPhaseTemplate

Returns:

a MuleEvent created from the original message

Throws:

MuleException

routeEvent

public MuleEvent routeEvent(MuleEvent muleEvent)
                     throws MuleException

Description copied from interface: AsyncResponseFlowProcessingPhaseTemplate

Routes the MuleEvent through the processors chain

Specified by:

routeEvent in interface AsyncResponseFlowProcessingPhaseTemplate

Parameters:

muleEvent - MuleEvent created from the raw message of this context

Returns:

the response MuleEvent

Throws:

MuleException

afterFailureProcessingFlow

public void afterFailureProcessingFlow(Exception exception)

Description copied from interface: AsyncResponseFlowProcessingPhaseTemplate

Call when the processing of the message through the flow fails in an exception strategy

Specified by:

afterFailureProcessingFlow in interface AsyncResponseFlowProcessingPhaseTemplate

sendResponseToClient

public void sendResponseToClient(MuleEvent muleEvent,
                        ResponseCompletionCallback responseCompletationCallback)
                          throws MuleException

Description copied from interface: AsyncResponseFlowProcessingPhaseTemplate

Template method to send a response after processing the message.

This method is executed within the flow so if it fails it will trigger the exception strategy.

Specified by:

sendResponseToClient in interface AsyncResponseFlowProcessingPhaseTemplate

Parameters:

muleEvent - the event with the content of the response to be sent.

responseCompletationCallback - callback to be used for notifying the result of the operation

Throws:

MuleException - exception thrown when processing the message to send the response. If there's a failure when writing the response using the underlying transport or connector then the exception to throw must be a ResponseDispatchException.

buildErrorResponse

protected HttpResponse buildErrorResponse()

buildResponse

protected HttpResponse buildResponse(MuleEvent muleEvent,
                         HttpResponseBuilder responseBuilder,
                         ResponseCompletionCallback responseCompletationCallback)

doBuildResponse

protected HttpResponse doBuildResponse(MuleEvent muleEvent,
                           HttpResponseBuilder responseBuilder,
                           ResponseCompletionCallback responseCompletationCallback)

sendFailureResponseToClient

public void sendFailureResponseToClient(MessagingException messagingException,
                               ResponseCompletionCallback responseCompletationCallback)
                                 throws MuleException

Specified by:

sendFailureResponseToClient in interface AsyncResponseFlowProcessingPhaseTemplate

Parameters:

messagingException - exception thrown during the flow execution.

responseCompletationCallback - callback to be used for notifying the result of the operation

Throws:

MuleException - exception thrown when processing the message to send the response.

discardMessageOnThrottlingExceeded

public void discardMessageOnThrottlingExceeded()
                                        throws MuleException

Description copied from interface: ThrottlingPhaseTemplate

Discards the message due to ThrottlingPolicy configured for the MessageSource is exceeded

Specified by:

discardMessageOnThrottlingExceeded in interface ThrottlingPhaseTemplate

Throws:

MuleException

setThrottlingPolicyStatistics

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

Description copied from interface: ThrottlingPhaseTemplate

Set up throttling policy state to be used by the MessageSource for debugging or information purpose. Not all throttling policy supports statistics so this method may not be called

Specified by:

setThrottlingPolicyStatistics in interface ThrottlingPhaseTemplate

Parameters:

remainingRequestInCurrentPeriod - the remaining allowed messages in the current period

maximumRequestAllowedPerPeriod - the maximum allowed messages in a period

timeUntilNextPeriodInMillis - time in milliseconds until the next period starts