fr.cnes.doi.security

Class AllowerIP

java.lang.Object

org.restlet.Restlet

org.restlet.routing.Filter

fr.cnes.doi.security.AllowerIP

All Implemented Interfaces:

org.restlet.Uniform

public class AllowerIP
extends org.restlet.routing.Filter

IP filtering. When the service is disabled, no filtering is applied. When the service is enabled, the service allows IPs such as 127.0.0.1 and IPs coming from addCustomIP(java.util.Set) Allowed IPs are set based on a parameter from the configuration file Consts.ADMIN_IP_ALLOWER

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	allowedAddresses List of allowed IPs addresses.
private boolean	enabled Service enabled/disabled.
static String	LOCALHOST_IPV4 Localhost in IPv4.
static String	LOCALHOST_IPV6 Localhost in IPv6.
private static org.apache.logging.log4j.Logger	LOG Logger.

Fields inherited from class org.restlet.routing.Filter

CONTINUE, SKIP, STOP

Constructor Summary

Constructors

Constructor and Description
AllowerIP(org.restlet.Context context, boolean isEnabledIP) Constructor based on the context and a parameter to make enabled/disabled the service

Method Summary

Modifier and Type	Method and Description
private void	addCustomIP(Set<String> allowedAddresses) Adds custom IPs based on the settings.
protected int	beforeHandle(org.restlet.Request request, org.restlet.Response response) Before Handler.
Set<String>	getAllowedAddresses() Returns the allowed addresses.
boolean	isEnabled() Returns True when the service is enabled otherwise False.

Methods inherited from class org.restlet.routing.Filter

afterHandle, doHandle, getNext, handle, hasNext, setNext, setNext, start, stop

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.logging.log4j.Logger LOG

Logger.

LOCALHOST_IPV6

public static final String LOCALHOST_IPV6

Localhost in IPv6.

See Also:

Constant Field Values

LOCALHOST_IPV4

public static final String LOCALHOST_IPV4

Localhost in IPv4.

See Also:

Constant Field Values

allowedAddresses

private final Set<String> allowedAddresses

List of allowed IPs addresses.

enabled

private final boolean enabled

Service enabled/disabled.

Constructor Detail

AllowerIP

public AllowerIP(org.restlet.Context context,
                 boolean isEnabledIP)

Constructor based on the context and a parameter to make enabled/disabled the service

Parameters:

context - context

isEnabledIP - True when the service is enabled otherwise False

Method Detail

addCustomIP

private void addCustomIP(Set<String> allowedAddresses)

Adds custom IPs based on the settings.

Parameters:

allowedAddresses - the new allowed addresses

beforeHandle

protected int beforeHandle(org.restlet.Request request,
                           org.restlet.Response response)

Before Handler.

Overrides:

beforeHandle in class org.restlet.routing.Filter

Parameters:

request - request

response - response

Returns:

beforeHandler

getAllowedAddresses

public Set<String> getAllowedAddresses()

Returns the allowed addresses.

Returns:

the allowed addresses

isEnabled

public boolean isEnabled()

Returns True when the service is enabled otherwise False.

Returns:

True when the service is enabled otherwise False