io.apiman.gateway.engine.policies

Class CachingPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.CachingPolicy

All Implemented Interfaces:

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

public class CachingPolicy
extends AbstractMappedPolicy<CachingConfig>
implements io.apiman.gateway.engine.policy.IDataPolicy

Policy that enables caching for back-end services responses.

Author:

rubenrm1@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHED_RESPONSE

Constructor Summary

Constructors

Constructor and Description
CachingPolicy() 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, CachingConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain) If the request is cached an IConnectorInterceptor is set in order to prevent the back-end connection to be established.
protected void	doApply(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, CachingConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Apply the policy to the response.
protected Class<CachingConfig>	getConfigurationClass()
io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest>	getRequestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context) The request will not be altered.
io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse>	getResponseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context) The response is received from the back-end service and needs to be written into the CachedResponse.

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

Field Detail

CACHED_RESPONSE

public static final String CACHED_RESPONSE

See Also:

Constant Field Values

Constructor Detail

CachingPolicy

public CachingPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<CachingConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<CachingConfig>

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

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 service

Overrides:

doApply in class AbstractMappedPolicy<CachingConfig>

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

See Also:

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

getRequestDataHandler

public io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceRequest> getRequestDataHandler(io.apiman.gateway.engine.beans.ServiceRequest request,
                                                                                                                io.apiman.gateway.engine.policy.IPolicyContext context)

The request will not be altered.

Specified by:

getRequestDataHandler in interface io.apiman.gateway.engine.policy.IDataPolicy

See Also:

IDataPolicy.getRequestDataHandler(ServiceRequest, IPolicyContext)

getResponseDataHandler

public io.apiman.gateway.engine.io.IReadWriteStream<io.apiman.gateway.engine.beans.ServiceResponse> getResponseDataHandler(io.apiman.gateway.engine.beans.ServiceResponse response,
                                                                                                                  io.apiman.gateway.engine.policy.IPolicyContext context)

The response is received from the back-end service and needs to be written into the CachedResponse. The headers, response code and message should be written at this point and once the CachedResponse is set, can be stored into the IDataStoreComponent

Specified by:

getResponseDataHandler in interface io.apiman.gateway.engine.policy.IDataPolicy

See Also:

IDataPolicy.getResponseDataHandler(ServiceResponse, IPolicyContext)