public final class

AntPathRequestMatcher

extends Object
implements RequestMatcher
java.lang.Object
   ↳ org.springframework.security.web.util.AntPathRequestMatcher

Class Overview

Matcher which compares a pre-defined ant-style pattern against the URL (servletPath + pathInfo) of an HttpServletRequest. The query string of the URL is ignored and matching is case-insensitive.

Using a pattern value of /** or ** is treated as a universal match, which will match any request. Patterns which end with /** (and have no other wildcards) are optimized by using a substring match — a pattern of /aaa/** will match /aaa, /aaa/ and any sub-directories, such as /aaa/bbb/ccc.

For all other cases, Spring's AntPathMatcher is used to perform the match. See the Spring documentation for this class for comprehensive information on the syntax used.

See Also
  • org.springframework.util.AntPathMatcher

Summary

Public Constructors
AntPathRequestMatcher(String pattern)
Creates a matcher with the specific pattern which will match all HTTP methods.
AntPathRequestMatcher(String pattern, String httpMethod)
Creates a matcher with the supplied pattern which will match all HTTP methods.
Public Methods
boolean equals(Object obj)
String getPattern()
int hashCode()
boolean matches(HttpServletRequest request)
Returns true if the configured pattern (and HTTP-Method) match those of the supplied request.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.security.web.util.RequestMatcher

Public Constructors

public AntPathRequestMatcher (String pattern)

Creates a matcher with the specific pattern which will match all HTTP methods.

Parameters
pattern the ant pattern to use for matching

public AntPathRequestMatcher (String pattern, String httpMethod)

Creates a matcher with the supplied pattern which will match all HTTP methods.

Parameters
pattern the ant pattern to use for matching
httpMethod the HTTP method. The matches method will return false if the incoming request doesn't have the same method.

Public Methods

public boolean equals (Object obj)

public String getPattern ()

public int hashCode ()

public boolean matches (HttpServletRequest request)

Returns true if the configured pattern (and HTTP-Method) match those of the supplied request.

Parameters
request the request to match against. The ant pattern will be matched against the servletPath + pathInfo of the request.
Returns
  • true if the request matches, false otherwise

public String toString ()