org.springframework.web.context.support
Class AbstractRefreshableWebApplicationContext
java.lang.Object
org.springframework.core.io.DefaultResourceLoader
org.springframework.context.support.AbstractApplicationContext
org.springframework.context.support.AbstractRefreshableApplicationContext
org.springframework.web.context.support.AbstractRefreshableWebApplicationContext
- All Implemented Interfaces:
- BeanFactory, DisposableBean, HierarchicalBeanFactory, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, MessageSource, ResourceLoader, ResourcePatternResolver, ThemeSource, ConfigurableWebApplicationContext, WebApplicationContext
- Direct Known Subclasses:
- XmlWebApplicationContext
public abstract class AbstractRefreshableWebApplicationContext
- extends AbstractRefreshableApplicationContext
- implements ConfigurableWebApplicationContext
AbstractRefreshableApplicationContext subclass that implements the
ConfigurableWebApplicationContext interface for web environments.
Pre-implements a "configLocation" property, to be populated through the
ConfigurableWebApplicationContext interface on web application startup.
This class is as easy to subclass as AbstractRefreshableApplicationContext:
All you need to implements is the loadBeanDefinitions method;
see the superclass javadoc for details. Note that implementations are supposed
to load bean definitions from the files specified by the locations returned
by the getConfigLocations method.
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".
This is the web context to be subclassed for a different bean definition format.
Such a context implementation can be specified as "contextClass" context-param
for ContextLoader or "contextClass" init-param for FrameworkServlet, replacing
the default XmlWebApplicationContext. It would automatically receive the
"contextConfigLocation" context-param or init-param, respectively.
Note that WebApplicationContext implementations are generally supposed
to configure themselves based on the configuration received through the
ConfigurableWebApplicationContext interface. In contrast, a standalone
application context might allow for configuration in custom startup code
(for example, GenericApplicationContext).
- Since:
- 1.1.3
- Author:
- Juergen Hoeller
- See Also:
AbstractRefreshableApplicationContext.loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory),
getConfigLocations(),
ConfigurableWebApplicationContext.setConfigLocations(java.lang.String[]),
ServletContextResourcePatternResolver,
AbstractApplicationContext,
ThemeSource,
XmlWebApplicationContext,
GenericApplicationContext
| Methods inherited from class org.springframework.context.support.AbstractApplicationContext |
addBeanFactoryPostProcessor, addListener, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, getAliases, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getDisplayName, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResources, getStartupDate, getType, isSingleton, publishEvent, setDisplayName, setParent |
AbstractRefreshableWebApplicationContext
public AbstractRefreshableWebApplicationContext()
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[] locations)
- 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 or the root web application context, as appropriate.
- Specified by:
setConfigLocations in interface ConfigurableWebApplicationContext
getConfigLocations
protected String[] getConfigLocations()
refresh
public void refresh()
throws BeansException
- Sets a default config location if no explicit config location specified.
- Specified by:
refresh in interface ConfigurableApplicationContext- Overrides:
refresh in class AbstractApplicationContext
- Throws:
BeansException - if the bean factory could not be initialized- See Also:
getDefaultConfigLocations(),
setConfigLocations(java.lang.String[])
getDefaultConfigLocations
protected String[] getDefaultConfigLocations()
- Return the default config locations to use, for the case where no explicit
config locations have been specified.
Default implementation returns null, requiring explicit config locations.
- See Also:
setConfigLocations(java.lang.String[])
postProcessBeanFactory
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
- Register ServletContextAwareProcessor.
- Overrides:
postProcessBeanFactory in class AbstractApplicationContext
- Parameters:
beanFactory - the bean factory used by the application context- See Also:
ServletContextAwareProcessor
resolvePath
protected String resolvePath(String path)
- Resolve the given path, replacing placeholders with corresponding
system property values if necessary. Applied to config locations.
- Parameters:
path - the original file path
- Returns:
- the resolved file path
- See Also:
SystemPropertyUtils.resolvePlaceholders(java.lang.String)
getResourceByPath
protected Resource getResourceByPath(String path)
- This implementation supports file paths beneath the root of the ServletContext.
- Overrides:
getResourceByPath in class DefaultResourceLoader
- Parameters:
path - path to the resource
- Returns:
- Resource handle
- See Also:
ServletContextResource
getResourcePatternResolver
protected ResourcePatternResolver getResourcePatternResolver()
- This implementation supports pattern matching in unexpanded WARs too.
- 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
Copyright (c) 2002-2007 The Spring Framework Project.