Module com.aoapps.servlet.firewall.pathspace

Package com.aoapps.servlet.firewall.pathspace

Class FirewallPathSpace

java.lang.Object

com.aoapps.servlet.firewall.pathspace.FirewallPathSpace

public final class FirewallPathSpace
extends Object

Manages the allocation of the servlet path space to registered components, creating per-module sets of firewall rules.

TODO: Should this be "ao-servlet-firewall-components"?

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FirewallPathSpace.Initializer	Initializes the firewall PathSpace during application start-up.

Method Summary

Modifier and Type	Method	Description
FirewallPathSpace	add(FirewallComponent component)	Registers a new component.
FirewallPathSpace	add(FirewallComponent... components)	Registers any number of new components.
PathMatch<FirewallComponent>	get(Path path)	Finds the component registered at the given path.
static FirewallPathSpace	getInstance(ServletContext servletContext)	Gets the FirewallPathSpace for the given ServletContext, creating a new instance if not yet present.

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static FirewallPathSpace getInstance(ServletContext servletContext)

Gets the FirewallPathSpace for the given ServletContext, creating a new instance if not yet present.

add

public FirewallPathSpace add(FirewallComponent component)
                      throws PrefixConflictException

Registers a new component.

Throws:

PrefixConflictException - If the prefix conflicts with an existing entry. TODO: At this time this means the component could be partially registered when it has multiple paths.

See Also:

• PathSpace.put(com.aoapps.net.pathspace.Prefix, java.lang.Object)

add

public FirewallPathSpace add(FirewallComponent... components)
                      throws PrefixConflictException

Registers any number of new components.

Throws:

PrefixConflictException - If the prefix conflicts with an existing entry. TODO: At this time this means the components could be partially registered when it has multiple paths.

See Also:

• PathSpace.put(com.aoapps.net.pathspace.Prefix, java.lang.Object)

get

public PathMatch<FirewallComponent> get(Path path)

Finds the component registered at the given path.

See Also:

• PathSpace.get(com.aoapps.net.Path)