Package io.apiman.gateway.engine.policies.limiting

Class BucketFactory

java.lang.Object

io.apiman.gateway.engine.policies.limiting.BucketFactory

public class BucketFactory
extends Object

Author:

Marc Savy <marc@blackparrotlabs.io>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BucketFactory.BucketIdBuilderContext

Field Summary

Fields

Modifier and Type	Field	Description
static String	NO_CLIENT_AVAILABLE
static String	NO_USER_AVAILABLE

Constructor Summary

Constructors

Constructor	Description
BucketFactory()

Method Summary

Modifier and Type	Method	Description
String	bucketId(ApiRequest request, RateLimitingConfig config)	Generate rate limiting bucket ID for API Request
String	bucketId(RateLimitingConfig config, BucketFactory.BucketIdBuilderContext context)	Creates the ID of the rate bucket to use.
String	bucketId(RateLimitingProbeConfig probeConfig, ProbeContext probeContext, RateLimitingConfig config)	Generate rate limiting bucket ID for a probe request
RateBucketPeriod	getPeriod(RateLimitingConfig config)	Gets the appropriate bucket period from the config.

Methods inherited from class java.lang.Object

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

Field Detail

NO_USER_AVAILABLE

public static final String NO_USER_AVAILABLE

See Also:

Constant Field Values

NO_CLIENT_AVAILABLE

public static final String NO_CLIENT_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

BucketFactory

public BucketFactory()

Method Detail

bucketId

public String bucketId(RateLimitingConfig config,
                       BucketFactory.BucketIdBuilderContext context)

Creates the ID of the rate bucket to use. The ID is composed differently depending on the configuration of the policy.

getPeriod

public RateBucketPeriod getPeriod(RateLimitingConfig config)

Gets the appropriate bucket period from the config.

bucketId

public String bucketId(ApiRequest request,
                       RateLimitingConfig config)

Generate rate limiting bucket ID for API Request

bucketId

public String bucketId(RateLimitingProbeConfig probeConfig,
                       ProbeContext probeContext,
                       RateLimitingConfig config)

Generate rate limiting bucket ID for a probe request