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:

io.apiman.gateway.engine.policy.IPolicy

Direct Known Subclasses:

QuotaPolicy

public class RateLimitingPolicy
extends AbstractMappedPolicy<RateLimitingConfig>

Policy that enforces rate limits.

Author:

eric.wittmann@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NO_APPLICATION_AVAILABLE
protected static String	NO_USER_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
RateLimitingPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	bucketId(io.apiman.gateway.engine.beans.ServiceRequest request, RateLimitingConfig config) Creates the ID of the rate bucket to use.
protected String	createBucketId(io.apiman.gateway.engine.beans.ServiceRequest request, RateLimitingConfig config)
protected String	defaultLimitHeader()
protected String	defaultRemainingHeader()
protected String	defaultResetHeader()
protected void	doApply(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, RateLimitingConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)
protected void	doApply(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, RateLimitingConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Apply the policy to the response.
protected Class<RateLimitingConfig>	getConfigurationClass()
protected static io.apiman.gateway.engine.rates.RateBucketPeriod	getPeriod(RateLimitingConfig config) Gets the appropriate bucket period from the config.
protected io.apiman.gateway.engine.beans.PolicyFailure	limitExceededFailure(io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent failureFactory)
protected static Map<String,String>	responseHeaders(RateLimitingConfig config, io.apiman.gateway.engine.components.rate.RateLimitResponse rtr, String defaultLimitHeader, String defaultRemainingHeader, String defaultResetHeader)

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

apply, apply, parseConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

NO_USER_AVAILABLE

protected static final String NO_USER_AVAILABLE

NO_APPLICATION_AVAILABLE

protected static final String NO_APPLICATION_AVAILABLE

Constructor Detail

RateLimitingPolicy

public RateLimitingPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<RateLimitingConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<RateLimitingConfig>

Returns:

the class to use for JSON configuration deserialization

See Also:

io.apiman.gateway.engine.policy.AbstractPolicy#getConfigurationClass()

doApply

protected void doApply(io.apiman.gateway.engine.beans.ServiceRequest request,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           RateLimitingConfig config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Overrides:

doApply in class AbstractMappedPolicy<RateLimitingConfig>

See Also:

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

createBucketId

protected String createBucketId(io.apiman.gateway.engine.beans.ServiceRequest request,
                    RateLimitingConfig config)

Parameters:

request -

config -

doApply

protected void doApply(io.apiman.gateway.engine.beans.ServiceResponse response,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           RateLimitingConfig config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)

Description copied from class: AbstractMappedPolicy

Apply the policy to the response.

Overrides:

doApply in class AbstractMappedPolicy<RateLimitingConfig>

See Also:

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

bucketId

protected static String bucketId(io.apiman.gateway.engine.beans.ServiceRequest request,
              RateLimitingConfig config)

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

Parameters:

request -

config -

getPeriod

protected static io.apiman.gateway.engine.rates.RateBucketPeriod getPeriod(RateLimitingConfig config)

Gets the appropriate bucket period from the config.

Parameters:

config -

responseHeaders

protected static Map<String,String> responseHeaders(RateLimitingConfig config,
                                 io.apiman.gateway.engine.components.rate.RateLimitResponse rtr,
                                 String defaultLimitHeader,
                                 String defaultRemainingHeader,
                                 String defaultResetHeader)

Parameters:

config -

rtr -

defaultLimitHeader -

defaultRemainingHeader -

defaultResetHeader -

limitExceededFailure

protected io.apiman.gateway.engine.beans.PolicyFailure limitExceededFailure(io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent failureFactory)

Parameters:

responseHeaders -

failureFactory -

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