Package io.apiman.gateway.engine.policies

Class RateLimitingPolicy

java.lang.Object

io.apiman.gateway.engine.policies.AbstractMappedPolicy<RateLimitingConfig>

io.apiman.gateway.engine.policies.RateLimitingPolicy

All Implemented Interfaces:

IPolicy, IPolicyProbe<RateLimitingConfig,RateLimitingProbeConfig>

Direct Known Subclasses:

QuotaPolicy

public class RateLimitingPolicy
extends AbstractMappedPolicy<RateLimitingConfig>
implements IPolicyProbe<RateLimitingConfig,RateLimitingProbeConfig>

Policy that enforces rate limits.

Author:

eric.wittmann@redhat.com

Field Summary

Fields inherited from interface io.apiman.gateway.engine.policy.IPolicyProbe

mapper

Constructor Summary

Constructors

Constructor	Description
RateLimitingPolicy()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	bucketId(ApiRequest request, RateLimitingConfig config)
protected String	bucketId(RateLimitingConfig config, BucketFactory.BucketIdBuilderContext context)
protected String	defaultLimitHeader()
protected String	defaultRemainingHeader()
protected String	defaultResetHeader()
protected void	doApply(ApiRequest request, IPolicyContext context, RateLimitingConfig config, IPolicyChain<ApiRequest> chain)	Override this method to interact with or observe the request.
protected void	doApply(ApiResponse response, IPolicyContext context, RateLimitingConfig config, IPolicyChain<ApiResponse> chain)	Apply the policy to the response.
Class<RateLimitingConfig>	getConfigurationClass()	The class to use for JSON configuration deserialization
Class<RateLimitingProbeConfig>	getProbeRequestClass()
protected PolicyFailure	limitExceededFailure(IPolicyFailureFactoryComponent failureFactory)	Generate a rate limit exceeded policy failure.
void	probe(RateLimitingProbeConfig probeRequest, RateLimitingConfig policyConfig, ProbeContext probeContext, IPolicyContext context, IAsyncResultHandler<IPolicyProbeResponse> resultHandler)
protected static Map<String,String>	responseHeaders(RateLimitingConfig config, RateLimitResponse rtr, String defaultLimitHeader, String defaultRemainingHeader, String defaultResetHeader)	Set response headers

Methods inherited from class io.apiman.gateway.engine.policies.AbstractMappedPolicy

apply, apply, doProcessFailure, parseConfiguration, processFailure

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.apiman.gateway.engine.policy.IPolicy

apply, apply, parseConfiguration, processFailure

Methods inherited from interface io.apiman.gateway.engine.policy.IPolicyProbe

probe

Constructor Detail

RateLimitingPolicy

public RateLimitingPolicy()

Constructor.

Method Detail

getConfigurationClass

public Class<RateLimitingConfig> getConfigurationClass()

Description copied from class: AbstractMappedPolicy

The class to use for JSON configuration deserialization

Specified by:

getConfigurationClass in interface IPolicyProbe<RateLimitingConfig,RateLimitingProbeConfig>

Specified by:

getConfigurationClass in class AbstractMappedPolicy<RateLimitingConfig>

Returns:

the class

doApply

protected void doApply(ApiRequest request,
                       IPolicyContext context,
                       RateLimitingConfig config,
                       IPolicyChain<ApiRequest> chain)

Description copied from class: AbstractMappedPolicy

Override this method to interact with or observe the request.

Overrides:

doApply in class AbstractMappedPolicy<RateLimitingConfig>

Parameters:

request - the request

chain - the ordered policy chain

See Also:

AbstractMappedPolicy.doApply(io.apiman.gateway.engine.beans.ApiRequest, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object, io.apiman.gateway.engine.policy.IPolicyChain)

doApply

protected void doApply(ApiResponse response,
                       IPolicyContext context,
                       RateLimitingConfig config,
                       IPolicyChain<ApiResponse> chain)

Description copied from class: AbstractMappedPolicy

Apply the policy to the response.

Override this method to interact with or observe the response.

Overrides:

doApply in class AbstractMappedPolicy<RateLimitingConfig>

Parameters:

response - the response

context - the policy context

config - the configuration (see AbstractMappedPolicy.getConfigurationClass())

chain - the ordered policy chain

See Also:

AbstractMappedPolicy.doApply(io.apiman.gateway.engine.beans.ApiResponse, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object, io.apiman.gateway.engine.policy.IPolicyChain)

responseHeaders

protected static Map<String,String> responseHeaders(RateLimitingConfig config,
                                                          RateLimitResponse rtr,
                                                          String defaultLimitHeader,
                                                          String defaultRemainingHeader,
                                                          String defaultResetHeader)

Set response headers

limitExceededFailure

protected PolicyFailure limitExceededFailure(IPolicyFailureFactoryComponent failureFactory)

Generate a rate limit exceeded policy failure.

Parameters:

failureFactory - failure factory

Returns:

a limit exceeded policy failure

defaultResetHeader

protected String defaultResetHeader()

Returns:

the default reset header

defaultRemainingHeader

protected String defaultRemainingHeader()

Returns:

the default remaining header

defaultLimitHeader

protected String defaultLimitHeader()

Returns:

the default limit header

bucketId

protected String bucketId(ApiRequest request,
                          RateLimitingConfig config)

bucketId

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

getProbeRequestClass

public Class<RateLimitingProbeConfig> getProbeRequestClass()

Specified by:

getProbeRequestClass in interface IPolicyProbe<RateLimitingConfig,RateLimitingProbeConfig>

probe

public void probe(RateLimitingProbeConfig probeRequest,
                  RateLimitingConfig policyConfig,
                  ProbeContext probeContext,
                  IPolicyContext context,
                  IAsyncResultHandler<IPolicyProbeResponse> resultHandler)

Specified by:

probe in interface IPolicyProbe<RateLimitingConfig,RateLimitingProbeConfig>