Package com.vaadin.flow.spring

Class VaadinServletConfiguration.RootExcludeHandler

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.context.support.WebApplicationObjectSupport
org.springframework.web.servlet.handler.AbstractHandlerMapping
org.springframework.web.servlet.handler.AbstractUrlHandlerMapping
org.springframework.web.servlet.handler.SimpleUrlHandlerMapping
com.vaadin.flow.spring.VaadinServletConfiguration.RootExcludeHandler
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.handler.MatchableHandlerMapping, org.springframework.web.servlet.HandlerMapping
Enclosing class:
VaadinServletConfiguration
public static class VaadinServletConfiguration.RootExcludeHandler extends org.springframework.web.servlet.handler.SimpleUrlHandlerMapping
Handler mapping that forwards everything to Vaadin except the URLs the application excluded and the requests a static resource handler answers.
Since:
24.0

  • Field Summary

    Fields inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

    mappingsLogger

    Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

    logger

    Fields inherited from interface org.springframework.web.servlet.HandlerMapping

    API_VERSION_ATTRIBUTE, BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    RootExcludeHandler(List<String> excludeUrls, org.springframework.web.servlet.mvc.Controller vaadinForwardingController, org.springframework.web.servlet.HandlerMapping resourceHandlerMapping)
    Creates the handler mapping.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Object
    getHandlerInternal(jakarta.servlet.http.HttpServletRequest request)
     
    protected org.slf4j.Logger
    getLogger()
    Gets the logger of the concrete handler class.

    Methods inherited from class org.springframework.web.servlet.handler.SimpleUrlHandlerMapping

    getUrlMap, initApplicationContext, registerHandlers, setMappings, setUrlMap

    Methods inherited from class org.springframework.web.servlet.handler.AbstractUrlHandlerMapping

    buildPathExposingHandler, exposePathWithinMapping, exposeUriTemplateVariables, getHandlerMap, getPathPatternHandlerMap, getRootHandler, lookupHandler, lookupHandler, match, registerHandler, registerHandler, setLazyInitHandlers, setPatternParser, setRootHandler, supportsTypeLevelMappings, unregisterHandler, validateHandler

    Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

    adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getApiVersionStrategy, getCorsConfiguration, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, hasCorsConfigurationSource, initInterceptors, initLookupPath, setAlwaysUseFullPath, setApiVersionStrategy, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

    Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

    getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

    Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

    getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.springframework.web.servlet.HandlerMapping

    getHandler, usesPathPatterns

    Methods inherited from interface org.springframework.web.servlet.handler.MatchableHandlerMapping

    getPatternParser

  • Constructor Details

    • RootExcludeHandler

      public RootExcludeHandler(List<String> excludeUrls, org.springframework.web.servlet.mvc.Controller vaadinForwardingController, org.springframework.web.servlet.HandlerMapping resourceHandlerMapping)
      Creates the handler mapping.
      Parameters:
      excludeUrls - the URL patterns that must not be forwarded to Vaadin, or null to forward everything
      vaadinForwardingController - the controller that forwards a request to Vaadin
      resourceHandlerMapping - the mapping consulted for static resources before forwarding, or null to skip that check
      Since:
      24.8.1

  • Method Details

    • getHandlerInternal

      protected Object getHandlerInternal(jakarta.servlet.http.HttpServletRequest request) throws Exception
      Overrides:
      getHandlerInternal in class org.springframework.web.servlet.handler.AbstractUrlHandlerMapping
      Throws:
      Exception

    • getLogger

      protected org.slf4j.Logger getLogger()
      Gets the logger of the concrete handler class.
      Returns:
      the logger to use