org.springframework.boot.web.servlet.context

Class XmlServletWebServerApplicationContext

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

org.springframework.boot.web.servlet.context.XmlServletWebServerApplicationContext

All Implemented Interfaces:

Closeable, AutoCloseable, BeanFactory, HierarchicalBeanFactory, ListableBeanFactory, BeanDefinitionRegistry, ConfigurableWebServerApplicationContext, WebServerApplicationContext, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, AliasRegistry, EnvironmentCapable, ResourceLoader, ResourcePatternResolver, ThemeSource, ConfigurableWebApplicationContext, WebApplicationContext

public class XmlServletWebServerApplicationContext
extends ServletWebServerApplicationContext

ServletWebServerApplicationContext which takes its configuration from XML documents, understood by an XmlBeanDefinitionReader.

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.

Since:

1.0.0

Author:

Phillip Webb

See Also:

GenericWebApplicationContext.setNamespace(java.lang.String), GenericWebApplicationContext.setConfigLocations(java.lang.String...), ServletWebServerApplicationContext, XmlWebApplicationContext

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext

ServletWebServerApplicationContext.ExistingWebApplicationScopes

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

DefaultResourceLoader.ClassPathContextResource

Field Summary

Fields inherited from class org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext

DISPATCHER_SERVLET_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.context.ConfigurableApplicationContext

CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SHUTDOWN_HOOK_THREAD_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME

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

FACTORY_BEAN_PREFIX

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

CLASSPATH_ALL_URL_PREFIX

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

CLASSPATH_URL_PREFIX

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

APPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAME

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 and Description
XmlServletWebServerApplicationContext() Create a new XmlServletWebServerApplicationContext that needs to be loaded and then manually refreshed.
XmlServletWebServerApplicationContext(Class<?> relativeClass, String... resourceNames) Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.
XmlServletWebServerApplicationContext(Resource... resources) Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resources and automatically refreshing the context.
XmlServletWebServerApplicationContext(String... resourceLocations) Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.

Method Summary

Modifier and Type	Method and Description
void	load(Class<?> relativeClass, String... resourceNames) Load bean definitions from the given XML resources.
void	load(Resource... resources) Load bean definitions from the given XML resources.
void	load(String... resourceLocations) Load bean definitions from the given XML resources.
void	setEnvironment(ConfigurableEnvironment environment)
void	setValidating(boolean validating) Set whether to use XML validation.

Methods inherited from class org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext

doClose, getResourceByPath, getServerNamespace, getServletConfig, getServletContextInitializerBeans, getWebServer, getWebServerFactory, onRefresh, postProcessBeanFactory, prepareWebApplicationContext, refresh, setServerNamespace, setServletConfig

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, 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, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, 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.context.ConfigurableApplicationContext

addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, registerShutdownHook, setClassLoader, setId, setParent

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Methods inherited from interface org.springframework.boot.web.context.WebServerApplicationContext

hasServerNamespace

Methods inherited from interface org.springframework.context.ApplicationContext

getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

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

containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation

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

containsLocalBean, getParentBeanFactory

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

containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

publishEvent, publishEvent

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

getResources

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

getClassLoader, getResource

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

containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames

Methods inherited from interface org.springframework.core.AliasRegistry

getAliases

Constructor Detail

XmlServletWebServerApplicationContext

public XmlServletWebServerApplicationContext()

Create a new XmlServletWebServerApplicationContext that needs to be loaded and then manually refreshed.

XmlServletWebServerApplicationContext

public XmlServletWebServerApplicationContext(Resource... resources)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resources and automatically refreshing the context.

Parameters:

resources - the resources to load from

XmlServletWebServerApplicationContext

public XmlServletWebServerApplicationContext(String... resourceLocations)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.

Parameters:

resourceLocations - the resources to load from

XmlServletWebServerApplicationContext

public XmlServletWebServerApplicationContext(Class<?> relativeClass,
                                             String... resourceNames)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.

Parameters:

relativeClass - class whose package will be used as a prefix when loading each specified resource name

resourceNames - relatively-qualified names of resources to load

Method Detail

setValidating

public void setValidating(boolean validating)

Set whether to use XML validation. Default is true.

Parameters:

validating - if validating the XML

setEnvironment

public void setEnvironment(ConfigurableEnvironment environment)

Delegates the given environment to underlying XmlBeanDefinitionReader. Should be called before any call to load(org.springframework.core.io.Resource...).

Specified by:

setEnvironment in interface ConfigurableApplicationContext

Overrides:

setEnvironment in class AbstractApplicationContext

load

public final void load(Resource... resources)

Load bean definitions from the given XML resources.

Parameters:

resources - one or more resources to load from

load

public final void load(String... resourceLocations)

Load bean definitions from the given XML resources.

Parameters:

resourceLocations - one or more resource locations to load from

load

public final void load(Class<?> relativeClass,
                       String... resourceNames)

Load bean definitions from the given XML resources.

Parameters:

relativeClass - class whose package will be used as a prefix when loading each specified resource name

resourceNames - relatively-qualified names of resources to load