public class EmbeddedWebApplicationContext
extends org.springframework.web.context.support.GenericWebApplicationContext
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.
AnnotationConfigEmbeddedWebApplicationContext,
XmlEmbeddedWebApplicationContext,
EmbeddedServletContainerFactory| Modifier and Type | Class and Description |
|---|---|
static class |
EmbeddedWebApplicationContext.ExistingWebApplicationScopes
Utility class to store and restore any user defined scopes.
|
| Modifier and Type | Field and Description |
|---|---|
static String |
DISPATCHER_SERVLET_NAME
Constant value for the DispatcherServlet bean name.
|
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, MESSAGE_SOURCE_BEAN_NAMEAPPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAMECONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAMECONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME| Constructor and Description |
|---|
EmbeddedWebApplicationContext() |
| Modifier and Type | Method and Description |
|---|---|
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 org.springframework.core.io.Resource |
getResourceByPath(String path) |
javax.servlet.ServletConfig |
getServletConfig() |
protected Collection<ServletContextInitializer> |
getServletContextInitializerBeans()
Returns
ServletContextInitializers that should be used with the embedded
Servlet context. |
protected void |
onClose() |
protected void |
onRefresh() |
protected void |
postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
Register ServletContextAwareProcessor.
|
protected void |
prepareEmbeddedWebApplicationContext(javax.servlet.ServletContext servletContext)
Prepare the
WebApplicationContext with the given fully loaded
ServletContext. |
void |
refresh() |
void |
setNamespace(String namespace) |
void |
setServletConfig(javax.servlet.ServletConfig servletConfig) |
createEnvironment, getApplicationName, getConfigLocations, getResourcePatternResolver, getServletContext, getTheme, initPropertySources, setConfigLocation, setConfigLocations, setServletContextcancelRefresh, closeBeanFactory, getAutowireCapableBeanFactory, getBeanDefinition, getBeanFactory, getDefaultListableBeanFactory, getResource, getResources, isAlias, isBeanNameInUse, refreshBeanFactory, registerAlias, registerBeanDefinition, removeAlias, removeBeanDefinition, setAllowBeanDefinitionOverriding, setAllowCircularReferences, setId, setParent, setResourceLoaderaddApplicationListener, 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, 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, start, stop, toStringgetClassLoader, setClassLoaderclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddApplicationListener, addBeanFactoryPostProcessor, close, getBeanFactory, getEnvironment, isActive, registerShutdownHook, setEnvironment, setId, setParentgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDatecontainsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotationcontainsLocalBean, getParentBeanFactorycontainsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatchgetMessage, getMessage, getMessagepublishEvent, publishEventgetResourcesgetClassLoader, getResourcepublic static final String DISPATCHER_SERVLET_NAME
ServletRegistrationBean or a different bean name.protected void postProcessBeanFactory(org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory)
postProcessBeanFactory in class org.springframework.web.context.support.GenericWebApplicationContextServletContextAwareProcessorpublic final void refresh()
throws org.springframework.beans.BeansException,
IllegalStateException
refresh in interface org.springframework.context.ConfigurableApplicationContextrefresh in class org.springframework.context.support.AbstractApplicationContextorg.springframework.beans.BeansExceptionIllegalStateExceptionprotected void onRefresh()
onRefresh in class org.springframework.web.context.support.GenericWebApplicationContextprotected void finishRefresh()
finishRefresh in class org.springframework.context.support.AbstractApplicationContextprotected void onClose()
onClose in class org.springframework.context.support.AbstractApplicationContextprotected EmbeddedServletContainerFactory getEmbeddedServletContainerFactory()
EmbeddedServletContainerFactory that should be used to create
the embedded servlet container. By default this method searches for a suitable bean
in the context itself.EmbeddedServletContainerFactory (never null)protected Collection<ServletContextInitializer> getServletContextInitializerBeans()
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.protected void prepareEmbeddedWebApplicationContext(javax.servlet.ServletContext servletContext)
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.servletContext - the operational servlet contextprotected org.springframework.core.io.Resource getResourceByPath(String path)
getResourceByPath in class org.springframework.web.context.support.GenericWebApplicationContextpublic void setNamespace(String namespace)
setNamespace in interface org.springframework.web.context.ConfigurableWebApplicationContextsetNamespace in class org.springframework.web.context.support.GenericWebApplicationContextpublic String getNamespace()
getNamespace in interface org.springframework.web.context.ConfigurableWebApplicationContextgetNamespace in class org.springframework.web.context.support.GenericWebApplicationContextpublic void setServletConfig(javax.servlet.ServletConfig servletConfig)
setServletConfig in interface org.springframework.web.context.ConfigurableWebApplicationContextsetServletConfig in class org.springframework.web.context.support.GenericWebApplicationContextpublic javax.servlet.ServletConfig getServletConfig()
getServletConfig in interface org.springframework.web.context.ConfigurableWebApplicationContextgetServletConfig in class org.springframework.web.context.support.GenericWebApplicationContextpublic EmbeddedServletContainer getEmbeddedServletContainer()
EmbeddedServletContainer that was created by the context or
null if the container has not yet been created.Copyright © 2016 Pivotal Software, Inc.. All rights reserved.