Package io.apiman.gateway.engine.policies

Class CachingPolicy

java.lang.Object

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

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

io.apiman.gateway.engine.policies.CachingPolicy

All Implemented Interfaces:

IDataPolicy, IPolicy

@Deprecated
public class CachingPolicy
extends AbstractMappedDataPolicy<CachingConfig>
implements IDataPolicy

Deprecated.

use CachingResourcesPolicy instead.

Policy that enables caching for back-end APIs responses.

Author:

rubenrm1@gmail.com

Constructor Summary

Constructors

Constructor	Description
CachingPolicy()	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	doApply(ApiRequest request, IPolicyContext context, CachingConfig config, IPolicyChain<ApiRequest> chain)	Deprecated.
protected void	doApply(ApiResponse response, IPolicyContext context, CachingConfig config, IPolicyChain<ApiResponse> chain)	Deprecated.
Class<CachingConfig>	getConfigurationClass()	Deprecated.
protected IReadWriteStream<ApiRequest>	requestDataHandler(ApiRequest request, IPolicyContext context, CachingConfig policyConfiguration)	Deprecated.
protected IReadWriteStream<ApiResponse>	responseDataHandler(ApiResponse response, IPolicyContext context, CachingConfig policyConfiguration)	Deprecated.

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

getRequestDataHandler, getResponseDataHandler

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.IDataPolicy

getRequestDataHandler, getResponseDataHandler

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

apply, apply, parseConfiguration, processFailure

Constructor Detail

CachingPolicy

@Deprecated
public CachingPolicy()

Deprecated.

Constructor.

Method Detail

getConfigurationClass

@Deprecated
public Class<CachingConfig> getConfigurationClass()

Deprecated.

Description copied from class: AbstractMappedPolicy

The class to use for JSON configuration deserialization

Specified by:

getConfigurationClass in class AbstractMappedPolicy<CachingConfig>

Returns:

the class

See Also:

AbstractMappedPolicy.getConfigurationClass()

doApply

@Deprecated
protected void doApply(ApiRequest request,
                       IPolicyContext context,
                       CachingConfig config,
                       IPolicyChain<ApiRequest> chain)

Deprecated.

If the request is cached an IConnectorInterceptor is set in order to prevent the back-end connection to be established. Otherwise an empty CachedResponse will be added to the context, this will be used to cache the response once it has been received from the back-end API

Overrides:

doApply in class AbstractMappedPolicy<CachingConfig>

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

@Deprecated
protected void doApply(ApiResponse response,
                       IPolicyContext context,
                       CachingConfig config,
                       IPolicyChain<ApiResponse> chain)

Deprecated.

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<CachingConfig>

Parameters:

response - the response

context - the policy context

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

chain - the ordered policy chain

See Also:

AbstractMappedPolicy.doApply(ApiResponse, IPolicyContext, Object, IPolicyChain)

requestDataHandler

@Deprecated
protected IReadWriteStream<ApiRequest> requestDataHandler(ApiRequest request,
                                                          IPolicyContext context,
                                                          CachingConfig policyConfiguration)

Deprecated.

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

requestDataHandler in class AbstractMappedDataPolicy<CachingConfig>

See Also:

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

responseDataHandler

@Deprecated
protected IReadWriteStream<ApiResponse> responseDataHandler(ApiResponse response,
                                                            IPolicyContext context,
                                                            CachingConfig policyConfiguration)

Deprecated.

Description copied from class: AbstractMappedDataPolicy

Subclasses must implement this.

Specified by:

responseDataHandler in class AbstractMappedDataPolicy<CachingConfig>

See Also:

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