org.springframework.boot.context.embedded

Class EmbeddedWebApplicationContext

java.lang.Object

GenericWebApplicationContext

org.springframework.boot.context.embedded.EmbeddedWebApplicationContext

Direct Known Subclasses:

AnnotationConfigEmbeddedWebApplicationContext, XmlEmbeddedWebApplicationContext

public class EmbeddedWebApplicationContext
extends GenericWebApplicationContext

A WebApplicationContext that can be used to bootstrap itself from a contained EmbeddedServletContainerFactory bean.

This context will create, initialize and run an EmbeddedServletContainer by searching for a single EmbeddedServletContainerFactory bean within the ApplicationContext itself. The EmbeddedServletContainerFactory is free to use standard Spring concepts (such as dependency injection, lifecycle callbacks and property placeholder variables).

In addition, any Servlet or Filter beans defined in the context will be automatically registered with the embedded Servlet container. In the case of a single Servlet bean, the '/' mapping will be used. If multiple Servlet beans are found then the lowercase bean name will be used as a mapping prefix. Any Servlet named 'dispatcherServlet' will always be mapped to '/'. Filter beans will be mapped to all URLs ('/*').

For more advanced configuration, the context can instead define beans that implement the ServletContextInitializer interface (most often ServletRegistrationBeans and/or FilterRegistrationBeans). To prevent double registration, the use of ServletContextInitializer beans will disable automatic Servlet and Filter bean registration.

Although this context can be used directly, most developers should consider using the AnnotationConfigEmbeddedWebApplicationContext or XmlEmbeddedWebApplicationContext variants.

Author:

Phillip Webb, Dave Syer

See Also:

AnnotationConfigEmbeddedWebApplicationContext, XmlEmbeddedWebApplicationContext, EmbeddedServletContainerFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedWebApplicationContext.ExistingWebApplicationScopes Utility class to store and restore any user defined scopes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPATCHER_SERVLET_NAME Constant value for the DispatcherServlet bean name.

Constructor Summary

Constructors

Constructor and Description
EmbeddedWebApplicationContext()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doClose()
protected void	finishRefresh()
EmbeddedServletContainer	getEmbeddedServletContainer() Returns the EmbeddedServletContainer that was created by the context or null if the container has not yet been created.
protected EmbeddedServletContainerFactory	getEmbeddedServletContainerFactory() Returns the EmbeddedServletContainerFactory that should be used to create the embedded servlet container.
String	getNamespace()
protected Resource	getResourceByPath(String path)
ServletConfig	getServletConfig()
protected Collection<ServletContextInitializer>	getServletContextInitializerBeans() Returns ServletContextInitializers that should be used with the embedded Servlet context.
protected void	onRefresh()
protected void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Register ServletContextAwareProcessor.
protected void	prepareEmbeddedWebApplicationContext(ServletContext servletContext) Prepare the WebApplicationContext with the given fully loaded ServletContext.
void	refresh()
void	setNamespace(String namespace)
void	setServletConfig(ServletConfig servletConfig)

Methods inherited from class java.lang.Object

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

Field Detail

DISPATCHER_SERVLET_NAME

public static final String DISPATCHER_SERVLET_NAME

Constant value for the DispatcherServlet bean name. A Servlet bean with this name is deemed to be the "main" servlet and is automatically given a mapping of "/" by default. To change the default behaviour you can use a ServletRegistrationBean or a different bean name.

See Also:

Constant Field Values

Constructor Detail

EmbeddedWebApplicationContext

public EmbeddedWebApplicationContext()

Method Detail

postProcessBeanFactory

protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)

Register ServletContextAwareProcessor.

See Also:

ServletContextAwareProcessor

refresh

public final void refresh()
                   throws BeansException,
                          IllegalStateException

Throws:

BeansException

IllegalStateException

onRefresh

protected void onRefresh()

finishRefresh

protected void finishRefresh()

doClose

protected void doClose()

getEmbeddedServletContainerFactory

protected EmbeddedServletContainerFactory getEmbeddedServletContainerFactory()

Returns the EmbeddedServletContainerFactory that should be used to create the embedded servlet container. By default this method searches for a suitable bean in the context itself.

Returns:

a EmbeddedServletContainerFactory (never null)

getServletContextInitializerBeans

protected Collection<ServletContextInitializer> getServletContextInitializerBeans()

Returns ServletContextInitializers that should be used with the embedded Servlet context. By default this method will first attempt to find ServletContextInitializer, Servlet, Filter and certain EventListener beans.

prepareEmbeddedWebApplicationContext

protected void prepareEmbeddedWebApplicationContext(ServletContext servletContext)

Prepare the WebApplicationContext with the given fully loaded ServletContext. This method is usually called from ServletContextInitializer.onStartup(ServletContext) and is similar to the functionality usually provided by a ContextLoaderListener.

Parameters:

servletContext - the operational servlet context

getResourceByPath

protected Resource getResourceByPath(String path)

setNamespace

public void setNamespace(String namespace)

getNamespace

public String getNamespace()

setServletConfig

public void setServletConfig(ServletConfig servletConfig)

getServletConfig

public ServletConfig getServletConfig()

getEmbeddedServletContainer

public EmbeddedServletContainer getEmbeddedServletContainer()

Returns the EmbeddedServletContainer that was created by the context or null if the container has not yet been created.