Class StaticResourceRequest.StaticResourceRequestMatcher

java.lang.Object

org.springframework.boot.security.web.servlet.ApplicationContextRequestMatcher<DispatcherServletPath>

org.springframework.boot.security.autoconfigure.web.servlet.StaticResourceRequest.StaticResourceRequestMatcher

All Implemented Interfaces:

RequestMatcher

Enclosing class:

StaticResourceRequest

public static final class StaticResourceRequest.StaticResourceRequestMatcher
extends ApplicationContextRequestMatcher<DispatcherServletPath>

The request matcher used to match against resource Locations.

Since:

4.0.0

Author:

Madhura Bhave, Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface RequestMatcher

RequestMatcher.MatchResult

Method Summary

Modifier and Type	Method	Description
StaticResourceRequest.StaticResourceRequestMatcher	excluding(Set<StaticResourceLocation> locations)	Return a new StaticResourceRequest.StaticResourceRequestMatcher based on this one but excluding the specified locations.
StaticResourceRequest.StaticResourceRequestMatcher	excluding(StaticResourceLocation first, StaticResourceLocation... rest)	Return a new StaticResourceRequest.StaticResourceRequestMatcher based on this one but excluding the specified locations.
protected boolean	ignoreApplicationContext(WebApplicationContext applicationContext)	Returns if the WebApplicationContext should be ignored and not used for matching.
protected void	initialized(Supplier<DispatcherServletPath> dispatcherServletPath)	Method that can be implemented by subclasses that wish to initialize items the first time that the matcher is called.
protected boolean	matches(HttpServletRequest request, Supplier<DispatcherServletPath> context)	Decides whether the rule implemented by the strategy matches the supplied request.

Methods inherited from class ApplicationContextRequestMatcher

matches

Methods inherited from class Object

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

Methods inherited from interface RequestMatcher

matcher

Method Details

excluding

public StaticResourceRequest.StaticResourceRequestMatcher excluding(StaticResourceLocation first,
 StaticResourceLocation... rest)

Return a new StaticResourceRequest.StaticResourceRequestMatcher based on this one but excluding the specified locations.

Parameters:

first - the first location to exclude

rest - additional locations to exclude

Returns:

a new StaticResourceRequest.StaticResourceRequestMatcher

excluding

public StaticResourceRequest.StaticResourceRequestMatcher excluding(Set<StaticResourceLocation> locations)

Return a new StaticResourceRequest.StaticResourceRequestMatcher based on this one but excluding the specified locations.

Parameters:

locations - the locations to exclude

Returns:

a new StaticResourceRequest.StaticResourceRequestMatcher

initialized

protected void initialized(Supplier<DispatcherServletPath> dispatcherServletPath)

Description copied from class: ApplicationContextRequestMatcher

Method that can be implemented by subclasses that wish to initialize items the first time that the matcher is called. This method will be called only once and only if ApplicationContextRequestMatcher.ignoreApplicationContext(WebApplicationContext) returns false. Note that the supplied context will be based on the first request sent to the matcher.

Overrides:

initialized in class ApplicationContextRequestMatcher<DispatcherServletPath>

Parameters:

dispatcherServletPath - a supplier for the initialized context (may throw an exception)

See Also:

• ApplicationContextRequestMatcher.ignoreApplicationContext(WebApplicationContext)

ignoreApplicationContext

protected boolean ignoreApplicationContext(WebApplicationContext applicationContext)

Description copied from class: ApplicationContextRequestMatcher

Returns if the WebApplicationContext should be ignored and not used for matching. If this method returns true then the context will not be used and the matches method will return false.

Overrides:

ignoreApplicationContext in class ApplicationContextRequestMatcher<DispatcherServletPath>

Parameters:

applicationContext - the candidate web application context

Returns:

if the application context should be ignored

matches

protected boolean matches(HttpServletRequest request,
 Supplier<DispatcherServletPath> context)

Description copied from class: ApplicationContextRequestMatcher

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

Specified by:

matches in class ApplicationContextRequestMatcher<DispatcherServletPath>

Parameters:

request - the source request

context - a supplier for the initialized context (may throw an exception)

Returns:

if the request matches