org.springframework.web.context.support
Class XmlWebApplicationContext

java.lang.Object
  org.springframework.core.io.DefaultResourceLoader
      org.springframework.context.support.AbstractApplicationContext
          org.springframework.context.support.AbstractXmlApplicationContext
              org.springframework.web.context.support.XmlWebApplicationContext

All Implemented Interfaces:

ApplicationContext, ApplicationEventPublisher, BeanFactory, ConfigurableApplicationContext, ConfigurableWebApplicationContext, HierarchicalBeanFactory, ListableBeanFactory, MessageSource, ResourceLoader, ThemeSource, WebApplicationContext

public class XmlWebApplicationContext

extends AbstractXmlApplicationContext

implements ConfigurableWebApplicationContext

WebApplicationContext implementation that takes configuration from an XML document.

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 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.

Interprets resource paths as servlet context resources, i.e. as paths beneath the web application root. Absolute paths, e.g. for files outside the web app root, can be accessed via "file:" URLs, as implemented by AbstractApplicationContext.

In addition to the special beans detected by AbstractApplicationContext, this class detects a ThemeSource bean in the context, with the name "themeSource".

Author:

Rod Johnson, Juergen Hoeller

See Also:

setNamespace(java.lang.String), setConfigLocations(java.lang.String[]), getResourcePatternResolver(), ContextLoader.initWebApplicationContext(javax.servlet.ServletContext), FrameworkServlet.initWebApplicationContext(), AbstractApplicationContext, ThemeSource

Field Summary

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

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

APPLICATION_EVENT_MULTICASTER_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME

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

CONFIG_LOCATION_DELIMITERS

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

ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE

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

FACTORY_BEAN_PREFIX

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

CLASSPATH_URL_PREFIX

Constructor Summary

XmlWebApplicationContext()

Method Summary

protected String[]	getConfigLocations() Return an array of resource locations, referring to the XML bean definition files that this context should be built with.
protected String	getNamespace()
protected Resource	getResourceByPath(String path) Resolve file paths beneath the root of the web application.
protected ResourcePatternResolver	getResourcePatternResolver() Use a ServletContextResourcePatternResolver, to be able to find matching resources below the web application root directory even in a WAR file which has not been expanded.
ServletContext	getServletContext() Return the standard Servlet API ServletContext for this application.
Theme	getTheme(String themeName) Return the Theme instance for the given theme name.
protected void	onRefresh() Initialize the theme capability.
protected void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Modify the application context's internal bean factory after its standard initialization.
void	refresh() Load respectively refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.
void	setConfigLocations(String[] configLocations) Set the config locations for this web application context.
void	setNamespace(String namespace) Set the namespace for this web application context, to be used for building a default context config location.
void	setServletContext(ServletContext servletContext) Set the ServletContext for this web application context.
String	toString() Return diagnostic information.

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

createBeanFactory, getBeanFactory, initBeanDefinitionReader, loadBeanDefinitions, refreshBeanFactory

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

addBeanFactoryPostProcessor, addListener, close, containsBean, containsBeanDefinition, getAliases, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeansOfType, getBeansOfType, getDisplayName, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, isSingleton, publishEvent, setDisplayName, setParent

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

getClassLoader, getResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContext

getDisplayName, getParent, getStartupDate, publishEvent

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

containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames, getBeanDefinitionNames, getBeansOfType, getBeansOfType

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

containsBean, getAliases, getBean, getBean, getType, isSingleton

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

getParentBeanFactory

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

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

getResource

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

addBeanFactoryPostProcessor, close, getBeanFactory, setParent

Field Detail

DEFAULT_CONFIG_LOCATION

public static final String DEFAULT_CONFIG_LOCATION

Default config location for the root context

See Also:

Constant Field Values

DEFAULT_CONFIG_LOCATION_PREFIX

public static final String DEFAULT_CONFIG_LOCATION_PREFIX

Default prefix for building a config location for a namespace

See Also:

Constant Field Values

DEFAULT_CONFIG_LOCATION_SUFFIX

public static final String DEFAULT_CONFIG_LOCATION_SUFFIX

Default suffix for building a config location for a namespace

See Also:

Constant Field Values

Constructor Detail

XmlWebApplicationContext

public XmlWebApplicationContext()

Method Detail

setServletContext

public void setServletContext(ServletContext servletContext)

Description copied from interface: ConfigurableWebApplicationContext

Set the ServletContext for this web application context.

Does not cause an initialization of the context: refresh needs to be called after the setting of all configuration properties.

Specified by:

setServletContext in interface ConfigurableWebApplicationContext

See Also:

ConfigurableApplicationContext.refresh()

getServletContext

public ServletContext getServletContext()

Description copied from interface: WebApplicationContext

Return the standard Servlet API ServletContext for this application.

Specified by:

getServletContext in interface WebApplicationContext

setNamespace

public void setNamespace(String namespace)

Description copied from interface: ConfigurableWebApplicationContext

Set the namespace for this web application context, to be used for building a default context config location. The root web application context does not have a namespace.

Specified by:

setNamespace in interface ConfigurableWebApplicationContext

getNamespace

protected String getNamespace()

setConfigLocations

public void setConfigLocations(String[] configLocations)

Description copied from interface: ConfigurableWebApplicationContext

Set the config locations for this web application context. If not set, the implementation is supposed to use a default for the given namespace respectively the root web application context.

Specified by:

setConfigLocations in interface ConfigurableWebApplicationContext

getConfigLocations

protected String[] getConfigLocations()

Description copied from class: AbstractXmlApplicationContext

Return an array of resource locations, referring to the XML bean definition files that this context should be built with.

Can also include location patterns, which will get resolved via a ResourcePatternResolver.

Specified by:

getConfigLocations in class AbstractXmlApplicationContext

Returns:

an array of resource locations, or null if none

See Also:

AbstractApplicationContext.getResourcePatternResolver()

refresh

public void refresh()
             throws BeansException

Description copied from interface: ConfigurableApplicationContext

Load respectively refresh the persistent representation of the configuration, which might an XML file, properties file, or relational database schema.

Specified by:

refresh in interface ConfigurableApplicationContext

Overrides:

refresh in class AbstractApplicationContext

Throws:

BeansException

postProcessBeanFactory

protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)

Description copied from class: AbstractApplicationContext

Modify the application context's internal bean factory after its standard initialization. All bean definitions will have been loaded, but no beans will have been instantiated yet. This allows for registering special BeanPostProcessors etc in certain ApplicationContext implementations.

Overrides:

postProcessBeanFactory in class AbstractApplicationContext

Parameters:

beanFactory - the bean factory used by the application context

getResourceByPath

protected Resource getResourceByPath(String path)

Resolve file paths beneath the root of the web application.

Note: Even if a given path starts with a slash, it will get interpreted as relative to the web application root directory (which is the way most servlet containers handle such paths).

Overrides:

getResourceByPath in class DefaultResourceLoader

Parameters:

path - path to the resource

Returns:

Resource handle

See Also:

ServletContextResource

getResourcePatternResolver

protected ResourcePatternResolver getResourcePatternResolver()

Use a ServletContextResourcePatternResolver, to be able to find matching resources below the web application root directory even in a WAR file which has not been expanded.

Overrides:

getResourcePatternResolver in class AbstractApplicationContext

See Also:

ServletContextResourcePatternResolver

onRefresh

protected void onRefresh()

Initialize the theme capability.

Overrides:

onRefresh in class AbstractApplicationContext

See Also:

AbstractApplicationContext.refresh()

getTheme

public Theme getTheme(String themeName)

Description copied from interface: ThemeSource

Return the Theme instance for the given theme name. The returned Theme will resolve theme-specific messages, codes, file paths, etc (e.g. CSS and image files in a web environment).

Specified by:

getTheme in interface ThemeSource

Parameters:

themeName - name of the theme

Returns:

the respective Theme, or null if none defined

toString

public String toString()

Return diagnostic information.

Overrides:

toString in class AbstractApplicationContext