io.apiman.gateway.engine.es

Class ESRateLimiterComponent

java.lang.Object

io.apiman.gateway.engine.es.AbstractESComponent

io.apiman.gateway.engine.es.ESRateLimiterComponent

All Implemented Interfaces:

io.apiman.gateway.engine.components.IRateLimiterComponent, io.apiman.gateway.engine.IComponent

public class ESRateLimiterComponent
extends AbstractESComponent
implements io.apiman.gateway.engine.components.IRateLimiterComponent

An elasticsearch implementation of the rate limiter component.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
ESRateLimiterComponent(Map<String,String> config) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(String bucketId, io.apiman.gateway.engine.rates.RateBucketPeriod period, long limit, long increment, io.apiman.gateway.engine.async.IAsyncResultHandler<io.apiman.gateway.engine.components.rate.RateLimitResponse> handler)
protected String	getIndexName() Gets the configured index name.
protected io.apiman.gateway.engine.rates.RateLimiterBucket	readBucket(org.elasticsearch.action.get.GetResponse response) Unmarshal a rate limiter bucket from the information in ES.
protected void	updateBucketAndReturn(String id, io.apiman.gateway.engine.rates.RateLimiterBucket bucket, io.apiman.gateway.engine.components.rate.RateLimitResponse rlr, long version, String bucketId, io.apiman.gateway.engine.rates.RateBucketPeriod period, long limit, long increment, io.apiman.gateway.engine.async.IAsyncResultHandler<io.apiman.gateway.engine.components.rate.RateLimitResponse> handler) Update the bucket in ES and then return the rate limit response to the original handler.

Methods inherited from class io.apiman.gateway.engine.es.AbstractESComponent

getClient

Methods inherited from class java.lang.Object

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

Constructor Detail

ESRateLimiterComponent

public ESRateLimiterComponent(Map<String,String> config)

Constructor.

Parameters:

config - the configuration

Method Detail

accept

public void accept(String bucketId,
          io.apiman.gateway.engine.rates.RateBucketPeriod period,
          long limit,
          long increment,
          io.apiman.gateway.engine.async.IAsyncResultHandler<io.apiman.gateway.engine.components.rate.RateLimitResponse> handler)

Specified by:

accept in interface io.apiman.gateway.engine.components.IRateLimiterComponent

See Also:

IRateLimiterComponent.accept(java.lang.String, io.apiman.gateway.engine.rates.RateBucketPeriod, long, long, io.apiman.gateway.engine.async.IAsyncResultHandler)

readBucket

protected io.apiman.gateway.engine.rates.RateLimiterBucket readBucket(org.elasticsearch.action.get.GetResponse response)

Unmarshal a rate limiter bucket from the information in ES.

Parameters:

response -

updateBucketAndReturn

protected void updateBucketAndReturn(String id,
                         io.apiman.gateway.engine.rates.RateLimiterBucket bucket,
                         io.apiman.gateway.engine.components.rate.RateLimitResponse rlr,
                         long version,
                         String bucketId,
                         io.apiman.gateway.engine.rates.RateBucketPeriod period,
                         long limit,
                         long increment,
                         io.apiman.gateway.engine.async.IAsyncResultHandler<io.apiman.gateway.engine.components.rate.RateLimitResponse> handler)

Update the bucket in ES and then return the rate limit response to the original handler. If the update fails because we have a stale version, then try the whole thing again (because we conflicted with another request).

Parameters:

id -

bucket -

rlr -

version -

limit -

period -

bucketId -

increment -

handler -

getIndexName

protected String getIndexName()

Description copied from class: AbstractESComponent

Gets the configured index name.

Specified by:

getIndexName in class AbstractESComponent

See Also:

AbstractESComponent.getIndexName()