org.mule.execution

Interface ThrottlingPhaseTemplate

All Superinterfaces:

MessageProcessTemplate

All Known Implementing Classes:

HttpMessageProcessorTemplate, HttpMessageProcessTemplate, HttpsMessageProcessTemplate, JettyContinuationsMessageProcessTemplate, JettyMessageProcessTemplate

public interface ThrottlingPhaseTemplate
extends MessageProcessTemplate

Template that a MessageSource must implement if it wants to participate in the throttling phase when processing a message

Method Summary

Methods

Modifier and Type	Method and Description
void	discardMessageOnThrottlingExceeded() Discards the message due to ThrottlingPolicy configured for the MessageSource is exceeded
MuleEvent	getMuleEvent()
void	setThrottlingPolicyStatistics(long remainingRequestInCurrentPeriod, long maximumRequestAllowedPerPeriod, long timeUntilNextPeriodInMillis) Set up throttling policy state to be used by the MessageSource for debugging or information purpose.

Method Detail

getMuleEvent

MuleEvent getMuleEvent()
                       throws MuleException

Returns:

a MuleEvent created from the original message

Throws:

MuleException

discardMessageOnThrottlingExceeded

void discardMessageOnThrottlingExceeded()
                                        throws MuleException

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

Throws:

MuleException

setThrottlingPolicyStatistics

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

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

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