Package com.vaadin.flow.spring

Class SpringServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
com.vaadin.flow.server.VaadinServlet
com.vaadin.flow.spring.SpringServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public class SpringServlet extends com.vaadin.flow.server.VaadinServlet
Spring application context aware Vaadin servlet implementation.

This class is not intended to be used directly. It's instantiated automatically by the Spring add-on:

Author:
Vaadin Ltd
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    PROPERTY_NAMES
    Property names that are read from the application.properties file

    Fields inherited from class com.vaadin.flow.server.VaadinServlet

    INTERNAL_VAADIN_SERVLET_VITE_DEV_MODE_FRONTEND_PATH

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpringServlet(org.springframework.context.ApplicationContext context, boolean rootMapping)
    Creates a new Vaadin servlet instance with the application context provided.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.vaadin.flow.function.DeploymentConfiguration
    createDeploymentConfiguration(Properties initParameters)
     
    protected com.vaadin.flow.server.VaadinServletService
    createServletService(com.vaadin.flow.function.DeploymentConfiguration deploymentConfiguration)
     
    protected void
    service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     

    Methods inherited from class com.vaadin.flow.server.VaadinServlet

    createDeploymentConfiguration, createServletService, createStaticFileHandler, createVaadinRequest, destroy, getCurrent, getFrontendMapping, getLastPathParameter, getService, getServletConfig, handleContextOrServletRootWithoutSlash, init, serveStaticOrWebJarRequest, servletInitialized, whenFrontendMappingAvailable

    Methods inherited from class jakarta.servlet.http.HttpServlet

    doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, isSensitiveHeader, service

    Methods inherited from class jakarta.servlet.GenericServlet

    getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PROPERTY_NAMES

      protected static final List<String> PROPERTY_NAMES
      Property names that are read from the application.properties file

  • Constructor Details

    • SpringServlet

      public SpringServlet(org.springframework.context.ApplicationContext context, boolean rootMapping)
      Creates a new Vaadin servlet instance with the application context provided.

      Use true as a value for forwardingEnforced parameter if your servlet is mapped to the root ("/*"). In the case of root mapping a RootMappedCondition is checked and VaadinServletConfiguration is applied conditionally. This configuration provide a ServletForwardingController so that other Spring endpoints may co-exist with Vaadin application (it's required since root mapping handles any request to the context). This is not needed if you are using non-root mapping since are you free to use the mapping which doesn't overlap with any endpoint mapping. In this case use false for the forwardingEnforced parameter.

      Parameters:
      context - the Spring application context
      rootMapping - the incoming HttpServletRequest is wrapped in ForwardingRequestWrapper if true

  • Method Details

    • service

      protected void service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws jakarta.servlet.ServletException, IOException
      Overrides:
      service in class com.vaadin.flow.server.VaadinServlet
      Throws:
      jakarta.servlet.ServletException
      IOException

    • createServletService

      protected com.vaadin.flow.server.VaadinServletService createServletService(com.vaadin.flow.function.DeploymentConfiguration deploymentConfiguration) throws com.vaadin.flow.server.ServiceException
      Overrides:
      createServletService in class com.vaadin.flow.server.VaadinServlet
      Throws:
      com.vaadin.flow.server.ServiceException

    • createDeploymentConfiguration

      protected com.vaadin.flow.function.DeploymentConfiguration createDeploymentConfiguration(Properties initParameters)
      Overrides:
      createDeploymentConfiguration in class com.vaadin.flow.server.VaadinServlet