Package org.springframework.security.web.servlet.util.matcher

Class PathPatternRequestMatcher

java.lang.Object

org.springframework.security.web.servlet.util.matcher.PathPatternRequestMatcher

All Implemented Interfaces:

RequestMatcher

public final class PathPatternRequestMatcher
extends Object
implements RequestMatcher

A RequestMatcher that uses PathPatterns to match against each HttpServletRequest. The provided path should be relative to the context path (that is, it should exclude any context path).

You can provide the servlet path in servletPath and reuse for multiple matchers.

Note that the HandlerMapping that contains the related URI patterns must be using PathPatternParser.defaultInstance. If that is not the case, use PathPatternParser to parse your path and provide a PathPattern in the constructor.

Since:

6.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PathPatternRequestMatcher.Builder	A builder for specifying various elements of a request for the purpose of creating a PathPatternRequestMatcher.

Nested classes/interfaces inherited from interface org.springframework.security.web.util.matcher.RequestMatcher

RequestMatcher.MatchResult

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
RequestMatcher.MatchResult	matcher(jakarta.servlet.http.HttpServletRequest request)	Returns a MatchResult for this RequestMatcher.
boolean	matches(jakarta.servlet.http.HttpServletRequest request)	Decides whether the rule implemented by the strategy matches the supplied request.
String	toString()
static PathPatternRequestMatcher.Builder	withDefaults()	Use PathPatternParser.defaultInstance to parse path patterns.
static PathPatternRequestMatcher.Builder	withPathPatternParser(org.springframework.web.util.pattern.PathPatternParser parser)	Use this PathPatternParser to parse path patterns.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

withDefaults

public static PathPatternRequestMatcher.Builder withDefaults()

Use PathPatternParser.defaultInstance to parse path patterns.

Returns:

a PathPatternRequestMatcher.Builder that treats URIs as relative to the context path, if any

withPathPatternParser

public static PathPatternRequestMatcher.Builder withPathPatternParser(org.springframework.web.util.pattern.PathPatternParser parser)

Use this PathPatternParser to parse path patterns.

Parameters:

parser - the PathPatternParser to use

Returns:

a PathPatternRequestMatcher.Builder that treats URIs as relative to the given servletPath

matches

public boolean matches(jakarta.servlet.http.HttpServletRequest request)

Decides whether the rule implemented by the strategy matches the supplied request.

Specified by:

matches in interface RequestMatcher

Parameters:

request - the request to check for a match

Returns:

true if the request matches, false otherwise

matcher

public RequestMatcher.MatchResult matcher(jakarta.servlet.http.HttpServletRequest request)

Returns a MatchResult for this RequestMatcher. The default implementation returns Collections.emptyMap() when RequestMatcher.MatchResult.getVariables() is invoked.

Specified by:

matcher in interface RequestMatcher

Returns:

the MatchResult from comparing this RequestMatcher against the HttpServletRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object