Package com.predic8.membrane.core.interceptor

Class ThrottleInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.ThrottleInterceptor

All Implemented Interfaces:

Interceptor

public class ThrottleInterceptor
extends AbstractInterceptor

Description

The throttle feature can slow down traffic to thwart denial of service attacks.

Topic

6. Security

Nested Class Summary

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

Interceptor.Flow

Field Summary

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

name, router

Constructor Summary

Constructors

Constructor	Description
ThrottleInterceptor()

Method Summary

Modifier and Type	Method	Description
int	getBusyDelay()
long	getDelay()
String	getLongDescription()
int	getMaxThreads()
String	getShortDescription()
void	handleAbort(Exchange exchange)	Called when any Interceptor.handleRequest(Exchange) or Interceptor.handleResponse(Exchange) later in the chain returned Outcome.ABORT or threw an exception.
Outcome	handleRequest(Exchange exc)
Outcome	handleResponse(Exchange exc)
void	setBusyDelay(int busyDelay)
void	setDelay(long delay)
void	setMaxThreads(int maxThreads)

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

getDisplayName, getFlow, getHelpId, getMessage, getRouter, getRule, init, init, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Constructor Details

ThrottleInterceptor

public ThrottleInterceptor()

Method Details

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

handleResponse

public Outcome handleResponse(Exchange exc)
                       throws Exception

Specified by:

handleResponse in interface Interceptor

Overrides:

handleResponse in class AbstractInterceptor

Throws:

Exception

handleAbort

public void handleAbort(Exchange exchange)

Description copied from interface: Interceptor

Called when any Interceptor.handleRequest(Exchange) or Interceptor.handleResponse(Exchange) later in the chain returned Outcome.ABORT or threw an exception.

handleAbort is called in the reverse order of the chain (as handleResponse is).

Specified by:

handleAbort in interface Interceptor

Overrides:

handleAbort in class AbstractInterceptor

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

Default

0

Description

If non-zero, delays requests by specified number of milliseconds.

Example

1000

getMaxThreads

public int getMaxThreads()

setMaxThreads

public void setMaxThreads(int maxThreads)

Default

0

Description

If non-zero, newly incoming request are aborted if the number of running requests has reached this limit.

Example

5

getBusyDelay

public int getBusyDelay()

setBusyDelay

public void setBusyDelay(int busyDelay)

Default

0

Description

If a newly incoming request exceeds maxThreads, the interceptor waits the specified number in milliseconds and retries once before aborting the request.

Example

3000

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor

getLongDescription

public String getLongDescription()

Specified by:

getLongDescription in interface Interceptor

Overrides:

getLongDescription in class AbstractInterceptor