Modifier and Type	Class and Description
private static class	HandlerMappingIntrospector.AttributesPreservingRequest Request wrapper that buffers request attributes in order protect the underlying request from attribute changes.
public static class	HandlerMappingIntrospector.CachedResult Container for a `MatchableHandlerMapping` and `CorsConfiguration` for a given request matched by dispatcher type and requestURI.
private static class	HandlerMappingIntrospector.CacheResultLogHelper
private static class	HandlerMappingIntrospector.LookupPathMatchableHandlerMapping

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private static final String	CACHED_RESULT_ATTRIBUTE
private final HandlerMappingIntrospector.CacheResultLogHelper	cacheLogHelper
private List<HandlerMapping>	handlerMappings
private static final Log	logger
private Map<HandlerMapping, PathPatternMatchableHandlerMapping>	pathPatternMappings

Access	Constructor and Description
public	HandlerMappingIntrospector()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public Filter	Returns: the Filter instance to use createCacheFilter() `Filter` that looks up the `MatchableHandlerMapping` and `CorsConfiguration` 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.
private MatchableHandlerMapping	createMatchableHandlerMapping(HandlerMapping mapping, HttpServletRequest request)
private <T> T	doWithHandlerMapping(HttpServletRequest request, boolean ignoreException, BiFunction<HandlerMapping, HandlerExecutionChain, T> extractor)
public CorsConfiguration	getCorsConfiguration(HttpServletRequest request) Implements org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration. Return a `CorsConfiguration` based on the incoming request.
private static CorsConfiguration	getCorsConfiguration(HandlerExecutionChain chain, HttpServletRequest request)
public List<HandlerMapping>	getHandlerMappings() Return the configured or detected `HandlerMapping`s.
public MatchableHandlerMapping	Returns: the resolved `MatchableHandlerMapping`, or `null` getMatchableHandlerMapping(HttpServletRequest the current request request) Find the `HandlerMapping` that would handle the given request and return a `MatchableHandlerMapping` to use for path matching.
private static List<HandlerMapping>	initFallback(ApplicationContext applicationContext)
private static List<HandlerMapping>	initHandlerMappings(ApplicationContext context)
public void	resetCache(ServletRequest request, HandlerMappingIntrospector.CachedResult cachedResult) Restore a previous `CachedResult`.
public void	setApplicationContext(ApplicationContext the ApplicationContext object to be used by this object applicationContext) Implements org.springframework.context.ApplicationContextAware.setApplicationContext. Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.
public HandlerMappingIntrospector.CachedResult	Returns: the previous `CachedResult`, if there is one from a parent dispatch setCache(HttpServletRequest the current request request) Perform a lookup and save the `CachedResult` as a request attribute.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationContext	back to summary
private ApplicationContext applicationContext Annotations @Nullable

CACHED_RESULT_ATTRIBUTE	back to summary
private static final String CACHED_RESULT_ATTRIBUTE

cacheLogHelper	back to summary
private final HandlerMappingIntrospector.CacheResultLogHelper cacheLogHelper

handlerMappings	back to summary
private List<HandlerMapping> handlerMappings Annotations @Nullable

logger	back to summary
private static final Log logger

pathPatternMappings	back to summary
private Map<HandlerMapping, PathPatternMatchableHandlerMapping> pathPatternMappings

HandlerMappingIntrospector	back to summary
public HandlerMappingIntrospector()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

createCacheFilter back to summary

createCacheFilter	back to summary
public Filter createCacheFilter() `Filter` that looks up the `MatchableHandlerMapping` and `CorsConfiguration` 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:Filter the Filter instance to use Since 6.0.14

public Filter createCacheFilter()

Filter that looks up the MatchableHandlerMapping and CorsConfiguration 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:Filter: the Filter instance to use
Since: 6.0.14

createMatchableHandlerMapping	back to summary
private MatchableHandlerMapping createMatchableHandlerMapping(HandlerMapping mapping, HttpServletRequest request)

doWithHandlerMapping	back to summary
private <T> T doWithHandlerMapping(HttpServletRequest request, boolean ignoreException, BiFunction<HandlerMapping, HandlerExecutionChain, T> extractor) throws Exception Annotations @Nullable

getCorsConfiguration back to summary

getCorsConfiguration	back to summary
public CorsConfiguration getCorsConfiguration(HttpServletRequest request) Implements org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration. Doc from org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration. Return a `CorsConfiguration` based on the incoming request. Returns:CorsConfiguration the associated `CorsConfiguration`, or `null` if none Annotations @Override @Nullable

public CorsConfiguration getCorsConfiguration(HttpServletRequest request)

Implements org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration.

Doc from org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration.

Return a CorsConfiguration based on the incoming request.

Returns:CorsConfiguration

the associated CorsConfiguration, or null if none

Annotations

@Override
@Nullable

getCorsConfiguration	back to summary
private static CorsConfiguration getCorsConfiguration(HandlerExecutionChain chain, HttpServletRequest request) Annotations @Nullable

getHandlerMappings	back to summary
public List<HandlerMapping> getHandlerMappings() Return the configured or detected `HandlerMapping`s.

getMatchableHandlerMapping back to summary

getMatchableHandlerMapping	back to summary
public MatchableHandlerMapping getMatchableHandlerMapping(HttpServletRequest request) throws Exception Find the `HandlerMapping` that would handle the given request and return a `MatchableHandlerMapping` to use for path matching. Parameters request:HttpServletRequest the current request Returns:MatchableHandlerMapping the resolved `MatchableHandlerMapping`, or `null` Annotations @Nullable Exceptions Exception: if any of the HandlerMapping's raise an exception IllegalStateException: if the matching HandlerMapping is not an instance of `MatchableHandlerMapping`

public MatchableHandlerMapping getMatchableHandlerMapping(HttpServletRequest request) throws Exception

Find the HandlerMapping that would handle the given request and return a MatchableHandlerMapping to use for path matching.

Parameters

request:HttpServletRequest: the current request

Returns:MatchableHandlerMapping

the resolved MatchableHandlerMapping, or null

Annotations

@Nullable

Exceptions

Exception:: if any of the HandlerMapping's raise an exception
IllegalStateException:: if the matching HandlerMapping is not an instance of MatchableHandlerMapping

initFallback	back to summary
private static List<HandlerMapping> initFallback(ApplicationContext applicationContext)

initHandlerMappings	back to summary
private static List<HandlerMapping> initHandlerMappings(ApplicationContext context)

resetCache back to summary

resetCache	back to summary
public void resetCache(ServletRequest request, HandlerMappingIntrospector.CachedResult cachedResult) Restore a previous `CachedResult`. This method can be invoked from a filter after delegating to the rest of the chain. Since 6.0.14

public void resetCache(ServletRequest request, HandlerMappingIntrospector.CachedResult cachedResult)

Restore a previous CachedResult. This method can be invoked from a filter after delegating to the rest of the chain.

Since: 6.0.14

setApplicationContext back to summary

setApplicationContext	back to summary
public void setApplicationContext(ApplicationContext applicationContext) Implements org.springframework.context.ApplicationContextAware.setApplicationContext. Doc from org.springframework.context.ApplicationContextAware.setApplicationContext. Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object. Invoked after population of normal bean properties but before an init callback such as `org.springframework.beans.factory.InitializingBean#afterPropertiesSet()` or a custom init-method. Invoked after `ResourceLoaderAware#setResourceLoader`, `ApplicationEventPublisherAware#setApplicationEventPublisher` and `MessageSourceAware`, if applicable. Parameters applicationContext:ApplicationContext the ApplicationContext object to be used by this object Annotations @Override

public void setApplicationContext(ApplicationContext applicationContext)

Implements org.springframework.context.ApplicationContextAware.setApplicationContext.

Doc from org.springframework.context.ApplicationContextAware.setApplicationContext.

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as org.springframework.beans.factory.InitializingBean#afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware#setResourceLoader, ApplicationEventPublisherAware#setApplicationEventPublisher and MessageSourceAware, if applicable.

Parameters

applicationContext:ApplicationContext: the ApplicationContext object to be used by this object

Annotations

@Override

setCache back to summary

setCache	back to summary
public HandlerMappingIntrospector.CachedResult setCache(HttpServletRequest request) Perform a lookup and save the `CachedResult` as a request attribute. This method can be invoked from a filter before subsequent calls to `getMatchableHandlerMapping(HttpServletRequest)` and `getCorsConfiguration(HttpServletRequest)` to avoid repeated lookups. Parameters request:HttpServletRequest the current request Returns:HandlerMappingIntrospector.CachedResult the previous `CachedResult`, if there is one from a parent dispatch Annotations @Nullable Since 6.0.14

public HandlerMappingIntrospector.CachedResult setCache(HttpServletRequest request)

Perform a lookup and save the CachedResult as a request attribute. This method can be invoked from a filter before subsequent calls to getMatchableHandlerMapping(HttpServletRequest) and getCorsConfiguration(HttpServletRequest) to avoid repeated lookups.

Parameters

request:HttpServletRequest: the current request

Returns:HandlerMappingIntrospector.CachedResult

the previous CachedResult, if there is one from a parent dispatch

Annotations

@Nullable

Since

6.0.14

org.springframework.web.servlet.handler back to summary

private Class HandlerMappingIntrospector.AttributesPreservingRequest

Class Inheritance

extends HttpServletRequestWrapper

java.lang.Object
jakarta.servlet.ServletRequestWrapper
jakarta.servlet.http.HttpServletRequestWrapper
org.springframework.web.servlet.handler.HandlerMappingIntrospector.AttributesPreservingRequest

Request wrapper that buffers request attributes in order protect the underlying request from attribute changes.

Field Summary

Modifier and Type	Field and Description
private final Map<String, Object>	attributes

Constructor Summary

Access	Constructor and Description
pack-priv	AttributesPreservingRequest(HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
public Object	getAttribute(String a `String` specifying the name of the attribute name) Overrides jakarta.servlet.ServletRequestWrapper.getAttribute. Implements jakarta.servlet.ServletRequest.getAttribute. Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists.
public Enumeration<String>	getAttributeNames() Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames. Implements jakarta.servlet.ServletRequest.getAttributeNames. Returns an `Enumeration` containing the names of the attributes available to this request.
private Map<String, Object>	initAttributes(HttpServletRequest request)
public void	removeAttribute(String a `String` specifying the name of the attribute to remove name) Overrides jakarta.servlet.ServletRequestWrapper.removeAttribute. Implements jakarta.servlet.ServletRequest.removeAttribute. Removes an attribute from this request.
public void	setAttribute(String a `String` specifying the name of the attribute name, Object the `Object` to be stored value) Overrides jakarta.servlet.ServletRequestWrapper.setAttribute. Implements jakarta.servlet.ServletRequest.setAttribute. Stores an attribute in this request.

Field Detail

attributes	back to summary
private final Map<String, Object> attributes

Constructor Detail

AttributesPreservingRequest	back to summary
pack-priv AttributesPreservingRequest(HttpServletRequest request)

Method Detail

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(String name) Overrides jakarta.servlet.ServletRequestWrapper.getAttribute. Implements jakarta.servlet.ServletRequest.getAttribute. Doc from jakarta.servlet.ServletRequest.getAttribute. Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists. Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute `jakarta.servlet.request.X509Certificate` can be used to retrieve information on the certificate of the client. Attributes can also be set programmatically using `ServletRequest#setAttribute`. This allows information to be embedded into a request before a `RequestDispatcher` call. Attribute names should follow the same conventions as package names. Names beginning with `jakarta.*` are reserved for use by the Jakarta EE platform. Parameters name:String a `String` specifying the name of the attribute Returns:Object an `Object` containing the value of the attribute, or `null` if the attribute does not exist Annotations @Override

public Object getAttribute(String name)

Overrides jakarta.servlet.ServletRequestWrapper.getAttribute.

Implements jakarta.servlet.ServletRequest.getAttribute.

Doc from jakarta.servlet.ServletRequest.getAttribute.

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute jakarta.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programmatically using ServletRequest#setAttribute. This allows information to be embedded into a request before a RequestDispatcher call.

Attribute names should follow the same conventions as package names. Names beginning with jakarta.* are reserved for use by the Jakarta EE platform.

Parameters

name:String: a String specifying the name of the attribute

Returns:Object

an Object containing the value of the attribute, or null if the attribute does not exist

Annotations

@Override

getAttributeNames back to summary

getAttributeNames	back to summary
public Enumeration<String> getAttributeNames() Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames. Implements jakarta.servlet.ServletRequest.getAttributeNames. Doc from jakarta.servlet.ServletRequest.getAttributeNames. Returns an `Enumeration` containing the names of the attributes available to this request. This method returns an empty `Enumeration` if the request has no attributes available to it. Returns:Enumeration<String> an `Enumeration` of strings containing the names of the request's attributes Annotations @Override

public Enumeration<String> getAttributeNames()

Overrides jakarta.servlet.ServletRequestWrapper.getAttributeNames.

Implements jakarta.servlet.ServletRequest.getAttributeNames.

Doc from jakarta.servlet.ServletRequest.getAttributeNames.

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:Enumeration<String>

an Enumeration of strings containing the names of the request's attributes

Annotations

@Override

initAttributes	back to summary
private Map<String, Object> initAttributes(HttpServletRequest request)

removeAttribute back to summary

removeAttribute	back to summary
public void removeAttribute(String name) Overrides jakarta.servlet.ServletRequestWrapper.removeAttribute. Implements jakarta.servlet.ServletRequest.removeAttribute. Doc from jakarta.servlet.ServletRequest.removeAttribute. Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled. Attribute names should follow the same conventions as package names. Names beginning with `jakarta.*` are reserved for use by the Jakarta EE platform. Parameters name:String a `String` specifying the name of the attribute to remove Annotations @Override

public void removeAttribute(String name)

Overrides jakarta.servlet.ServletRequestWrapper.removeAttribute.

Implements jakarta.servlet.ServletRequest.removeAttribute.

Doc from jakarta.servlet.ServletRequest.removeAttribute.

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

Attribute names should follow the same conventions as package names. Names beginning with jakarta.* are reserved for use by the Jakarta EE platform.

Parameters

name:String: a String specifying the name of the attribute to remove

Annotations

@Override

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(String name, Object value) Overrides jakarta.servlet.ServletRequestWrapper.setAttribute. Implements jakarta.servlet.ServletRequest.setAttribute. Doc from jakarta.servlet.ServletRequest.setAttribute. Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with `RequestDispatcher`. Attribute names should follow the same conventions as package names. Names beginning with `jakarta.*` are reserved for use by the Jakarta EE platform. If the object passed in is null, the effect is the same as calling `removeAttribute`. It is warned that when the request is dispatched from the servlet resides in a different web application by `RequestDispatcher`, the object set by this method may not be correctly retrieved in the caller servlet. Parameters name:String a `String` specifying the name of the attribute value:Object the `Object` to be stored Annotations @Override

public void setAttribute(String name, Object value)

Overrides jakarta.servlet.ServletRequestWrapper.setAttribute.

Implements jakarta.servlet.ServletRequest.setAttribute.

Doc from jakarta.servlet.ServletRequest.setAttribute.

Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher.

Attribute names should follow the same conventions as package names. Names beginning with jakarta.* are reserved for use by the Jakarta EE platform.

If the object passed in is null, the effect is the same as calling removeAttribute.
It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.

Parameters

name:String: a String specifying the name of the attribute
value:Object: the Object to be stored

Annotations

@Override

org.springframework.web.servlet.handler back to summary

public final Class HandlerMappingIntrospector.CachedResult

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.handler.HandlerMappingIntrospector.CachedResult

Annotations

@SuppressWarnings:serial

Container for a MatchableHandlerMapping and CorsConfiguration for a given request matched by dispatcher type and requestURI.

Since: 6.0.14

Field Summary

Modifier and Type	Field and Description
private final CorsConfiguration	corsConfig
private final IllegalStateException	corsConfigFailure
private final DispatcherType	dispatcherType
private final Exception	failure
private final MatchableHandlerMapping	handlerMapping
private final String	requestURI

Constructor Summary

Access	Constructor and Description
private	CachedResult(HttpServletRequest request, MatchableHandlerMapping mapping, CorsConfiguration config, Exception failure, IllegalStateException corsConfigFailure)

Method Summary

Modifier and Type	Method and Description
public CorsConfiguration	getCorsConfig()
public MatchableHandlerMapping	getHandlerMapping()
public static HandlerMappingIntrospector.CachedResult	getResultFor(HttpServletRequest request) Return a `CachedResult` that matches the given request.
public boolean	matches(HttpServletRequest request)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

corsConfig	back to summary
private final CorsConfiguration corsConfig Annotations @Nullable

corsConfigFailure	back to summary
private final IllegalStateException corsConfigFailure Annotations @Nullable

dispatcherType	back to summary
private final DispatcherType dispatcherType

failure	back to summary
private final Exception failure Annotations @Nullable

handlerMapping	back to summary
private final MatchableHandlerMapping handlerMapping Annotations @Nullable

requestURI	back to summary
private final String requestURI

Constructor Detail

CachedResult	back to summary
private CachedResult(HttpServletRequest request, MatchableHandlerMapping mapping, CorsConfiguration config, Exception failure, IllegalStateException corsConfigFailure)

Method Detail

getCorsConfig	back to summary
public CorsConfiguration getCorsConfig() Annotations @Nullable

getHandlerMapping	back to summary
public MatchableHandlerMapping getHandlerMapping() throws Exception Annotations @Nullable

getResultFor back to summary

getResultFor	back to summary
public static HandlerMappingIntrospector.CachedResult getResultFor(HttpServletRequest request) Return a `CachedResult` that matches the given request. Annotations @Nullable

public static HandlerMappingIntrospector.CachedResult getResultFor(HttpServletRequest request)

Return a CachedResult that matches the given request.

Annotations

@Nullable

matches	back to summary
public boolean matches(HttpServletRequest request)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.web.servlet.handler back to summary

private Class HandlerMappingIntrospector.CacheResultLogHelper

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.handler.HandlerMappingIntrospector.CacheResultLogHelper

Field Summary

Modifier and Type	Field and Description
private final Map<String, AtomicInteger>	counters

Constructor Summary

Access	Constructor and Description
private	CacheResultLogHelper()

Method Summary

Modifier and Type	Method and Description
private static String	getLogMessage(String label, HttpServletRequest request)
private void	logCacheMiss(String label, HttpServletRequest request)
public void	logCorsConfigCacheMiss(HttpServletRequest request)
public void	logHandlerMappingCacheMiss(HttpServletRequest request)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

counters	back to summary
private final Map<String, AtomicInteger> counters

Constructor Detail

CacheResultLogHelper	back to summary
private CacheResultLogHelper()

Method Detail

getLogMessage	back to summary
private static String getLogMessage(String label, HttpServletRequest request)

logCacheMiss	back to summary
private void logCacheMiss(String label, HttpServletRequest request)

logCorsConfigCacheMiss	back to summary
public void logCorsConfigCacheMiss(HttpServletRequest request)

logHandlerMappingCacheMiss	back to summary
public void logHandlerMappingCacheMiss(HttpServletRequest request)

org.springframework.web.servlet.handler back to summary

private Class HandlerMappingIntrospector.LookupPathMatchableHandlerMapping

Class Inheritance

extends Object
implements MatchableHandlerMapping

java.lang.Object
org.springframework.web.servlet.handler.HandlerMappingIntrospector.LookupPathMatchableHandlerMapping

All Implemented Interfaces

org.springframework.web.servlet.handler.MatchableHandlerMapping, org.springframework.web.servlet.HandlerMapping

Field Summary

Modifier and Type	Field and Description
private final MatchableHandlerMapping	delegate
private final Object	lookupPath
private final String	pathAttributeName

Constructor Summary

Access	Constructor and Description
pack-priv	LookupPathMatchableHandlerMapping(MatchableHandlerMapping delegate, Object lookupPath)

Method Summary

Modifier and Type	Method and Description
public HandlerExecutionChain	getHandler(HttpServletRequest current HTTP request request) Implements org.springframework.web.servlet.HandlerMapping.getHandler. Return a handler and any interceptors for this request.
public PathPatternParser	getPatternParser() Overrides default org.springframework.web.servlet.handler.MatchableHandlerMapping.getPatternParser. Return the parser of this `HandlerMapping`, if configured in which case pre-parsed patterns are used.
private String	initFullPathPattern(String pattern)
public RequestMatchResult	match(HttpServletRequest the current request request, String the pattern to match pattern) Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Determine whether the request matches the given pattern.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final MatchableHandlerMapping delegate

lookupPath	back to summary
private final Object lookupPath

pathAttributeName	back to summary
private final String pathAttributeName

Constructor Detail

LookupPathMatchableHandlerMapping	back to summary
pack-priv LookupPathMatchableHandlerMapping(MatchableHandlerMapping delegate, Object lookupPath)

Method Detail

getHandler back to summary

public HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception

Implements org.springframework.web.servlet.HandlerMapping.getHandler.

Doc from org.springframework.web.servlet.HandlerMapping.getHandler.

Return a handler and any interceptors for this request. The choice may be made on request URL, session state, or any factor the implementing class chooses.

The returned HandlerExecutionChain contains a handler Object, rather than even a tag interface, so that handlers are not constrained in any way. For example, a HandlerAdapter could be written to allow another framework's handler objects to be used.

Returns null if no match was found. This is not an error. The DispatcherServlet will query all registered HandlerMapping beans to find a match, and only decide there is an error if none can find a handler.

Parameters

request:HttpServletRequest: current HTTP request

Returns:HandlerExecutionChain

a HandlerExecutionChain instance containing handler object and any interceptors, or null if no mapping found

Annotations

@Nullable
@Override

Exceptions

Exception:: if there is an internal error

getPatternParser back to summary

public PathPatternParser getPatternParser()

Overrides default org.springframework.web.servlet.handler.MatchableHandlerMapping.getPatternParser.

Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.getPatternParser.

Return the parser of this HandlerMapping, if configured in which case pre-parsed patterns are used.

Annotations

@Override

initFullPathPattern	back to summary
private String initFullPathPattern(String pattern)

match back to summary

public RequestMatchResult match(HttpServletRequest request, String pattern)

Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

Determine whether the request matches the given pattern. Use this method when getPatternParser() returns null which means that the HandlerMapping is using String pattern matching.

Parameters

request:HttpServletRequest: the current request
pattern:String: the pattern to match

Returns:RequestMatchResult

the result from request matching, or null if none

Annotations

@Nullable
@Override

public Class HandlerMappingIntrospector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HandlerMappingIntrospector.AttributesPreservingRequest

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class HandlerMappingIntrospector.CachedResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HandlerMappingIntrospector.CacheResultLogHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class HandlerMappingIntrospector.LookupPathMatchableHandlerMapping

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail