com.yahoo.bard.webservice.web

Interface RateLimiter

All Known Implementing Classes:

DefaultRateLimiter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RateLimiter

An object containing the logic to keep track of and limit the amount of requests being made to the webservice.

Method Summary

Modifier and Type	Method and Description
RateLimitRequestToken	getToken(javax.ws.rs.container.ContainerRequestContext request) Request a token from the RateLimiter, which represents an in-flight request.

Method Detail

getToken

RateLimitRequestToken getToken(javax.ws.rs.container.ContainerRequestContext request)

Request a token from the RateLimiter, which represents an in-flight request.

Parameters:

request - The object representing the request

Returns:

a RateLimitRequestToken object representing a request.