com.yahoo.bard.webservice.web.filters

Class RateLimitFilter

java.lang.Object

com.yahoo.bard.webservice.web.filters.RateLimitFilter

All Implemented Interfaces:

javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter

@PreMatching
 @Singleton
 @Priority(value=5)
public class RateLimitFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter

Filter all requests to respond RATE_LIMIT if user/global limits are exceeded.

Field Summary

Fields

Modifier and Type	Field and Description
protected RateLimiter	rateLimiter

Constructor Summary

Constructors

Constructor and Description
RateLimitFilter() Deprecated. Use the constructor that takes a RateLimiter
RateLimitFilter(RateLimiter rateLimiter) Constructs a RateLimitFilter using the provided rate limiter.

Method Summary

Modifier and Type	Method and Description
void	filter(javax.ws.rs.container.ContainerRequestContext request)
void	filter(javax.ws.rs.container.ContainerRequestContext request, javax.ws.rs.container.ContainerResponseContext response)

Methods inherited from class java.lang.Object

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

Field Detail

rateLimiter

protected final RateLimiter rateLimiter

Constructor Detail

RateLimitFilter

@Inject
public RateLimitFilter(RateLimiter rateLimiter)
                        throws SystemConfigException

Constructs a RateLimitFilter using the provided rate limiter.

Parameters:

rateLimiter - RateLimiter object to handle rate limiting logic.

Throws:

SystemConfigException - if RateLimiter construction fails.

RateLimitFilter

@Deprecated
public RateLimitFilter()
                            throws SystemConfigException

Deprecated. Use the constructor that takes a RateLimiter

Load DefaultRateLimiter for this filter.

Throws:

SystemConfigException - If any critical configuration fails to load for the DefaultRateLimiter

Method Detail

filter

public void filter(javax.ws.rs.container.ContainerRequestContext request)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

filter

public void filter(javax.ws.rs.container.ContainerRequestContext request,
                   javax.ws.rs.container.ContainerResponseContext response)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerResponseFilter

Throws:

IOException