org.springframework.boot.web.servlet.support

Class SpringBootServletInitializer

java.lang.Object

org.springframework.boot.web.servlet.support.SpringBootServletInitializer

All Implemented Interfaces:

org.springframework.web.WebApplicationInitializer

Direct Known Subclasses:

SpringApplicationWebApplicationInitializer

public abstract class SpringBootServletInitializer
extends Object
implements org.springframework.web.WebApplicationInitializer

An opinionated WebApplicationInitializer to run a SpringApplication from a traditional WAR deployment. Binds Servlet, Filter and ServletContextInitializer beans from the application context to the server.

To configure the application either override the configure(SpringApplicationBuilder) method (calling SpringApplicationBuilder.sources(Class...)) or make the initializer itself a @Configuration. If you are using SpringBootServletInitializer in combination with other WebApplicationInitializers you might also want to add an @Ordered annotation to configure a specific startup order.

Note that a WebApplicationInitializer is only needed if you are building a war file and deploying it. If you prefer to run an embedded web server then you won't need this at all.

Since:

2.0.0

Author:

Dave Syer, Phillip Webb, Andy Wilkinson

See Also:

configure(SpringApplicationBuilder)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
SpringBootServletInitializer()

Method Summary

Modifier and Type	Method and Description
protected SpringApplicationBuilder	configure(SpringApplicationBuilder builder) Configure the application.
protected org.springframework.web.context.WebApplicationContext	createRootApplicationContext(javax.servlet.ServletContext servletContext)
protected SpringApplicationBuilder	createSpringApplicationBuilder() Returns the SpringApplicationBuilder that is used to configure and create the SpringApplication.
void	onStartup(javax.servlet.ServletContext servletContext)
protected org.springframework.web.context.WebApplicationContext	run(SpringApplication application) Called to run a fully configured SpringApplication.
protected void	setRegisterErrorPageFilter(boolean registerErrorPageFilter) Set if the ErrorPageFilter should be registered.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.apache.commons.logging.Log logger

Constructor Detail

SpringBootServletInitializer

public SpringBootServletInitializer()

Method Detail

setRegisterErrorPageFilter

protected final void setRegisterErrorPageFilter(boolean registerErrorPageFilter)

Set if the ErrorPageFilter should be registered. Set to false if error page mappings should be handled via the server and not Spring Boot.

Parameters:

registerErrorPageFilter - if the ErrorPageFilter should be registered.

onStartup

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

Specified by:

onStartup in interface org.springframework.web.WebApplicationInitializer

Throws:

javax.servlet.ServletException

createRootApplicationContext

protected org.springframework.web.context.WebApplicationContext createRootApplicationContext(javax.servlet.ServletContext servletContext)

createSpringApplicationBuilder

protected SpringApplicationBuilder createSpringApplicationBuilder()

Returns the SpringApplicationBuilder that is used to configure and create the SpringApplication. The default implementation returns a new SpringApplicationBuilder in its default state.

Returns:

the SpringApplicationBuilder.

Since:

1.3.0

run

protected org.springframework.web.context.WebApplicationContext run(SpringApplication application)

Called to run a fully configured SpringApplication.

Parameters:

application - the application to run

Returns:

the WebApplicationContext

configure

protected SpringApplicationBuilder configure(SpringApplicationBuilder builder)

Configure the application. Normally all you would need to do is to add sources (e.g. config classes) because other settings have sensible defaults. You might choose (for instance) to add default command line arguments, or set an active Spring profile.

Parameters:

builder - a builder for the application context

Returns:

the application builder

See Also:

SpringApplicationBuilder