at.ipsquare.commons.servlet

Class PathPatternRequestMatcher

java.lang.Object

at.ipsquare.commons.servlet.PathPatternRequestMatcher

All Implemented Interfaces:

RequestMatcher

@Immutable
public class PathPatternRequestMatcher
extends Object
implements RequestMatcher

A matcher that matches (relative) path of the request against regular expressions.

About the path being matched:

It is important to note that this filter only considers the path of the request relative to the context root of the web application. So, if the request is http://server/web-app/some/path?p0=1&p1=b, the path that is used for matching is exactly /some/path.

Since:

2.0.0

Author:

Matthias Langer

Constructor Summary

Constructors

Constructor and Description
PathPatternRequestMatcher(Pattern includePattern, Pattern excludePattern) Constructor.
PathPatternRequestMatcher(String includePattern, String excludePattern) Convenience constructor (see PathPatternRequestMatcher(Pattern, Pattern)}.

Method Summary

Methods

Modifier and Type	Method and Description
static RequestMatcher	fromFilterConfig(javax.servlet.FilterConfig config) Builds a PathPatternRequestMatcher from the given filter configuration.
boolean	matches(javax.servlet.ServletRequest req) Attempts to match the given request.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PathPatternRequestMatcher

public PathPatternRequestMatcher(String includePattern,
                         String excludePattern)

Convenience constructor (see PathPatternRequestMatcher(Pattern, Pattern)}.

PathPatternRequestMatcher

public PathPatternRequestMatcher(Pattern includePattern,
                         Pattern excludePattern)

Constructor.

Notes:

• Include patterns are considered before exclude patterns.
• The exact nature of the paths that the given patterns are applied to are explained in the documentation of this class.
• The ease regular expression debugging, matches(ServletRequest) logs every path that is matched or rejected, if the log level is DEBUG or lower.

Parameters:

includePattern - a pattern for relative paths to include (pass NULL to include all paths).

excludePattern - a pattern for relative paths to exclude (pass NULL if you don't want to exclude anything).

Method Detail

fromFilterConfig

public static RequestMatcher fromFilterConfig(javax.servlet.FilterConfig config)

Builds a PathPatternRequestMatcher from the given filter configuration.

This constructor function looks for init parameters named InitParameterNames.INCLUDE_PATH_PATTERN and InitParameterNames.EXCLUDE_PATH_PATTERN in the given FilterConfig and the ServletContext. Values from the given configuration override values from the ServletContext.

See Also:

InitParameterNames.INCLUDE_PATH_PATTERN, InitParameterNames.EXCLUDE_PATH_PATTERN

matches

public boolean matches(javax.servlet.ServletRequest req)

Description copied from interface: RequestMatcher

Attempts to match the given request.

Specified by:

matches in interface RequestMatcher

toString

public String toString()

Overrides:

toString in class Object