Module com.aoapps.servlet.firewall.api

Package com.aoapps.servlet.firewall.api

Interface Action

All Superinterfaces:

Rule

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Action
extends Rule

An action is a rule that has side-effects. It has access to the HttpServletResponse and FilterChain of the request.

It is possible for actions to have nested rules (including both matchers and/or actions). This might be most appropriate when an action wraps the request or response objects before performing additional rules, such as a "noSession" implementation might do.

TODO: actions should be in own submodule?

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Action.Result	The set of action results.

Method Summary

Modifier and Type	Method	Description
Action.Result	perform(FirewallContext context, HttpServletRequest request, HttpServletResponse response, FilterChain chain)	Performs the desired action.

Method Details

perform

Action.Result perform(FirewallContext context,
 HttpServletRequest request,
 HttpServletResponse response,
 FilterChain chain)
               throws IOException,
ServletException

Performs the desired action. This may have side-effects on the context, request, or response.

Parameters:

request - The request being matched

response - The current response

chain - The current filter chain

Returns:

Returns Action.Result.TERMINATE for a terminating action that has handled the request/response or Action.Result.CONTINUE for a non-terminating action. Matcher.Result.MATCH and Matcher.Result.NO_MATCH are not valid returns from an action.

Throws:

IOException

ServletException