Class HandlerMappingIntrospector
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ApplicationContextAware
,org.springframework.web.cors.CorsConfigurationSource
HandlerMapping
that would
serve a specific request.
Provides the following methods:
getMatchableHandlerMapping(jakarta.servlet.http.HttpServletRequest)
— obtain aHandlerMapping
to check request-matching criteria against.getCorsConfiguration(jakarta.servlet.http.HttpServletRequest)
— obtain the CORS configuration for the request.
Note that this is primarily an SPI to allow Spring Security to align its pattern matching with the same pattern matching that would be used in Spring MVC for a given request, in order to avoid security issues.
Use of this component incurs the performance overhead of mapping the
request, and should not be repeated multiple times per request.
createCacheFilter()
exposes a Filter to cache the results.
Applications that rely on Spring Security don't need to deploy this Filter
since Spring Security doe that. However, other custom security layers, used
in place of Spring Security that use this component should deploy the cache
Filter with requirements described in the Javadoc for the method.
- Since:
- 4.3.1
- Author:
- Rossen Stoyanchev
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Container for aMatchableHandlerMapping
andCorsConfiguration
for a given request matched by dispatcher type and requestURI. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Filter
that looks up theMatchableHandlerMapping
andCorsConfiguration
for the request proactively before delegating to the rest of the chain, caching the result in a request attribute, and restoring it after the chain returns.org.springframework.web.cors.CorsConfiguration
getCorsConfiguration
(HttpServletRequest request) Return the configured or detectedHandlerMapping
s.Find theHandlerMapping
that would handle the given request and return aMatchableHandlerMapping
to use for path matching.void
resetCache
(ServletRequest request, HandlerMappingIntrospector.CachedResult cachedResult) Restore a previousHandlerMappingIntrospector.CachedResult
.void
setApplicationContext
(org.springframework.context.ApplicationContext applicationContext) setCache
(HttpServletRequest request) Perform a lookup and save theHandlerMappingIntrospector.CachedResult
as a request attribute.
-
Constructor Details
-
HandlerMappingIntrospector
public HandlerMappingIntrospector()
-
-
Method Details
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) - Specified by:
setApplicationContext
in interfaceorg.springframework.context.ApplicationContextAware
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
getHandlerMappings
Return the configured or detectedHandlerMapping
s. -
createCacheFilter
Filter
that looks up theMatchableHandlerMapping
andCorsConfiguration
for the request proactively before delegating to the rest of the chain, caching the result in a request attribute, and restoring it after the chain returns.Note: Applications that rely on Spring Security do not use this component directly and should not deploy the filter instead allowing Spring Security to do it. Other custom security layers used in place of Spring Security that also rely on
HandlerMappingIntrospector
should deploy this filter ahead of other filters where lookups are performed, and should also make sure the filter is configured to handle all dispatcher types.- Returns:
- the Filter instance to use
- Since:
- 6.0.14
-
setCache
Perform a lookup and save theHandlerMappingIntrospector.CachedResult
as a request attribute. This method can be invoked from a filter before subsequent calls togetMatchableHandlerMapping(HttpServletRequest)
andgetCorsConfiguration(HttpServletRequest)
to avoid repeated lookups.- Parameters:
request
- the current request- Returns:
- the previous
HandlerMappingIntrospector.CachedResult
, if there is one from a parent dispatch - Since:
- 6.0.14
-
resetCache
public void resetCache(ServletRequest request, @Nullable HandlerMappingIntrospector.CachedResult cachedResult) Restore a previousHandlerMappingIntrospector.CachedResult
. This method can be invoked from a filter after delegating to the rest of the chain.- Since:
- 6.0.14
-
getMatchableHandlerMapping
@Nullable public MatchableHandlerMapping getMatchableHandlerMapping(HttpServletRequest request) throws Exception Find theHandlerMapping
that would handle the given request and return aMatchableHandlerMapping
to use for path matching.- Parameters:
request
- the current request- Returns:
- the resolved
MatchableHandlerMapping
, ornull
- Throws:
IllegalStateException
- if the matching HandlerMapping is not an instance ofMatchableHandlerMapping
Exception
- if any of the HandlerMapping's raise an exception
-
getCorsConfiguration
@Nullable public org.springframework.web.cors.CorsConfiguration getCorsConfiguration(HttpServletRequest request) - Specified by:
getCorsConfiguration
in interfaceorg.springframework.web.cors.CorsConfigurationSource
-