Package io.apiman.gateway.engine.policies

Class AbstractMappedPolicy<C>

java.lang.Object

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

Type Parameters:

C - the config type

All Implemented Interfaces:

IPolicy

Direct Known Subclasses:

AbstractIPListPolicy, AbstractMappedDataPolicy, AuthorizationPolicy, BasicAuthenticationPolicy, IgnoredResourcesPolicy, RateLimitingPolicy, TimeRestrictedAccessPolicy

public abstract class AbstractMappedPolicy<C>
extends Object
implements IPolicy

A base class for policy impls that uses Jackson to parse configuration info.

Author:

eric.wittmann@redhat.com, marc@blackparrotlabs.io

Constructor Summary

Constructors

Constructor	Description
AbstractMappedPolicy()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	apply(ApiRequest request, IPolicyContext context, Object config, IPolicyChain<ApiRequest> chain)
void	apply(ApiResponse response, IPolicyContext context, Object config, IPolicyChain<ApiResponse> chain)
protected void	doApply(ApiRequest request, IPolicyContext context, C config, IPolicyChain<ApiRequest> chain)	Override this method to interact with or observe the request.
protected void	doApply(ApiResponse response, IPolicyContext context, C config, IPolicyChain<ApiResponse> chain)	Apply the policy to the response.
protected void	doProcessFailure(PolicyFailure failure, IPolicyContext context, C config, IPolicyFailureChain chain)	Override if you wish to modify a failure.
abstract Class<C>	getConfigurationClass()	The class to use for JSON configuration deserialization
C	parseConfiguration(String jsonConfiguration)
void	processFailure(PolicyFailure failure, IPolicyContext context, Object config, IPolicyFailureChain chain)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMappedPolicy

public AbstractMappedPolicy()

Constructor.

Method Detail

parseConfiguration

public C parseConfiguration(String jsonConfiguration)
                     throws ConfigurationParseException

Using Jackson, the configuration is read into the class specified structure by getConfigurationClass().

Most implementors should not override this method unless they do not want to use Jackson (e.g. using a non-JSON format).

Specified by:

parseConfiguration in interface IPolicy

Throws:

ConfigurationParseException

getConfigurationClass

public abstract Class<C> getConfigurationClass()

The class to use for JSON configuration deserialization

Returns:

the class

apply

public final void apply(ApiRequest request,
                        IPolicyContext context,
                        Object config,
                        IPolicyChain<ApiRequest> chain)

Specified by:

apply in interface IPolicy

doApply

protected void doApply(ApiRequest request,
                       IPolicyContext context,
                       C config,
                       IPolicyChain<ApiRequest> chain)

Override this method to interact with or observe the request.

Parameters:

request - the request

chain - the ordered policy chain

See Also:

apply(ApiResponse, IPolicyContext, Object, IPolicyChain)

apply

public final void apply(ApiResponse response,
                        IPolicyContext context,
                        Object config,
                        IPolicyChain<ApiResponse> chain)

Specified by:

apply in interface IPolicy

doApply

protected void doApply(ApiResponse response,
                       IPolicyContext context,
                       C config,
                       IPolicyChain<ApiResponse> chain)

Apply the policy to the response.

Override this method to interact with or observe the response.

Parameters:

response - the response

context - the policy context

config - the configuration (see getConfigurationClass())

chain - the ordered policy chain

processFailure

public void processFailure(PolicyFailure failure,
                           IPolicyContext context,
                           Object config,
                           IPolicyFailureChain chain)

Specified by:

processFailure in interface IPolicy

doProcessFailure

protected void doProcessFailure(PolicyFailure failure,
                                IPolicyContext context,
                                C config,
                                IPolicyFailureChain chain)

Override if you wish to modify a failure.

See Also:

IPolicy.processFailure(PolicyFailure, IPolicyContext, Object, IPolicyFailureChain)