Package org.atmosphere.interceptor

Class RateLimitingInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.RateLimitingInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class RateLimitingInterceptor
extends AtmosphereInterceptorAdapter

Inbound rate-limiting interceptor using a token-bucket algorithm. Limits the number of messages a single client can send per time window, preventing abuse and protecting server resources.

The token bucket refills at a steady rate of maxMessages / windowSeconds tokens per second, with bursts up to maxMessages allowed. This provides smooth rate limiting that tolerates short bursts while enforcing long-term limits.

Configuration (init-params or ApplicationConfig)

• org.atmosphere.rateLimit.maxMessages — max messages per window / burst size (default: 100)
• org.atmosphere.rateLimit.windowSeconds — refill window in seconds (default: 60)
• org.atmosphere.rateLimit.policy — action when exceeded: drop (silent), disconnect (close connection) (default: drop)

Usage

 framework.interceptor(new RateLimitingInterceptor());
 

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RateLimitingInterceptor.Policy	Rate limit exceeded policy.

Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder

InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
RateLimitingInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
void	destroy()	Clean the AtmosphereInterceptor when removed or when the Atmosphere is undeployed.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
int	maxMessages()
RateLimitingInterceptor.Policy	policy()
void	postInspect(AtmosphereResource r)	Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.
InvokationOrder.PRIORITY	priority()	Return the priority an AtmosphereInterceptor must be executed.
String	toString()
long	totalDisconnected()
long	totalDropped()
int	trackedClients()

Methods inherited from class java.lang.Object

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

Constructor Details

RateLimitingInterceptor

public RateLimitingInterceptor()

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Overrides:

configure in class AtmosphereInterceptorAdapter

Parameters:

config - AtmosphereConfig

inspect

public Action inspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

inspect in interface AtmosphereInterceptor

Overrides:

inspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

Returns:

Action.CONTINUE or Action.SUSPEND to dispatch the AtmosphereResource to other AtmosphereInterceptor or AtmosphereHandler. Return Action.TYPE.CANCELLED to stop the processing.

postInspect

public void postInspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked after an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

postInspect in interface AtmosphereInterceptor

Overrides:

postInspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

destroy

public void destroy()

Description copied from interface: AtmosphereInterceptor

Clean the AtmosphereInterceptor when removed or when the Atmosphere is undeployed.

Specified by:

destroy in interface AtmosphereInterceptor

Overrides:

destroy in class AtmosphereInterceptorAdapter

totalDropped

public long totalDropped()

Returns:

total messages dropped due to rate limiting

totalDisconnected

public long totalDisconnected()

Returns:

total clients disconnected due to rate limiting

maxMessages

public int maxMessages()

Returns:

the configured max messages per window

policy

public RateLimitingInterceptor.Policy policy()

Returns:

the configured policy

trackedClients

public int trackedClients()

Returns:

the number of currently tracked clients

priority

public InvokationOrder.PRIORITY priority()

Description copied from interface: InvokationOrder

Return the priority an AtmosphereInterceptor must be executed.

Specified by:

priority in interface InvokationOrder

Overrides:

priority in class AtmosphereInterceptorAdapter

Returns:

PRIORITY

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter