org.vaadin.spring.boot.config

Class VaadinServletConfiguration

java.lang.Object

org.vaadin.spring.boot.config.VaadinServletConfiguration

All Implemented Interfaces:

InitializingBean

@Configuration
public class VaadinServletConfiguration
extends Object

Spring configuration that sets up a SpringAwareVaadinServlet. If you want to customize the servlet, extend it and make it available as a Spring bean.

Author:

Petter Holmström (petter@vaadin.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVLET_URL_MAPPING
static String	SERVLET_CONFIGURATION_PARAMETER_PREFIX Prefix to be used for all Spring environment properties that configure the Vaadin servlet.
static String	SERVLET_URL_MAPPING_PARAMETER_NAME Name of the Spring environment property that contains the URL mapping of the Vaadin servlet.

Constructor Summary

Constructors

Constructor and Description
VaadinServletConfiguration()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected javax.servlet.http.HttpServlet	createServlet()
protected org.springframework.boot.context.embedded.ServletRegistrationBean	createServletRegistrationBean()
protected org.slf4j.Logger	getLogger()
protected Class<? extends javax.servlet.http.HttpServlet>	getServletClass()
protected String	getServletConfigurationParameterPrefix()
protected String	getUrlMapping()

Methods inherited from class java.lang.Object

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

Field Detail

SERVLET_CONFIGURATION_PARAMETER_PREFIX

public static final String SERVLET_CONFIGURATION_PARAMETER_PREFIX

Prefix to be used for all Spring environment properties that configure the Vaadin servlet. The full format of the environment property name is [prefix][initParameter] where [prefix] is "vaadin.servlet.params." and initParameter is the name of one of the parameters defined in VaadinServletConfiguration.

For example, to change the production mode of the servlet, a property named "vaadin.servlet.params."productionMode would be used.

See Also:

Environment, Constant Field Values

SERVLET_URL_MAPPING_PARAMETER_NAME

public static final String SERVLET_URL_MAPPING_PARAMETER_NAME

Name of the Spring environment property that contains the URL mapping of the Vaadin servlet. By default, this mapping is /*.

See Also:

Constant Field Values

DEFAULT_SERVLET_URL_MAPPING

public static final String DEFAULT_SERVLET_URL_MAPPING

See Also:

Constant Field Values

Constructor Detail

VaadinServletConfiguration

public VaadinServletConfiguration()

Method Detail

getServletConfigurationParameterPrefix

protected String getServletConfigurationParameterPrefix()

getServletClass

protected Class<? extends javax.servlet.http.HttpServlet> getServletClass()

getLogger

protected org.slf4j.Logger getLogger()

getUrlMapping

protected String getUrlMapping()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

createServlet

protected javax.servlet.http.HttpServlet createServlet()

createServletRegistrationBean

protected org.springframework.boot.context.embedded.ServletRegistrationBean createServletRegistrationBean()