public class XmlWebApplicationContext extends AbstractRefreshableWebApplicationContext
WebApplicationContext implementation
which takes its configuration from XML documents, understood by an
XmlBeanDefinitionReader.
This is essentially the equivalent of
AbstractXmlApplicationContext
for a web environment.
By default, the configuration will be taken from "/WEB-INF/applicationContext.xml" for the root context, and "/WEB-INF/test-servlet.xml" for a context with the namespace "test-servlet" (like for a DispatcherServlet instance with the servlet-name "test").
The config location defaults can be overridden via the "contextConfigLocation"
context-param of ContextLoader and servlet
init-param of FrameworkServlet. Config locations
can either denote concrete files like "/WEB-INF/context.xml" or Ant-style patterns
like "/WEB-INF/*-context.xml" (see PathMatcher
javadoc for pattern details).
Note: In case of multiple config locations, later bean definitions will override ones defined in earlier loaded files. This can be leveraged to deliberately override certain bean definitions via an extra XML file.
For a WebApplicationContext that reads in a different bean definition format,
create an analogous subclass of AbstractRefreshableWebApplicationContext.
Such a context implementation can be specified as "contextClass" context-param
for ContextLoader or "contextClass" init-param for FrameworkServlet.
AbstractRefreshableWebApplicationContext.setNamespace(java.lang.String),
AbstractRefreshableConfigApplicationContext.setConfigLocations(java.lang.String[]),
XmlBeanDefinitionReader,
ContextLoader.initWebApplicationContext(javax.servlet.ServletContext),
FrameworkServlet.initWebApplicationContext()| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_CONFIG_LOCATION
Default config location for the root context
|
static String |
DEFAULT_CONFIG_LOCATION_PREFIX
Default prefix for building a config location for a namespace
|
static String |
DEFAULT_CONFIG_LOCATION_SUFFIX
Default suffix for building a config location for a namespace
|
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, 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, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAMEFACTORY_BEAN_PREFIXCLASSPATH_ALL_URL_PREFIXCLASSPATH_URL_PREFIX| Constructor and Description |
|---|
XmlWebApplicationContext() |
| Modifier and Type | Method and Description |
|---|---|
protected String[] |
getDefaultConfigLocations()
The default location for the root context is "/WEB-INF/applicationContext.xml",
and "/WEB-INF/test-servlet.xml" for a context with the namespace "test-servlet"
(like for a DispatcherServlet instance with the servlet-name "test").
|
protected void |
initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader)
Initialize the bean definition reader used for loading the bean
definitions of this context.
|
protected void |
loadBeanDefinitions(DefaultListableBeanFactory beanFactory)
Loads the bean definitions via an XmlBeanDefinitionReader.
|
protected void |
loadBeanDefinitions(XmlBeanDefinitionReader reader)
Load the bean definitions with the given XmlBeanDefinitionReader.
|
getConfigLocations, getNamespace, getResourceByPath, getResourcePatternResolver, getServletConfig, getServletContext, getTheme, onRefresh, postProcessBeanFactory, setNamespace, setServletConfig, setServletContextafterPropertiesSet, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setIdcancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferencesaddApplicationListener, addBeanFactoryPostProcessor, addListener, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResources, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, setDisplayName, setParent, start, stop, toStringgetClassLoader, getResource, setClassLoaderclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitsetConfigLocation, setConfigLocationsaddApplicationListener, addBeanFactoryPostProcessor, close, getBeanFactory, isActive, refresh, registerShutdownHook, setId, setParentgetAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDatecontainsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotationcontainsLocalBean, getParentBeanFactorycontainsBean, getAliases, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatchgetMessage, getMessage, getMessagepublishEventgetResourcesgetClassLoader, getResourcepublic static final String DEFAULT_CONFIG_LOCATION
public static final String DEFAULT_CONFIG_LOCATION_PREFIX
public static final String DEFAULT_CONFIG_LOCATION_SUFFIX
public XmlWebApplicationContext()
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException
loadBeanDefinitions in class AbstractRefreshableApplicationContextbeanFactory - the bean factory to load bean definitions intoBeansException - if parsing of the bean definitions failedIOException - if loading of bean definition files failedXmlBeanDefinitionReader,
initBeanDefinitionReader(org.springframework.beans.factory.xml.XmlBeanDefinitionReader),
loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory)protected void initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader)
Can be overridden in subclasses, e.g. for turning off XML validation or using a different XmlBeanDefinitionParser implementation.
beanDefinitionReader - the bean definition reader used by this contextXmlBeanDefinitionReader.setValidationMode(int),
XmlBeanDefinitionReader.setDocumentReaderClass(java.lang.Class)protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws IOException
The lifecycle of the bean factory is handled by the refreshBeanFactory method; therefore this method is just supposed to load and/or register bean definitions.
Delegates to a ResourcePatternResolver for resolving location patterns into Resource instances.
IOException - if the required XML document isn't foundAbstractRefreshableApplicationContext.refreshBeanFactory(),
AbstractRefreshableWebApplicationContext.getConfigLocations(),
AbstractApplicationContext.getResources(java.lang.String),
AbstractRefreshableWebApplicationContext.getResourcePatternResolver()protected String[] getDefaultConfigLocations()
getDefaultConfigLocations in class AbstractRefreshableConfigApplicationContextAbstractRefreshableConfigApplicationContext.setConfigLocations(java.lang.String[])