Package com.vaadin.flow.spring

Class SpringServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.vaadin.flow.server.VaadinServlet

com.vaadin.flow.spring.SpringServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SpringServlet
extends 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:

• Spring boot does this via SpringBootAutoConfiguration.
• In case of using Spring MVC just extends VaadinMVCWebAppInitializer.

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static 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

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 DeploymentConfiguration	createDeploymentConfiguration(Properties initParameters)
protected VaadinServletService	createServletService(DeploymentConfiguration deploymentConfiguration)
protected void	service(javax.servlet.http.HttpServletRequest request, javax.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

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.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 Detail

PROPERTY_NAMES

protected static final List<String> PROPERTY_NAMES

Property names that are read from the application.properties file

Constructor Detail

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 Detail

service

protected void service(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       IOException

Overrides:

service in class VaadinServlet

Throws:

javax.servlet.ServletException

IOException

createServletService

protected VaadinServletService createServletService(DeploymentConfiguration deploymentConfiguration)
                                             throws ServiceException

Overrides:

createServletService in class VaadinServlet

Throws:

ServiceException

createDeploymentConfiguration

protected DeploymentConfiguration createDeploymentConfiguration(Properties initParameters)

Overrides:

createDeploymentConfiguration in class VaadinServlet