io.apiman.gateway.engine.policies

Class IPWhitelistPolicy

java.lang.Object

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

io.apiman.gateway.engine.policies.AbstractIPListPolicy<IPListConfig>

io.apiman.gateway.engine.policies.IPWhitelistPolicy

All Implemented Interfaces:

io.apiman.gateway.engine.policy.IPolicy

public class IPWhitelistPolicy
extends AbstractIPListPolicy<IPListConfig>

A simple policy that causes a failure if the IP address of the inbound request is not included in a specific list of allowed IP addresses.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
IPWhitelistPolicy() 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, IPListConfig config, io.apiman.gateway.engine.policy.IPolicyChain<io.apiman.gateway.engine.beans.ServiceRequest> chain)
protected Class<IPListConfig>	getConfigurationClass()

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

getRemoteAddr, isMatch

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

apply, apply, doApply, parseConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

IPWhitelistPolicy

public IPWhitelistPolicy()

Constructor.

Method Detail

getConfigurationClass

protected Class<IPListConfig> getConfigurationClass()

Specified by:

getConfigurationClass in class AbstractMappedPolicy<IPListConfig>

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

Overrides:

doApply in class AbstractMappedPolicy<IPListConfig>

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)