Module com.aoapps.servlet.firewall.rules

Package com.aoapps.servlet.firewall.rules

Class Rules.request.method

java.lang.Object

com.aoapps.servlet.firewall.rules.Rules.request.method

Enclosing class:

Rules.request

public static final class Rules.request.method
extends Object

See HttpServletRequest.getMethod().

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELETE	Constants for directly supported request methods.
static final String	GET	Constants for directly supported request methods.
static final String	HEAD	Constants for directly supported request methods.
static final Matcher	isDELETE	Matches DELETE.
static final Matcher	isGET	Matches GET.
static final Matcher	isHEAD	Matches HEAD.
static final Matcher	isOPTIONS	Matches OPTIONS.
static final Matcher	isPOST	Matches POST.
static final Matcher	isPUT	Matches PUT.
static final Matcher	isTRACE	Matches TRACE.
static final String	OPTIONS	Constants for directly supported request methods.
static final String	POST	Constants for directly supported request methods.
static final String	PUT	Constants for directly supported request methods.
static final String	TRACE	Constants for directly supported request methods.

Method Summary

Modifier and Type	Method	Description
static Action	constrain(String... methods)	See constrain(java.util.Collection).
static Action	constrain(Collection<String> methods)	Constrains a request to the given set of methods.
static Matcher	in(Iterable<String> methods)	Matches any of a given iterable of HttpServletRequest.getMethod().
static Matcher	in(Iterable<String> methods, Rule... rules)	Matches any of a given iterable of HttpServletRequest.getMethod().
static Matcher	in(Iterable<String> methods, Rule[] rules, Rule... otherwise)	Matches any of a given iterable of HttpServletRequest.getMethod().
static Matcher	in(Iterable<String> methods, Iterable<? extends Rule> rules)	Matches any of a given iterable of HttpServletRequest.getMethod().
static Matcher	in(Iterable<String> methods, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches any of a given iterable of HttpServletRequest.getMethod().
static Matcher	in(String... methods)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(String[] methods, Rule... rules)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(String[] methods, Rule[] rules, Rule... otherwise)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(String[] methods, Iterable<? extends Rule> rules)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(String[] methods, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(Collection<String> methods)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(Collection<String> methods, Rule... rules)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(Collection<String> methods, Rule[] rules, Rule... otherwise)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(Collection<String> methods, Iterable<? extends Rule> rules)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	in(Collection<String> methods, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches any of a given set of HttpServletRequest.getMethod().
static Matcher	is(String method)	Matches one given HttpServletRequest.getMethod().
static Matcher	is(String method, Rule... rules)	Matches one given HttpServletRequest.getMethod().
static Matcher	is(String method, Rule[] rules, Rule... otherwise)	Matches one given HttpServletRequest.getMethod().
static Matcher	is(String method, Iterable<? extends Rule> rules)	Matches one given HttpServletRequest.getMethod().
static Matcher	is(String method, Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches one given HttpServletRequest.getMethod().
static Matcher	isDELETE(Rule... rules)	Matches DELETE.
static Matcher	isDELETE(Rule[] rules, Rule... otherwise)	Matches DELETE.
static Matcher	isDELETE(Iterable<? extends Rule> rules)	Matches DELETE.
static Matcher	isDELETE(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches DELETE.
static Matcher	isGET(Rule... rules)	Matches GET.
static Matcher	isGET(Rule[] rules, Rule... otherwise)	Matches GET.
static Matcher	isGET(Iterable<? extends Rule> rules)	Matches GET.
static Matcher	isGET(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches GET.
static Matcher	isHEAD(Rule... rules)	Matches HEAD.
static Matcher	isHEAD(Rule[] rules, Rule... otherwise)	Matches HEAD.
static Matcher	isHEAD(Iterable<? extends Rule> rules)	Matches HEAD.
static Matcher	isHEAD(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches HEAD.
static Matcher	isOPTIONS(Rule... rules)	Matches OPTIONS.
static Matcher	isOPTIONS(Rule[] rules, Rule... otherwise)	Matches OPTIONS.
static Matcher	isOPTIONS(Iterable<? extends Rule> rules)	Matches OPTIONS.
static Matcher	isOPTIONS(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches OPTIONS.
static Matcher	isPOST(Rule... rules)	Matches POST.
static Matcher	isPOST(Rule[] rules, Rule... otherwise)	Matches POST.
static Matcher	isPOST(Iterable<? extends Rule> rules)	Matches POST.
static Matcher	isPOST(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches POST.
static Matcher	isPUT(Rule... rules)	Matches PUT.
static Matcher	isPUT(Rule[] rules, Rule... otherwise)	Matches PUT.
static Matcher	isPUT(Iterable<? extends Rule> rules)	Matches PUT.
static Matcher	isPUT(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches PUT.
static Matcher	isTRACE(Rule... rules)	Matches TRACE.
static Matcher	isTRACE(Rule[] rules, Rule... otherwise)	Matches TRACE.
static Matcher	isTRACE(Iterable<? extends Rule> rules)	Matches TRACE.
static Matcher	isTRACE(Iterable<? extends Rule> rules, Iterable<? extends Rule> otherwise)	Matches TRACE.

Methods inherited from class java.lang.Object

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

Field Details

DELETE

public static final String DELETE

Constants for directly supported request methods.

See Also:

• Constant Field Values

HEAD

public static final String HEAD

Constants for directly supported request methods.

See Also:

• Constant Field Values

GET

public static final String GET

Constants for directly supported request methods.

See Also:

• Constant Field Values

OPTIONS

public static final String OPTIONS

Constants for directly supported request methods.

See Also:

• Constant Field Values

POST

public static final String POST

Constants for directly supported request methods.

See Also:

• Constant Field Values

PUT

public static final String PUT

Constants for directly supported request methods.

See Also:

• Constant Field Values

TRACE

public static final String TRACE

Constants for directly supported request methods.

See Also:

• Constant Field Values

isDELETE

public static final Matcher isDELETE

Matches DELETE.

isHEAD

public static final Matcher isHEAD

Matches HEAD.

isGET

public static final Matcher isGET

Matches GET.

isOPTIONS

public static final Matcher isOPTIONS

Matches OPTIONS.

isPOST

public static final Matcher isPOST

Matches POST.

isPUT

public static final Matcher isPUT

Matches PUT.

isTRACE

public static final Matcher isTRACE

Matches TRACE.

Method Details

is

public static Matcher is(String method)

Matches one given HttpServletRequest.getMethod().

is

public static Matcher is(String method,
 Iterable<? extends Rule> rules)

Matches one given HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

is

public static Matcher is(String method,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches one given HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

is

public static Matcher is(String method,
 Rule... rules)

Matches one given HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

is

public static Matcher is(String method,
 Rule[] rules,
 Rule... otherwise)

Matches one given HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(Iterable<String> methods)

Matches any of a given iterable of HttpServletRequest.getMethod().

in

public static Matcher in(Collection<String> methods)

Matches any of a given set of HttpServletRequest.getMethod().

in

public static Matcher in(String... methods)

Matches any of a given set of HttpServletRequest.getMethod().

in

public static Matcher in(Iterable<String> methods,
 Iterable<? extends Rule> rules)

Matches any of a given iterable of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(Iterable<String> methods,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches any of a given iterable of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(Collection<String> methods,
 Iterable<? extends Rule> rules)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(Collection<String> methods,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(String[] methods,
 Iterable<? extends Rule> rules)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(String[] methods,
 Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(Iterable<String> methods,
 Rule... rules)

Matches any of a given iterable of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(Iterable<String> methods,
 Rule[] rules,
 Rule... otherwise)

Matches any of a given iterable of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(Collection<String> methods,
 Rule... rules)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(Collection<String> methods,
 Rule[] rules,
 Rule... otherwise)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

in

public static Matcher in(String[] methods,
 Rule... rules)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

in

public static Matcher in(String[] methods,
 Rule[] rules,
 Rule... otherwise)

Matches any of a given set of HttpServletRequest.getMethod().

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isDELETE

public static Matcher isDELETE(Iterable<? extends Rule> rules)

Matches DELETE.

Parameters:

rules - Invoked only when matched.

isDELETE

public static Matcher isDELETE(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches DELETE.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isDELETE

public static Matcher isDELETE(Rule... rules)

Matches DELETE.

Parameters:

rules - Invoked only when matched.

isDELETE

public static Matcher isDELETE(Rule[] rules,
 Rule... otherwise)

Matches DELETE.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isHEAD

public static Matcher isHEAD(Iterable<? extends Rule> rules)

Matches HEAD.

Parameters:

rules - Invoked only when matched.

isHEAD

public static Matcher isHEAD(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches HEAD.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isHEAD

public static Matcher isHEAD(Rule... rules)

Matches HEAD.

Parameters:

rules - Invoked only when matched.

isHEAD

public static Matcher isHEAD(Rule[] rules,
 Rule... otherwise)

Matches HEAD.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isGET

public static Matcher isGET(Iterable<? extends Rule> rules)

Matches GET.

Parameters:

rules - Invoked only when matched.

isGET

public static Matcher isGET(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches GET.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isGET

public static Matcher isGET(Rule... rules)

Matches GET.

Parameters:

rules - Invoked only when matched.

isGET

public static Matcher isGET(Rule[] rules,
 Rule... otherwise)

Matches GET.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isOPTIONS

public static Matcher isOPTIONS(Iterable<? extends Rule> rules)

Matches OPTIONS.

Parameters:

rules - Invoked only when matched.

isOPTIONS

public static Matcher isOPTIONS(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches OPTIONS.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isOPTIONS

public static Matcher isOPTIONS(Rule... rules)

Matches OPTIONS.

Parameters:

rules - Invoked only when matched.

isOPTIONS

public static Matcher isOPTIONS(Rule[] rules,
 Rule... otherwise)

Matches OPTIONS.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isPOST

public static Matcher isPOST(Iterable<? extends Rule> rules)

Matches POST.

Parameters:

rules - Invoked only when matched.

isPOST

public static Matcher isPOST(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches POST.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isPOST

public static Matcher isPOST(Rule... rules)

Matches POST.

Parameters:

rules - Invoked only when matched.

isPOST

public static Matcher isPOST(Rule[] rules,
 Rule... otherwise)

Matches POST.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isPUT

public static Matcher isPUT(Iterable<? extends Rule> rules)

Matches PUT.

Parameters:

rules - Invoked only when matched.

isPUT

public static Matcher isPUT(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches PUT.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isPUT

public static Matcher isPUT(Rule... rules)

Matches PUT.

Parameters:

rules - Invoked only when matched.

isPUT

public static Matcher isPUT(Rule[] rules,
 Rule... otherwise)

Matches PUT.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isTRACE

public static Matcher isTRACE(Iterable<? extends Rule> rules)

Matches TRACE.

Parameters:

rules - Invoked only when matched.

isTRACE

public static Matcher isTRACE(Iterable<? extends Rule> rules,
 Iterable<? extends Rule> otherwise)

Matches TRACE.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

isTRACE

public static Matcher isTRACE(Rule... rules)

Matches TRACE.

Parameters:

rules - Invoked only when matched.

isTRACE

public static Matcher isTRACE(Rule[] rules,
 Rule... otherwise)

Matches TRACE.

Parameters:

rules - Invoked only when matched.

otherwise - Invoked only when not matched.

constrain

public static Action constrain(Collection<String> methods)

Constrains a request to the given set of methods. Always includes OPTIONS. GET implies HEAD.

When OPTIONS is not in the given set of methods, responds to the request if is the OPTIONS method and stops rules processing. OPTIONS requests are passed-on when included in the set of methods. See https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.2

Responds with 405 Method Not Allowed if the request is not one of the given methods, OPTIONS, or an implied HEAD. See https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.5.

No action is taken when the dispatcher is DispatcherType.INCLUDE, due to the servlet specification making the setting of status codes and headers impossible within includes. See RequestDispatcher.include(javax.servlet.ServletRequest, javax.servlet.ServletResponse) for more details.

TODO: Wrap request/response to convert HEAD to GET here when HEAD implied? Redundant with servlet and Spring MVC behavior, but would not hurt and assumes less about the underlying resources?

TODO: Should this only be applied on the DispatcherType.REQUEST dispatcher instead of just skipping DispatcherType.REQUEST? Should this throw an exception instead of silently taking no action on skipped dispatchers?

Returns:

Action.Result.TERMINATE if has responded to OPTIONS or with 405 status. Action.Result.CONTINUE if the request method is one of the given methods.

constrain

public static Action constrain(String... methods)

See constrain(java.util.Collection).