com.predic8.membrane.core.interceptor.ratelimit

Class RateLimitInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.ratelimit.RateLimitInterceptor

All Implemented Interfaces:

Interceptor

public class RateLimitInterceptor
extends AbstractInterceptor

Description

Allows rate limiting (Experimental)

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields

Modifier and Type	Field and Description
RateLimitStrategy	rateLimitStrategy

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

id, name, router

Constructor Summary

Constructors

Constructor and Description
RateLimitInterceptor()
RateLimitInterceptor(org.joda.time.Duration requestLimitDuration, int requestLimit)

Method Summary

Modifier and Type	Method and Description
int	getRequestLimit()
String	getRequestLimitDuration()
String	getShortDescription()
Outcome	handleRequest(Exchange exc)
void	setRequestLimit(int rl)
void	setRequestLimitDuration(org.joda.time.Duration rld)
void	setRequestLimitDuration(String rld)
void	setResponseToServiceUnavailable(Exchange exc)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getId, getLongDescription, getRouter, getRule, handleAbort, handleResponse, init, init, setDisplayName, setFlow, setId

Methods inherited from class java.lang.Object

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

Field Detail

rateLimitStrategy

public RateLimitStrategy rateLimitStrategy

Constructor Detail

RateLimitInterceptor

public RateLimitInterceptor()

RateLimitInterceptor

public RateLimitInterceptor(org.joda.time.Duration requestLimitDuration,
                            int requestLimit)

Method Detail

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

setResponseToServiceUnavailable

public void setResponseToServiceUnavailable(Exchange exc)
                                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getRequestLimit

public int getRequestLimit()

setRequestLimit

public void setRequestLimit(int rl)

Default

1000

Description

number of requests

getRequestLimitDuration

public String getRequestLimitDuration()

setRequestLimitDuration

public void setRequestLimitDuration(String rld)

Default

PT3600S

Description

Duration after the limit is reset in PTxS where x is the time in seconds

setRequestLimitDuration

public void setRequestLimitDuration(org.joda.time.Duration rld)

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor