io.apiman.gateway.engine.policies

Class QuotaPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.RateLimitingPolicy

io.apiman.gateway.engine.policies.QuotaPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IPolicy

public class QuotaPolicy
extends RateLimitingPolicy

Similar to the rate limiting policy, but less granular. Useful primarily so that both a quota and a rate limit can be active at the same time.

Author:

eric.wittmann@redhat.com

Field Summary

Fields inherited from class io.apiman.gateway.engine.policies.RateLimitingPolicy

NO_APPLICATION_AVAILABLE, NO_USER_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
QuotaPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createBucketId(io.apiman.gateway.engine.beans.ServiceRequest request, RateLimitingConfig config)
protected String	defaultLimitHeader()
protected String	defaultRemainingHeader()
protected String	defaultResetHeader()
protected io.apiman.gateway.engine.beans.PolicyFailure	limitExceededFailure(io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent failureFactory)

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

bucketId, doApply, doApply, getConfigurationClass, getPeriod, responseHeaders

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

QuotaPolicy

public QuotaPolicy()

Constructor.

Method Detail

limitExceededFailure

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

Overrides:

limitExceededFailure in class RateLimitingPolicy

See Also:

RateLimitingPolicy.limitExceededFailure(io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent)

defaultLimitHeader

protected String defaultLimitHeader()

Overrides:

defaultLimitHeader in class RateLimitingPolicy

Returns:

the default limit header

See Also:

RateLimitingPolicy.defaultLimitHeader()

defaultRemainingHeader

protected String defaultRemainingHeader()

Overrides:

defaultRemainingHeader in class RateLimitingPolicy

Returns:

the default remaining header

See Also:

RateLimitingPolicy.defaultRemainingHeader()

defaultResetHeader

protected String defaultResetHeader()

Overrides:

defaultResetHeader in class RateLimitingPolicy

Returns:

the default reset header

See Also:

RateLimitingPolicy.defaultResetHeader()

createBucketId

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

Overrides:

createBucketId in class RateLimitingPolicy

See Also:

RateLimitingPolicy.createBucketId(io.apiman.gateway.engine.beans.ServiceRequest, io.apiman.gateway.engine.policies.config.RateLimitingConfig)