Module com.aoapps.servlet.firewall.api

Package com.aoapps.servlet.firewall.api

Interface FirewallContext

public interface FirewallContext

Invocation of rules must be done through the firewall context. This is done to support firewall hooks, such as TRACE.

As firewall rule traversal is performed on a single thread on a per-request basis, implementations are not necessarily thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FirewallContext.Callable<V>	TODO: Replace with ServletCallable from ao-servlet-util.
static interface	FirewallContext.Runnable	TODO: Replace with ServletRunnable from ao-servlet-util.

Method Summary

Modifier and Type	Method	Description
Action.Result	call(Action action)	Calls the given action.
Matcher.Result	call(Matcher matcher)	Calls the given matcher.
Object	getAttribute(String name)	Gets the firewall context attribute of the given name.
void	removeAttribute(String name)	Removes a firewall context attribute.
void	setAttribute(String name, Object object)	Sets a firewall context attribute.
<V> V	setAttribute(String name, Object object, FirewallContext.Callable<V> callable)	Sets a firewall context attribute, calling the provided FirewallContext.Callable, then restoring any previous value for the attribute.
void	setAttribute(String name, Object object, FirewallContext.Runnable runnable)	Sets a firewall context attribute, calling the provided FirewallContext.Runnable, then restoring any previous value for the attribute.

Method Details

setAttribute

void setAttribute(String name,
 Object object)

Sets a firewall context attribute.

Parameters:

name - The name of the attribute.

object - When null, this is the equivalent of calling removeAttribute(java.lang.String)

getAttribute

Object getAttribute(String name)

Gets the firewall context attribute of the given name.

Parameters:

name - The name of the attribute.

Returns:

The object at the given name or null if non set.

removeAttribute

void removeAttribute(String name)

Removes a firewall context attribute. This is the same as calling setAttribute(java.lang.String, java.lang.Object) with a null object.

Parameters:

name - The name of the attribute.

setAttribute

<V> V setAttribute(String name,
 Object object,
 FirewallContext.Callable<V> callable)
            throws IOException,
ServletException

Sets a firewall context attribute, calling the provided FirewallContext.Callable, then restoring any previous value for the attribute.

Parameters:

name - The name of the attribute.

object - When null, this is the equivalent of calling removeAttribute(java.lang.String)

Throws:

IOException

ServletException

setAttribute

void setAttribute(String name,
 Object object,
 FirewallContext.Runnable runnable)
           throws IOException,
ServletException

Sets a firewall context attribute, calling the provided FirewallContext.Runnable, then restoring any previous value for the attribute.

Parameters:

name - The name of the attribute.

object - When null, this is the equivalent of calling removeAttribute(java.lang.String)

Throws:

IOException

ServletException

call

Matcher.Result call(Matcher matcher)
             throws IOException,
ServletException

Calls the given matcher.

Throws:

IOException

ServletException

call

Action.Result call(Action action)
            throws IOException,
ServletException

Calls the given action.

Throws:

IOException

ServletException