Class AbstractUrlHandlerMapping

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.reactive.handler.AbstractHandlerMapping
org.springframework.web.reactive.handler.AbstractUrlHandlerMapping
All Implemented Interfaces:
Aware, BeanNameAware, ApplicationContextAware, Ordered, HandlerMapping
Direct Known Subclasses:
SimpleUrlHandlerMapping
public abstract class AbstractUrlHandlerMapping extends AbstractHandlerMapping
Abstract base class for URL-mapped HandlerMapping implementations.

Supports direct matches, for example, a registered "/test" matches "/test", and various path pattern matches, for example, a registered "/t*" pattern matches both "/test" and "/team", "/test/*" matches all paths under "/test", "/test/**" matches all paths below "/test". For details, see the PathPattern javadoc.

Will search all path patterns to find the most specific match for the current request path. The most specific pattern is defined as the longest path pattern with the fewest captured variables and wildcards.

Since:
5.0
Author:
Rossen Stoyanchev, Juergen Hoeller, Brian Clozel

  • Constructor Details

    • AbstractUrlHandlerMapping

      public AbstractUrlHandlerMapping()

  • Method Details

    • setLazyInitHandlers

      public void setLazyInitHandlers(boolean lazyInitHandlers)
      Set whether to lazily initialize handlers. Only applicable to singleton handlers, as prototypes are always lazily initialized. Default is "false", as eager initialization allows for more efficiency through referencing the controller objects directly.

      If you want to allow your controllers to be lazily initialized, make them "lazy-init" and set this flag to true. Just making them "lazy-init" will not work, as they are initialized through the references from the handler mapping in this case.

    • getHandlerMap

      public final Map<PathPattern, Object> getHandlerMap()
      Return a read-only view of registered path patterns and handlers which may be an actual handler instance or the bean name of lazily initialized handler.

    • setHandlerPredicate

      public void setHandlerPredicate(BiPredicate<Object, ServerWebExchange> handlerPredicate)
      Configure a predicate for extended matching of the handler that was matched by URL path. This allows for further narrowing of the mapping by checking additional properties of the request. If the predicate returns "false", it result in a no-match, which allows another HandlerMapping to match or result in a 404 (NOT_FOUND) response.
      Parameters:
      handlerPredicate - a bi-predicate to match the candidate handler against the current exchange.
      Since:
      5.3.5
      See Also:

    • getHandlerInternal

      public reactor.core.publisher.Mono<Object> getHandlerInternal(ServerWebExchange exchange)
      Description copied from class: AbstractHandlerMapping
      Look up a handler for the given request, returning an empty Mono if no specific one is found. This method is called by AbstractHandlerMapping.getHandler(ServerWebExchange).

      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.

      Specified by:
      getHandlerInternal in class AbstractHandlerMapping
      Parameters:
      exchange - current exchange
      Returns:
      Mono for the matching handler, if any

    • lookupHandler

      protected @Nullable Object lookupHandler(PathContainer lookupPath, ServerWebExchange exchange) throws Exception
      Look up a handler instance for the given URL lookup path.

      Supports direct matches, for example, a registered "/test" matches "/test", and various path pattern matches, for example, a registered "/t*" matches both "/test" and "/team". For details, see the PathPattern class.

      Parameters:
      lookupPath - the URL the handler is mapped to
      exchange - the current exchange
      Returns:
      the associated handler instance, or null if not found
      Throws:
      Exception
      See Also:

    • validateHandler

      protected void validateHandler(@Nullable Object handler, ServerWebExchange exchange)
      Validate the given handler against the current request.

      The default implementation is empty. Can be overridden in subclasses, for example to enforce specific preconditions expressed in URL mappings.

      Parameters:
      handler - the handler object to validate
      exchange - current exchange

    • registerHandler

      protected void registerHandler(String[] urlPaths, String beanName) throws BeansException, IllegalStateException
      Register the specified handler for the given URL paths.
      Parameters:
      urlPaths - the URLs that the bean should be mapped to
      beanName - the name of the handler bean
      Throws:
      BeansException - if the handler couldn't be registered
      IllegalStateException - if there is a conflicting handler registered

    • registerHandler

      protected void registerHandler(String urlPath, Object handler) throws BeansException, IllegalStateException
      Register the specified handler for the given URL path.
      Parameters:
      urlPath - the URL the bean should be mapped to
      handler - the handler instance or handler bean name String (a bean name will automatically be resolved into the corresponding handler bean)
      Throws:
      BeansException - if the handler couldn't be registered
      IllegalStateException - if there is a conflicting handler registered