Package 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:

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	Description
IPWhitelistPolicy()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doApply(ApiRequest request, IPolicyContext context, IPListConfig config, IPolicyChain<ApiRequest> chain)	Override this method to interact with or observe the request.
Class<IPListConfig>	getConfigurationClass()	The class to use for JSON configuration deserialization

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, doProcessFailure, parseConfiguration, processFailure

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

public Class<IPListConfig> getConfigurationClass()

Description copied from class: AbstractMappedPolicy

The class to use for JSON configuration deserialization

Specified by:

getConfigurationClass in class AbstractMappedPolicy<IPListConfig>

Returns:

the class

doApply

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

Description copied from class: AbstractMappedPolicy

Override this method to interact with or observe the request.

Overrides:

doApply in class AbstractMappedPolicy<IPListConfig>

Parameters:

request - the request

chain - the ordered policy chain

See Also:

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