org.springframework.web.reactive.handler

Class 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, e.g. a registered "/test" matches "/test", and various path pattern matches, e.g. 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 Detail

      • AbstractUrlHandlerMapping

        public AbstractUrlHandlerMapping()
    • Method Detail

      • 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 java.util.Map<PathPattern,java.lang.Object> getHandlerMap()
        Return a read-only view of registered path patterns and handlers which may may be an actual handler instance or the bean name of lazily initialized handler.
      • getHandlerInternal

        public reactor.core.publisher.Mono<java.lang.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(org.springframework.web.server.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

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

        Supports direct matches, e.g. a registered "/test" matches "/test", and various path pattern matches, e.g. 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:
        java.lang.Exception
        See Also:
        PathPattern
      • validateHandler

        protected void validateHandler(java.lang.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(java.lang.String[] urlPaths,
                                       java.lang.String beanName)
                                throws BeansException,
                                       java.lang.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
        java.lang.IllegalStateException - if there is a conflicting handler registered
      • registerHandler

        protected void registerHandler(java.lang.String urlPath,
                                       java.lang.Object handler)
                                throws BeansException,
                                       java.lang.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
        java.lang.IllegalStateException - if there is a conflicting handler registered