Class AbstractRequestMatcherRegistry<C>
- Type Parameters:
C
- The object that is returned or Chained after creating the RequestMatcher
- Direct Known Subclasses:
AbstractConfigAttributeRequestMatcherRegistry
,AuthorizeHttpRequestsConfigurer.AuthorizationManagerRequestMatcherRegistry
,HttpSecurity.RequestMatcherConfigurer
,WebSecurity.IgnoredRequestConfigurer
RequestMatcher
's. For example, it might allow for
specifying which RequestMatcher
require a certain level of authorization.- Since:
- 3.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionMaps any request.protected abstract C
chainRequestMatchers
(List<RequestMatcher> requestMatchers) Subclasses should implement this method for returning the object that is chained to the creation of theRequestMatcher
instances.protected final List<MvcRequestMatcher>
createMvcMatchers
(org.springframework.http.HttpMethod method, String... mvcPatterns) CreatesMvcRequestMatcher
instances for the method and patterns passed indispatcherTypeMatchers
(jakarta.servlet.DispatcherType... dispatcherTypes) dispatcherTypeMatchers
(org.springframework.http.HttpMethod method, jakarta.servlet.DispatcherType... dispatcherTypes) Maps aList
ofDispatcherTypeRequestMatcher
instances.protected final org.springframework.context.ApplicationContext
Gets theApplicationContext
requestMatchers
(String... patterns) If theHandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that does not care whichHttpMethod
is used.requestMatchers
(org.springframework.http.HttpMethod method) If theHandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that matches on a specificHttpMethod
.requestMatchers
(org.springframework.http.HttpMethod method, String... patterns) If theHandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that also specifies a specificHttpMethod
to match on.requestMatchers
(RequestMatcher... requestMatchers) Associates a list ofRequestMatcher
instances with theAbstractConfigAttributeRequestMatcherRegistry
protected final void
setApplicationContext
(org.springframework.context.ApplicationContext context)
-
Constructor Details
-
AbstractRequestMatcherRegistry
public AbstractRequestMatcherRegistry()
-
-
Method Details
-
setApplicationContext
protected final void setApplicationContext(org.springframework.context.ApplicationContext context) -
getApplicationContext
protected final org.springframework.context.ApplicationContext getApplicationContext()Gets theApplicationContext
- Returns:
- the
ApplicationContext
-
anyRequest
Maps any request.- Returns:
- the object that is chained after creating the
RequestMatcher
-
createMvcMatchers
protected final List<MvcRequestMatcher> createMvcMatchers(org.springframework.http.HttpMethod method, String... mvcPatterns) CreatesMvcRequestMatcher
instances for the method and patterns passed in- Parameters:
method
- the HTTP method to use or null if any should be usedmvcPatterns
- the Spring MVC patterns to match on- Returns:
- a List of
MvcRequestMatcher
instances
-
dispatcherTypeMatchers
public C dispatcherTypeMatchers(@Nullable org.springframework.http.HttpMethod method, jakarta.servlet.DispatcherType... dispatcherTypes) Maps aList
ofDispatcherTypeRequestMatcher
instances.- Parameters:
method
- theHttpMethod
to use ornull
for anyHttpMethod
.dispatcherTypes
- the dispatcher types to match against- Returns:
- the object that is chained after creating the
RequestMatcher
-
dispatcherTypeMatchers
- Parameters:
dispatcherTypes
- the dispatcher types to match against- Returns:
- the object that is chained after creating the
RequestMatcher
-
requestMatchers
Associates a list ofRequestMatcher
instances with theAbstractConfigAttributeRequestMatcherRegistry
- Parameters:
requestMatchers
- theRequestMatcher
instances- Returns:
- the object that is chained after creating the
RequestMatcher
-
requestMatchers
If the
HandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that also specifies a specificHttpMethod
to match on. This matcher will use the same rules that Spring MVC uses for matching. For example, often times a mapping of the path "/path" will match on "/path", "/path/", "/path.html", etc. If theHandlerMappingIntrospector
is not available, maps to anAntPathRequestMatcher
.If a specific
RequestMatcher
must be specified, userequestMatchers(RequestMatcher...)
instead- Parameters:
method
- theHttpMethod
to use ornull
for anyHttpMethod
.patterns
- the patterns to match on. The rules for matching are defined by Spring MVC ifMvcRequestMatcher
is used- Returns:
- the object that is chained after creating the
RequestMatcher
. - Since:
- 5.8
-
requestMatchers
If the
HandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that does not care whichHttpMethod
is used. This matcher will use the same rules that Spring MVC uses for matching. For example, often times a mapping of the path "/path" will match on "/path", "/path/", "/path.html", etc. If theHandlerMappingIntrospector
is not available, maps to anAntPathRequestMatcher
.If a specific
RequestMatcher
must be specified, userequestMatchers(RequestMatcher...)
instead- Parameters:
patterns
- the patterns to match on. The rules for matching are defined by Spring MVC ifMvcRequestMatcher
is used- Returns:
- the object that is chained after creating the
RequestMatcher
. - Since:
- 5.8
-
requestMatchers
If the
HandlerMappingIntrospector
is available in the classpath, maps to anMvcRequestMatcher
that matches on a specificHttpMethod
. This matcher will use the same rules that Spring MVC uses for matching. For example, often times a mapping of the path "/path" will match on "/path", "/path/", "/path.html", etc. If theHandlerMappingIntrospector
is not available, maps to anAntPathRequestMatcher
.If a specific
RequestMatcher
must be specified, userequestMatchers(RequestMatcher...)
instead- Parameters:
method
- theHttpMethod
to use ornull
for anyHttpMethod
.- Returns:
- the object that is chained after creating the
RequestMatcher
. - Since:
- 5.8
-
chainRequestMatchers
Subclasses should implement this method for returning the object that is chained to the creation of theRequestMatcher
instances.- Parameters:
requestMatchers
- theRequestMatcher
instances that were created- Returns:
- the chained Object for the subclass which allows association of something
else to the
RequestMatcher
-