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

public class RateLimitingPolicy
extends AbstractMappedPolicy<RateLimitingConfig>

Policy that enforces rate limits.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
RateLimitingPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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()

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

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)

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)