io.apiman.gateway.engine.components

Interface IRateLimiterComponent

All Superinterfaces:

IComponent

All Known Implementing Classes:

InMemoryRateLimiterComponent

public interface IRateLimiterComponent
extends IComponent

A component used to enforce rate limits. This component is responsible for ensuring that request rates are not exceeded. Request rates may be limited by a number of different criteria. Generally, N number of requests are allowed within a static time window. This time window can be of varying sizes. For example, we might allow only 1000 requests per hour.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(String bucketId, RateBucketPeriod period, long limit, long increment, IAsyncResultHandler<RateLimitResponse> handler) Adds another request to the given rate bucket.

Method Detail

accept

void accept(String bucketId,
          RateBucketPeriod period,
          long limit,
          long increment,
          IAsyncResultHandler<RateLimitResponse> handler)

Adds another request to the given rate bucket. Sends a true signal if the request should be accepted or false if it should be rejected.

Parameters:

bucketId -

period -

limit -

increment -

handler -