Class AbstractHandlerMapping

Constructor Detail

• AbstractHandlerMapping

  public AbstractHandlerMapping()

Method Detail

• setDefaultHandler

  public void setDefaultHandler​(Object defaultHandler)

  Set the default handler for this handler mapping. This handler will be returned if no specific mapping was found.

  Default is null, indicating no default handler.

• getDefaultHandler

  public Object getDefaultHandler()

  Return the default handler for this handler mapping, or null if none.

• setAlwaysUseFullPath

  public void setAlwaysUseFullPath​(boolean alwaysUseFullPath)

  Set if URL lookup should always use the full path within the current servlet context. Else, the path within the current servlet mapping is used if applicable (that is, in the case of a ".../*" servlet mapping in web.xml).

  Default is "false".

  See Also:

  UrlPathHelper.setAlwaysUseFullPath(boolean)

• setUrlDecode

  public void setUrlDecode​(boolean urlDecode)

  Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

  Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

  See Also:

  UrlPathHelper.setUrlDecode(boolean)

• setRemoveSemicolonContent

  public void setRemoveSemicolonContent​(boolean removeSemicolonContent)

  Set if ";" (semicolon) content should be stripped from the request URI.

  The default value is true.

  See Also:

  UrlPathHelper.setRemoveSemicolonContent(boolean)

• setUrlPathHelper

  public void setUrlPathHelper​(UrlPathHelper urlPathHelper)

  Set the UrlPathHelper to use for resolution of lookup paths.

  Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple HandlerMappings and MethodNameResolvers.

• getUrlPathHelper

  public UrlPathHelper getUrlPathHelper()

  Return the UrlPathHelper implementation to use for resolution of lookup paths.

• setPathMatcher

  public void setPathMatcher​(PathMatcher pathMatcher)

  Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

  See Also:

  AntPathMatcher

• getPathMatcher

  public PathMatcher getPathMatcher()

  Return the PathMatcher implementation to use for matching URL paths against registered URL patterns.

• setInterceptors

  public void setInterceptors​(Object... interceptors)

  Set the interceptors to apply for all handlers mapped by this handler mapping.

  Supported interceptor types are HandlerInterceptor, WebRequestInterceptor, and MappedInterceptor. Mapped interceptors apply only to request URLs that match its path patterns. Mapped interceptor beans are also detected by type during initialization.

  Parameters:

  interceptors - array of handler interceptors

  See Also:

  adaptInterceptor(java.lang.Object), HandlerInterceptor, WebRequestInterceptor

• setCorsConfigurations

  public void setCorsConfigurations​(Map<String,​CorsConfiguration> corsConfigurations)

  Set the "global" CORS configurations based on URL patterns. By default the first matching URL pattern is combined with the CORS configuration for the handler, if any.

  Since:

  4.2

• getCorsConfigurations

  public Map<String,​CorsConfiguration> getCorsConfigurations()

  Get the "global" CORS configurations.

• setCorsProcessor

  public void setCorsProcessor​(CorsProcessor corsProcessor)

  Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.

  By default DefaultCorsProcessor is used.

  Since:

  4.2

• getCorsProcessor

  public CorsProcessor getCorsProcessor()

  Return the configured CorsProcessor.

• setOrder

  public void setOrder​(int order)

  Specify the order value for this HandlerMapping bean.

  The default value is Ordered.LOWEST_PRECEDENCE, meaning non-ordered.

  See Also:

  Ordered.getOrder()

• getOrder

  public int getOrder()

  Description copied from interface: Ordered
  Get the order value of this object.

  Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

  Same order values will result in arbitrary sort positions for the affected objects.

  Specified by:

  getOrder in interface Ordered

  Returns:

  the order value

  See Also:

  Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE

• initApplicationContext

  protected void initApplicationContext()
                                 throws BeansException

  Initializes the interceptors.

  Overrides:

  initApplicationContext in class ApplicationObjectSupport

  Throws:

  ApplicationContextException - in case of initialization errors

  BeansException - if thrown by ApplicationContext methods

  See Also:

  extendInterceptors(java.util.List), initInterceptors()

• extendInterceptors

  protected void extendInterceptors​(List<Object> interceptors)

  Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see setInterceptors(java.lang.Object...)).

  Will be invoked before initInterceptors() adapts the specified interceptors into HandlerInterceptor instances.

  The default implementation is empty.

  Parameters:

  interceptors - the configured interceptor List (never null), allowing to add further interceptors before as well as after the existing interceptors

• detectMappedInterceptors

  protected void detectMappedInterceptors​(List<HandlerInterceptor> mappedInterceptors)

  Detect beans of type MappedInterceptor and add them to the list of mapped interceptors.

  This is called in addition to any MappedInterceptors that may have been provided via setInterceptors(java.lang.Object...), by default adding all beans of type MappedInterceptor from the current context and its ancestors. Subclasses can override and refine this policy.

  Parameters:

  mappedInterceptors - an empty list to add to

• initInterceptors

  protected void initInterceptors()

  Initialize the specified interceptors adapting WebRequestInterceptors to HandlerInterceptor.

  See Also:

  setInterceptors(java.lang.Object...), adaptInterceptor(java.lang.Object)

• adaptInterceptor

  protected HandlerInterceptor adaptInterceptor​(Object interceptor)

  Adapt the given interceptor object to HandlerInterceptor.

  By default, the supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor is wrapped with WebRequestHandlerInterceptorAdapter.

  Parameters:

  interceptor - the interceptor

  Returns:

  the interceptor downcast or adapted to HandlerInterceptor

  See Also:

  HandlerInterceptor, WebRequestInterceptor, WebRequestHandlerInterceptorAdapter

• getAdaptedInterceptors

  protected final HandlerInterceptor[] getAdaptedInterceptors()

  Return the adapted interceptors as HandlerInterceptor array.

  Returns:

  the array of HandlerInterceptors, or null if none

• getMappedInterceptors

  protected final MappedInterceptor[] getMappedInterceptors()

  Return all configured MappedInterceptors as an array.

  Returns:

  the array of MappedInterceptors, or null if none

• getHandler

  public final HandlerExecutionChain getHandler​(HttpServletRequest request)
                                         throws Exception

  Look up a handler for the given request, falling back to the default handler if no specific one is found.

  Specified by:

  getHandler in interface HandlerMapping

  Parameters:

  request - current HTTP request

  Returns:

  the corresponding handler instance, or the default handler

  Throws:

  Exception - if there is an internal error

  See Also:

  getHandlerInternal(javax.servlet.http.HttpServletRequest)

• getHandlerInternal

  protected abstract Object getHandlerInternal​(HttpServletRequest request)
                                        throws Exception

  Look up a handler for the given request, returning null if no specific one is found. This method is called by getHandler(javax.servlet.http.HttpServletRequest); a null return value will lead to the default handler, if one is set.

  On CORS pre-flight requests this method should return a match not for the pre-flight request but for the expected actual request based on the URL path, the HTTP methods from the "Access-Control-Request-Method" header, and the headers from the "Access-Control-Request-Headers" header thus allowing the CORS configuration to be obtained via getCorsConfigurations(),

  Note: This method may also return a pre-built HandlerExecutionChain, combining a handler object with dynamically determined interceptors. Statically specified interceptors will get merged into such an existing chain.

  Parameters:

  request - current HTTP request

  Returns:

  the corresponding handler instance, or null if none found

  Throws:

  Exception - if there is an internal error

• getHandlerExecutionChain

  protected HandlerExecutionChain getHandlerExecutionChain​(Object handler,
                                                           HttpServletRequest request)

  Build a HandlerExecutionChain for the given handler, including applicable interceptors.

  The default implementation builds a standard HandlerExecutionChain with the given handler, the common interceptors of the handler mapping, and any MappedInterceptors matching to the current request URL. Interceptors are added in the order they were registered. Subclasses may override this in order to extend/rearrange the list of interceptors.

  NOTE: The passed-in handler object may be a raw handler or a pre-built HandlerExecutionChain. This method should handle those two cases explicitly, either building a new HandlerExecutionChain or extending the existing chain.

  For simply adding an interceptor in a custom subclass, consider calling super.getHandlerExecutionChain(handler, request) and invoking HandlerExecutionChain.addInterceptor(org.springframework.web.servlet.HandlerInterceptor) on the returned chain object.

  Parameters:

  handler - the resolved handler instance (never null)

  request - current HTTP request

  Returns:

  the HandlerExecutionChain (never null)

  See Also:

  getAdaptedInterceptors()

• getCorsConfiguration

  protected CorsConfiguration getCorsConfiguration​(Object handler,
                                                   HttpServletRequest request)

  Retrieve the CORS configuration for the given handler.

  Parameters:

  handler - the handler to check (never null).

  request - the current request.

  Returns:

  the CORS configuration for the handler, or null if none

  Since:

  4.2

• getCorsHandlerExecutionChain

  protected HandlerExecutionChain getCorsHandlerExecutionChain​(HttpServletRequest request,
                                                               HandlerExecutionChain chain,
                                                               CorsConfiguration config)

  Update the HandlerExecutionChain for CORS-related handling.

  For pre-flight requests, the default implementation replaces the selected handler with a simple HttpRequestHandler that invokes the configured setCorsProcessor(org.springframework.web.cors.CorsProcessor).

  For actual requests, the default implementation inserts a HandlerInterceptor that makes CORS-related checks and adds CORS headers.

  Parameters:

  request - the current request

  chain - the handler chain

  config - the applicable CORS configuration (possibly null)

  Since:

  4.2