Package com.vaadin.flow.spring

Class SpringBootAutoConfiguration

java.lang.Object

com.vaadin.flow.spring.SpringBootAutoConfiguration

@AutoConfiguration(before=org.springframework.boot.webmvc.autoconfigure.WebMvcAutoConfiguration.class)
@ConditionalOnClass(org.springframework.boot.web.servlet.ServletContextInitializer.class)
@EnableConfigurationProperties(VaadinConfigurationProperties.class)
public class SpringBootAutoConfiguration
extends Object

Spring boot auto-configuration class for Flow.

Since:

10.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor	Description
SpringBootAutoConfiguration()	Creates the auto configuration.

Method Summary

Modifier and Type	Method	Description
static org.springframework.boot.web.servlet.ServletRegistrationBean<SpringServlet>	configureServletRegistrationBean(org.springframework.beans.factory.ObjectProvider<jakarta.servlet.MultipartConfigElement> multipartConfig, VaadinConfigurationProperties configurationProperties, SpringServlet servletInstance)	Configures a servlet registration for the given Vaadin servlet instance, so that an application providing its own servlet bean gets the same url mapping, push mapping and multipart setup as the default one.
org.springframework.boot.web.servlet.ServletContextInitializer	contextInitializer()	Creates a ServletContextInitializer instance.
org.springframework.boot.web.servlet.ServletRegistrationBean<SpringServlet>	servletRegistrationBean(org.springframework.beans.factory.ObjectProvider<jakarta.servlet.MultipartConfigElement> multipartConfig, VaadinConfigurationProperties configurationProperties)	Creates a ServletRegistrationBean instance with Spring aware Vaadin servlet.
org.springframework.web.socket.server.standard.ServerEndpointExporter	websocketEndpointDeployer()	Deploys JSR-356 websocket endpoints when Atmosphere is available.

Methods inherited from class java.lang.Object

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

Constructor Details

SpringBootAutoConfiguration

public SpringBootAutoConfiguration()

Creates the auto configuration. Spring instantiates it.

Method Details

contextInitializer

@Bean
public org.springframework.boot.web.servlet.ServletContextInitializer contextInitializer()

Creates a ServletContextInitializer instance.

Returns:

a custom ServletContextInitializer instance

servletRegistrationBean

@Bean
@ConditionalOnMissingBean(value=SpringServlet.class,
                          parameterizedContainer=org.springframework.boot.web.servlet.ServletRegistrationBean.class)
public org.springframework.boot.web.servlet.ServletRegistrationBean<SpringServlet> servletRegistrationBean(org.springframework.beans.factory.ObjectProvider<jakarta.servlet.MultipartConfigElement> multipartConfig,
 VaadinConfigurationProperties configurationProperties)

Creates a ServletRegistrationBean instance with Spring aware Vaadin servlet.

Parameters:

multipartConfig - multipart configuration, if available

configurationProperties - the vaadin configuration properties

Returns:

a custom ServletRegistrationBean instance

Since:

23.0.1

configureServletRegistrationBean

public static org.springframework.boot.web.servlet.ServletRegistrationBean<SpringServlet> configureServletRegistrationBean(org.springframework.beans.factory.ObjectProvider<jakarta.servlet.MultipartConfigElement> multipartConfig,
 VaadinConfigurationProperties configurationProperties,
 SpringServlet servletInstance)

Configures a servlet registration for the given Vaadin servlet instance, so that an application providing its own servlet bean gets the same url mapping, push mapping and multipart setup as the default one.

Parameters:

multipartConfig - multipart configuration, if available

configurationProperties - the vaadin configuration properties

servletInstance - the servlet to register

Returns:

the configured registration bean

Since:

24.5.1

websocketEndpointDeployer

@Bean
public org.springframework.web.socket.server.standard.ServerEndpointExporter websocketEndpointDeployer()

Deploys JSR-356 websocket endpoints when Atmosphere is available.

Returns:

the server endpoint exporter which does the actual work.