org.springframework.boot.context.web

Class SpringBootServletInitializer

java.lang.Object

org.springframework.boot.context.web.SpringBootServletInitializer

public abstract class SpringBootServletInitializer
extends Object

A handy opinionated WebApplicationInitializer for applications that starts a Spring Boot application and lets it bind to the servlet and filter mappings. If your application is more complicated consider using one of the other WebApplicationInitializers.

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

Author:

Dave Syer

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

Methods

Modifier and Type	Method and Description
protected SpringApplicationBuilder	configure(SpringApplicationBuilder application) Configure the application.
protected WebApplicationContext	createRootApplicationContext(ServletContext servletContext)
void	onStartup(ServletContext servletContext)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

SpringBootServletInitializer

public SpringBootServletInitializer()

Method Detail

onStartup

public void onStartup(ServletContext servletContext)
               throws ServletException

Throws:

ServletException

createRootApplicationContext

protected WebApplicationContext createRootApplicationContext(ServletContext servletContext)

configure

protected SpringApplicationBuilder configure(SpringApplicationBuilder application)

Configure the application. Normally all you would need to do it 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:

application - a builder for the application context

See Also:

SpringApplicationBuilder