java.lang.Object
- org.springframework.core.io.DefaultResourceLoader
- - org.springframework.context.support.AbstractApplicationContext
  - - org.springframework.context.support.GenericApplicationContext
    - - org.springframework.web.context.support.GenericWebApplicationContext
      - org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext

All Implemented Interfaces:
Closeable, AutoCloseable, org.springframework.beans.factory.BeanFactory, org.springframework.beans.factory.HierarchicalBeanFactory, org.springframework.beans.factory.ListableBeanFactory, org.springframework.beans.factory.support.BeanDefinitionRegistry, ConfigurableWebServerApplicationContext, WebServerApplicationContext, org.springframework.context.ApplicationContext, org.springframework.context.ApplicationEventPublisher, org.springframework.context.ConfigurableApplicationContext, org.springframework.context.Lifecycle, org.springframework.context.MessageSource, org.springframework.core.AliasRegistry, org.springframework.core.env.EnvironmentCapable, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver, org.springframework.ui.context.ThemeSource, org.springframework.web.context.ConfigurableWebApplicationContext, org.springframework.web.context.WebApplicationContext
Direct Known Subclasses:
AnnotationConfigServletWebServerApplicationContext, XmlServletWebServerApplicationContext
```
public class ServletWebServerApplicationContext
extends org.springframework.web.context.support.GenericWebApplicationContext
implements ConfigurableWebServerApplicationContext
```
A WebApplicationContext that can be used to bootstrap itself from a contained ServletWebServerFactory bean.
This context will create, initialize and run an WebServer by searching for a single ServletWebServerFactory bean within the ApplicationContext itself. The ServletWebServerFactory 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 web server. 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 AnnotationConfigServletWebServerApplicationContext or XmlServletWebServerApplicationContext variants.
See Also:
AnnotationConfigServletWebServerApplicationContext, XmlServletWebServerApplicationContext, ServletWebServerFactory

Nested Class Summary
Nested Classes
Modifier and Type Class Description
static class ServletWebServerApplicationContext.ExistingWebApplicationScopes
Utility class to store and restore any user defined scopes.
- Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader
  org.springframework.core.io.DefaultResourceLoader.ClassPathContextResource

Field Summary
Fields
Modifier and Type Field Description
static String DISPATCHER_SERVLET_NAME
Constant value for the DispatcherServlet bean name.
- Fields inherited from class org.springframework.context.support.AbstractApplicationContext
  APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, MESSAGE_SOURCE_BEAN_NAME
- Fields inherited from interface org.springframework.beans.factory.BeanFactory
  FACTORY_BEAN_PREFIX
- Fields inherited from interface org.springframework.context.ConfigurableApplicationContext
  CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME
- Fields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext
  APPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAME
- Fields inherited from interface org.springframework.core.io.ResourceLoader
  CLASSPATH_URL_PREFIX
- Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver
  CLASSPATH_ALL_URL_PREFIX
- Fields inherited from interface org.springframework.web.context.WebApplicationContext
  CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME

Constructor Summary

Constructors
Constructor	Description
`ServletWebServerApplicationContext()`	Create a new `ServletWebServerApplicationContext`.
`ServletWebServerApplicationContext(org.springframework.beans.factory.support.DefaultListableBeanFactory beanFactory)`	Create a new `ServletWebServerApplicationContext` with the given `DefaultListableBeanFactory`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`finishRefresh()`
`protected org.springframework.core.io.Resource`	`getResourceByPath(String path)`
`String`	`getServerNamespace()`	Returns the namespace of the web server application context or `null` if no namespace has been set.
`javax.servlet.ServletConfig`	`getServletConfig()`
`protected Collection<ServletContextInitializer>`	`getServletContextInitializerBeans()`	Returns `ServletContextInitializer`s that should be used with the embedded web server.
`WebServer`	`getWebServer()`	Returns the `WebServer` that was created by the context or `null` if the server has not yet been created.
`protected ServletWebServerFactory`	`getWebServerFactory()`	Returns the `ServletWebServerFactory` that should be used to create the embedded `WebServer`.
`protected void`	`onClose()`
`protected void`	`onRefresh()`
`protected void`	`postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)`	Register ServletContextAwareProcessor.
`protected void`	`prepareWebApplicationContext(javax.servlet.ServletContext servletContext)`	Prepare the `WebApplicationContext` with the given fully loaded `ServletContext`.
`void`	`refresh()`
`void`	`setServerNamespace(String serverNamespace)`	Set the server namespace of the context.
`void`	`setServletConfig(javax.servlet.ServletConfig servletConfig)`

Methods inherited from class org.springframework.web.context.support.GenericWebApplicationContext
createEnvironment, getApplicationName, getConfigLocations, getNamespace, getResourcePatternResolver, getServletContext, getTheme, initPropertySources, setConfigLocation, setConfigLocations, setNamespace, setServletContext

Methods inherited from class org.springframework.context.support.GenericApplicationContext
cancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getClassLoader, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, registerAlias, registerBean, registerBean, registerBean, registerBean, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setClassLoader, setParent, setResourceLoader

Methods inherited from class org.springframework.context.support.AbstractApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, assertBeanFactoryActive, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, getAliases, getApplicationListeners, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setEnvironment, setId, start, stop, toString

Methods inherited from class org.springframework.core.io.DefaultResourceLoader
addProtocolResolver, clearResourceCaches, getProtocolResolvers, getResourceCache

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.AliasRegistry
getAliases

Methods inherited from interface org.springframework.context.ApplicationContext
getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

Methods inherited from interface org.springframework.context.ApplicationEventPublisher
publishEvent, publishEvent

Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames

Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext
addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, registerShutdownHook, setEnvironment, setId, setParent

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory

Methods inherited from interface org.springframework.context.Lifecycle
isRunning, start, stop

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory
containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation

Methods inherited from interface org.springframework.context.MessageSource
getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.core.io.ResourceLoader
getClassLoader, getResource

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver
getResources

- 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 behavior you can use a ServletRegistrationBean or a different bean name.
    See Also:
    Constant Field Values
- Constructor Detail
  - ServletWebServerApplicationContext
```
public ServletWebServerApplicationContext()
```
    Create a new ServletWebServerApplicationContext.
  - ServletWebServerApplicationContext
```
public ServletWebServerApplicationContext(org.springframework.beans.factory.support.DefaultListableBeanFactory beanFactory)
```
    Create a new ServletWebServerApplicationContext with the given DefaultListableBeanFactory.
    Parameters:
    beanFactory - the DefaultListableBeanFactory instance to use for this context
- Method Detail
  - postProcessBeanFactory
```
protected void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
```
    Register ServletContextAwareProcessor.
    Overrides:
    postProcessBeanFactory in class org.springframework.web.context.support.GenericWebApplicationContext
    See Also:
    ServletContextAwareProcessor
  - refresh
```
public final void refresh()
                   throws org.springframework.beans.BeansException,
                          IllegalStateException
```
    Specified by:
    refresh in interface org.springframework.context.ConfigurableApplicationContext
    Overrides:
    refresh in class org.springframework.context.support.AbstractApplicationContext
    Throws:
    org.springframework.beans.BeansException
    IllegalStateException
  - onRefresh
```
protected void onRefresh()
```
    Overrides:
    onRefresh in class org.springframework.web.context.support.GenericWebApplicationContext
  - finishRefresh
```
protected void finishRefresh()
```
    Overrides:
    finishRefresh in class org.springframework.context.support.AbstractApplicationContext
  - onClose
```
protected void onClose()
```
    Overrides:
    onClose in class org.springframework.context.support.AbstractApplicationContext
  - getWebServerFactory
```
protected ServletWebServerFactory getWebServerFactory()
```
    Returns the ServletWebServerFactory that should be used to create the embedded WebServer. By default this method searches for a suitable bean in the context itself.
    Returns:
    a ServletWebServerFactory (never null)
  - getServletContextInitializerBeans
```
protected Collection<ServletContextInitializer> getServletContextInitializerBeans()
```
    Returns ServletContextInitializers that should be used with the embedded web server. By default this method will first attempt to find ServletContextInitializer, Servlet, Filter and certain EventListener beans.
    Returns:
    the servlet initializer beans
  - prepareWebApplicationContext
```
protected void prepareWebApplicationContext(javax.servlet.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 org.springframework.core.io.Resource getResourceByPath(String path)
```
    Overrides:
    getResourceByPath in class org.springframework.web.context.support.GenericWebApplicationContext
  - getServerNamespace
```
public String getServerNamespace()
```
    Description copied from interface: WebServerApplicationContext
    Returns the namespace of the web server application context or null if no namespace has been set. Used for disambiguation when multiple web servers are running in the same application (for example a management context running on a different port).
    Specified by:
    getServerNamespace in interface WebServerApplicationContext
    Returns:
    the server namespace
  - setServerNamespace
```
public void setServerNamespace(String serverNamespace)
```
    Description copied from interface: ConfigurableWebServerApplicationContext
    Set the server namespace of the context.
    Specified by:
    setServerNamespace in interface ConfigurableWebServerApplicationContext
    Parameters:
    serverNamespace - the server namespace
    See Also:
    WebServerApplicationContext.getServerNamespace()
  - setServletConfig
```
public void setServletConfig(javax.servlet.ServletConfig servletConfig)
```
    Specified by:
    setServletConfig in interface org.springframework.web.context.ConfigurableWebApplicationContext
    Overrides:
    setServletConfig in class org.springframework.web.context.support.GenericWebApplicationContext
  - getServletConfig
```
public javax.servlet.ServletConfig getServletConfig()
```
    Specified by:
    getServletConfig in interface org.springframework.web.context.ConfigurableWebApplicationContext
    Overrides:
    getServletConfig in class org.springframework.web.context.support.GenericWebApplicationContext
  - getWebServer
```
public WebServer getWebServer()
```
    Returns the WebServer that was created by the context or null if the server has not yet been created.
    Specified by:
    getWebServer in interface WebServerApplicationContext
    Returns:
    the embedded web server

Class ServletWebServerApplicationContext

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

Field Summary

Fields inherited from class org.springframework.context.support.AbstractApplicationContext

Fields inherited from interface org.springframework.beans.factory.BeanFactory

Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

Fields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext

Fields inherited from interface org.springframework.core.io.ResourceLoader

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

Fields inherited from interface org.springframework.web.context.WebApplicationContext

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.context.support.GenericWebApplicationContext

Methods inherited from class org.springframework.context.support.GenericApplicationContext

Methods inherited from class org.springframework.context.support.AbstractApplicationContext

Methods inherited from class org.springframework.core.io.DefaultResourceLoader

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.core.AliasRegistry

Methods inherited from interface org.springframework.context.ApplicationContext

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry

Methods inherited from interface org.springframework.beans.factory.BeanFactory

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory

Methods inherited from interface org.springframework.context.Lifecycle

Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory

Methods inherited from interface org.springframework.context.MessageSource

Methods inherited from interface org.springframework.core.io.ResourceLoader

Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver

Field Detail

DISPATCHER_SERVLET_NAME

Constructor Detail

ServletWebServerApplicationContext

ServletWebServerApplicationContext

Method Detail

postProcessBeanFactory

refresh

onRefresh

finishRefresh

onClose

getWebServerFactory

getServletContextInitializerBeans

prepareWebApplicationContext

getResourceByPath

getServerNamespace

setServerNamespace

setServletConfig

getServletConfig

getWebServer