org.restlet.ext.apispark

Class FirewallConfig

java.lang.Object

org.restlet.ext.apispark.FirewallConfig

public class FirewallConfig
extends Object

Configuration methods for the Firewall.

Author:

Guillaume Blondeau

Constructor Summary

Constructors

Constructor and Description
FirewallConfig(List<?> rules) Private Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHostDomainConcurrencyCounter(int limit) Adds a rule that limits the number of concurrent requests by request's host domain.
void	addHostDomainPeriodicCounter(int period, TimeUnit periodUnit, int limit) Adds a rule that limits the number of requests for a given period of time by request's host domain.
void	addIpAddressesBlackList(List<String> blackList) Adds a rule that forbids access to the given set of IP addresses.
void	addIpAddressesConcurrencyCounter(int limit) Adds a rule that restricts access according to the IP address of the request's client.
void	addIpAddressesPeriodicCounter(int period, TimeUnit periodUnit, int limit) Adds a rule that restricts access by period of time according to the IP address of the request's client.
void	addIpAddressesWhiteList(List<String> whiteList) Adds a rule that restricts access to the given set of IP addresses.
void	addRolesConcurrencyCounter(Map<String,Integer> limitsPerRole) Adds a rule that restricts access according to the Role of the current authenticated User.
void	addRolesConcurrencyCounter(Map<String,Integer> limitsPerRole, int defaultLimit) Adds a rule that restricts access according to the Role of the current authenticated User.
void	addRolesPeriodicCounter(int period, TimeUnit periodUnit, Map<String,Integer> limitsPerRole) Adds a rule that restricts access according to the Role of the current authenticated User.
void	addRolesPeriodicCounter(int period, TimeUnit periodUnit, Map<String,Integer> limitsPerRole, int defaultLimit) Adds a rule that restricts access according to the Role of the current authenticated User.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirewallConfig

public FirewallConfig(List<?> rules)

Private Constructor.

Method Detail

addHostDomainConcurrencyCounter

public void addHostDomainConcurrencyCounter(int limit)

Adds a rule that limits the number of concurrent requests by request's host domain.

Parameters:

limit - The maximum number of requests allowed by host domain at the same time.

addHostDomainPeriodicCounter

public void addHostDomainPeriodicCounter(int period,
                                TimeUnit periodUnit,
                                int limit)

Adds a rule that limits the number of requests for a given period of time by request's host domain.

Parameters:

period - The period of time.

periodUnit - Period time unit associated to the rule.

limit - The maximum number of requests allowed by host domain for the given period of time.

addIpAddressesBlackList

public void addIpAddressesBlackList(List<String> blackList)

Adds a rule that forbids access to the given set of IP addresses.

Parameters:

blackList - The list of rejected IP addresses.

addIpAddressesConcurrencyCounter

public void addIpAddressesConcurrencyCounter(int limit)

Adds a rule that restricts access according to the IP address of the request's client. A unique limit is applied for all IP addresses.

Parameters:

limit - The maximum number of accepted concurrent requests.

addIpAddressesPeriodicCounter

public void addIpAddressesPeriodicCounter(int period,
                                 TimeUnit periodUnit,
                                 int limit)

Adds a rule that restricts access by period of time according to the IP address of the request's client. A unique limit is applied for all IP addresses.

Parameters:

period - The period of time.

periodUnit - Period time unit associated to the rule.

limit - The maximum number of accepted requests for a period of time.

addIpAddressesWhiteList

public void addIpAddressesWhiteList(List<String> whiteList)

Adds a rule that restricts access to the given set of IP addresses.

Parameters:

whiteList - The list of accepted IP addresses.

addRolesConcurrencyCounter

public void addRolesConcurrencyCounter(Map<String,Integer> limitsPerRole)

Adds a rule that restricts access according to the Role of the current authenticated User. Each role is defined a limit in terms of concurrent requests, in any other case the access is forbidden.

Parameters:

limitsPerRole - The limit assigned per role's name.

addRolesConcurrencyCounter

public void addRolesConcurrencyCounter(Map<String,Integer> limitsPerRole,
                              int defaultLimit)

Adds a rule that restricts access according to the Role of the current authenticated User. Each role is defined a limit in terms of concurrent requests, in any other case a default limit is applied.

Parameters:

limitsPerRole - The limit assigned per role's name.

defaultLimit - The limit assigned for any other roles, or for user without assigned role.

addRolesPeriodicCounter

public void addRolesPeriodicCounter(int period,
                           TimeUnit periodUnit,
                           Map<String,Integer> limitsPerRole)

Adds a rule that restricts access according to the Role of the current authenticated User. Each role is defined a limit in terms of requests by period of time, in any other case the access is forbidden.

Parameters:

period - The period of time.

periodUnit - Period time unit associated to the rule.

limitsPerRole - The limit assigned per role's name.

addRolesPeriodicCounter

public void addRolesPeriodicCounter(int period,
                           TimeUnit periodUnit,
                           Map<String,Integer> limitsPerRole,
                           int defaultLimit)

Adds a rule that restricts access according to the Role of the current authenticated User. Each role is defined a limit in terms of concurrent requests, in any other case a default limit is applied.

Parameters:

period - The period of time.

periodUnit - Period time unit associated to the rule.

limitsPerRole - The limit assigned per role's name.

defaultLimit - The limit assigned for any other roles, or for user without assigned role.