Package com.vaadin.flow.spring

Class VaadinServletContextInitializer

java.lang.Object

com.vaadin.flow.spring.VaadinServletContextInitializer

All Implemented Interfaces:

org.springframework.boot.web.servlet.ServletContextInitializer

public class VaadinServletContextInitializer
extends Object
implements org.springframework.boot.web.servlet.ServletContextInitializer

Servlet context initializer for Spring Boot Application.

If Java application is used to run Spring Boot then it doesn't run registered ServletContainerInitializers (e.g. to scan for Route annotations in the classpath). This class enables this scanning via Spring so that the functionality which relies on ServletContainerInitializer works in the same way as in deployable WAR file.

Since:

10.0

See Also:

• ServletContainerInitializer
• RouteRegistry

Constructor Summary

Constructors

Constructor	Description
VaadinServletContextInitializer(org.springframework.context.ApplicationContext context)	Creates a new ServletContextInitializer instance with application context provided.

Method Summary

Modifier and Type	Method	Description
protected Set<Class<?>>	findClassesForDevMode(Set<String> basePackages, List<Class<? extends Annotation>> annotations, List<Class<?>> superTypes)	Scans the given packages for the classes development mode needs, which is a wider set than what a production build scans for.
void	onStartup(jakarta.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Constructor Details

VaadinServletContextInitializer

public VaadinServletContextInitializer(org.springframework.context.ApplicationContext context)

Creates a new ServletContextInitializer instance with application context provided.

Parameters:

context - the application context

Method Details

findClassesForDevMode

protected Set<Class<?>> findClassesForDevMode(Set<String> basePackages,
 List<Class<? extends Annotation>> annotations,
 List<Class<?>> superTypes)

Scans the given packages for the classes development mode needs, which is a wider set than what a production build scans for.

Parameters:

basePackages - the packages to scan

annotations - the annotations a matching class is annotated with

superTypes - the types a matching class extends or implements

Returns:

the classes found, never null

Since:

24.5

onStartup

public void onStartup(jakarta.servlet.ServletContext servletContext)
               throws jakarta.servlet.ServletException

Specified by:

onStartup in interface org.springframework.boot.web.servlet.ServletContextInitializer

Throws:

jakarta.servlet.ServletException