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:

io.apiman.gateway.engine.policy.IPolicy

Direct Known Subclasses:

AbstractIPListPolicy, AuthorizationPolicy, BasicAuthenticationPolicy, IgnoredResourcesPolicy, RateLimitingPolicy

public abstract class AbstractMappedPolicy<C>
extends Object
implements io.apiman.gateway.engine.policy.IPolicy

A base class for policy impls that use jackson to parse configuration info.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
AbstractMappedPolicy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, Object config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)
void	apply(io.apiman.gateway.engine.beans.ServiceResponse response, io.apiman.gateway.engine.policy.IPolicyContext context, Object config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)
protected void	doApply(io.apiman.gateway.engine.beans.ServiceRequest request, io.apiman.gateway.engine.policy.IPolicyContext context, C 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, C config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain) Apply the policy to the response.
protected abstract Class<C>	getConfigurationClass()
C	parseConfiguration(String jsonConfiguration)

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 io.apiman.gateway.engine.beans.exceptions.ConfigurationParseException

Specified by:

parseConfiguration in interface io.apiman.gateway.engine.policy.IPolicy

Throws:

io.apiman.gateway.engine.beans.exceptions.ConfigurationParseException

See Also:

IPolicy.parseConfiguration(java.lang.String)

getConfigurationClass

protected abstract Class<C> getConfigurationClass()

Returns:

the class to use for JSON configuration deserialization

apply

public final void apply(io.apiman.gateway.engine.beans.ServiceRequest request,
         io.apiman.gateway.engine.policy.IPolicyContext context,
         Object config,
         io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Specified by:

apply in interface io.apiman.gateway.engine.policy.IPolicy

See Also:

IPolicy.apply(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.ServiceRequest request,
           io.apiman.gateway.engine.policy.IPolicyContext context,
           C config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)

Parameters:

request -

chain -

apply

public final void apply(io.apiman.gateway.engine.beans.ServiceResponse response,
         io.apiman.gateway.engine.policy.IPolicyContext context,
         Object config,
         io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)

Specified by:

apply in interface io.apiman.gateway.engine.policy.IPolicy

See Also:

IPolicy.apply(io.apiman.gateway.engine.beans.ServiceResponse, 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,
           C config,
           io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceResponse> chain)

Apply the policy to the response.

Parameters:

response -

context -

config -

chain -