io.apiman.gateway.engine.policies

Class TransferQuotaPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.AbstractMappedDataPolicy<TransferQuotaConfig>

io.apiman.gateway.engine.policies.TransferQuotaPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IDataPolicy, io.apiman.gateway.engine.policy.IPolicy

public class TransferQuotaPolicy
extends AbstractMappedDataPolicy<TransferQuotaConfig>

Policy that enforces transfer quotas.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
TransferQuotaPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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, TransferQuotaConfig 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, TransferQuotaConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Apply the policy to the response.
protected void	doFinalApply(io.apiman.gateway.engine.policy.IPolicyContext context, TransferQuotaConfig config, long downloadedBytes) Called when everything is done (the last byte is written).
protected void	doQuotaExceededFailure(io.apiman.gateway.engine.policy.IPolicyContext context, TransferQuotaConfig config, io.apiman.gateway.engine.policy.IPolicyChain<?> chain, io.apiman.gateway.engine.components.rate.RateLimitResponse rtr) Called to send a 'quota exceeded' failure.
protected Class<TransferQuotaConfig>	getConfigurationClass()
protected io.apiman.gateway.engine.beans.PolicyFailure	limitExceededFailure(io.apiman.gateway.engine.components.IPolicyFailureFactoryComponent failureFactory)
protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest>	requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, TransferQuotaConfig config) Subclasses must implement this.
protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse>	responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, TransferQuotaConfig config) Subclasses must implement this.

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

getRequestDataHandler, getResponseDataHandler

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

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

apply, apply, parseConfiguration

Constructor Detail

TransferQuotaPolicy

public TransferQuotaPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<TransferQuotaConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<TransferQuotaConfig>

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,
           TransferQuotaConfig config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Overrides:

doApply in class AbstractMappedPolicy<TransferQuotaConfig>

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)

requestDataHandler

protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest> requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request,
                                                                                                             io.apiman.gateway.engine.policy.IPolicyContext context,
                                                                                                             TransferQuotaConfig config)

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

requestDataHandler in class AbstractMappedDataPolicy<TransferQuotaConfig>

See Also:

AbstractMappedDataPolicy.requestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object)

doApply

protected void doApply(io.apiman.gateway.engine.beans.ServiceResponse response,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           TransferQuotaConfig 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<TransferQuotaConfig>

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)

responseDataHandler

protected io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse> responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response,
                                                                                                               io.apiman.gateway.engine.policy.IPolicyContext context,
                                                                                                               TransferQuotaConfig config)

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

responseDataHandler in class AbstractMappedDataPolicy<TransferQuotaConfig>

See Also:

AbstractMappedDataPolicy.responseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse, io.apiman.gateway.engine.policy.IPolicyContext, java.lang.Object)

doFinalApply

protected void doFinalApply(io.apiman.gateway.engine.policy.IPolicyContext context,
                TransferQuotaConfig config,
                long downloadedBytes)

Called when everything is done (the last byte is written). This is used to record the # of bytes downloaded.

Parameters:

context -

config -

downloadedBytes -

doQuotaExceededFailure

protected void doQuotaExceededFailure(io.apiman.gateway.engine.policy.IPolicyContext context,
                          TransferQuotaConfig config,
                          io.apiman.gateway.engine.policy.IPolicyChain<?> chain,
                          io.apiman.gateway.engine.components.rate.RateLimitResponse rtr)

Called to send a 'quota exceeded' failure.

Parameters:

context -

config -

chain -

rtr -

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