org.springframework.web.context.support.AbstractRefreshableWebApplicationContext Maven / Gradle / Ivy
/*
* Copyright 2002-2004 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.context.support;
import javax.servlet.ServletContext;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.support.AbstractRefreshableApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.ui.context.Theme;
import org.springframework.ui.context.ThemeSource;
import org.springframework.ui.context.support.UiApplicationContextUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.context.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).
*
* @author Juergen Hoeller
* @since 1.1.3
* @see org.springframework.web.context.ConfigurableWebApplicationContext#setConfigLocations
* @see #getConfigLocations
* @see #loadBeanDefinitions
* @see ServletContextResourcePatternResolver
* @see org.springframework.context.support.AbstractApplicationContext
* @see org.springframework.ui.context.ThemeSource
* @see XmlWebApplicationContext
* @see org.springframework.context.support.GenericApplicationContext
*/
public abstract class AbstractRefreshableWebApplicationContext extends AbstractRefreshableApplicationContext
implements ConfigurableWebApplicationContext{
/** Servlet context that this context runs in */
private ServletContext servletContext;
/** Namespace of this context, or null if root */
private String namespace;
/** Paths to XML configuration files */
private String[] configLocations;
/** the ThemeSource for this ApplicationContext */
private ThemeSource themeSource;
public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
}
public ServletContext getServletContext() {
return this.servletContext;
}
public void setNamespace(String namespace) {
this.namespace = namespace;
if (this.namespace != null) {
setDisplayName("WebApplicationContext for namespace '" + this.namespace + "'");
}
else {
setDisplayName("Root WebApplicationContext");
}
}
protected String getNamespace() {
return this.namespace;
}
public void setConfigLocations(String[] configLocations) {
this.configLocations = configLocations;
}
protected String[] getConfigLocations() {
return this.configLocations;
}
/**
* Sets a default config location if no explicit config location specified.
* @see #getDefaultConfigLocations
* @see #setConfigLocations
*/
public void refresh() throws BeansException {
if (this.configLocations == null || this.configLocations.length == 0) {
setConfigLocations(getDefaultConfigLocations());
}
super.refresh();
}
/**
* 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 #setConfigLocations
*/
protected String[] getDefaultConfigLocations() {
return null;
}
/**
* Register ServletContextAwareProcessor.
* @see ServletContextAwareProcessor
*/
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
beanFactory.addBeanPostProcessor(new ServletContextAwareProcessor(this.servletContext));
beanFactory.ignoreDependencyType(ServletContext.class);
}
/**
* 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).
* @see ServletContextResource
*/
protected Resource getResourceByPath(String path) {
return new ServletContextResource(this.servletContext, path);
}
/**
* 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.
* @see ServletContextResourcePatternResolver
*/
protected ResourcePatternResolver getResourcePatternResolver() {
return new ServletContextResourcePatternResolver(this);
}
/**
* Initialize the theme capability.
*/
protected void onRefresh() {
this.themeSource = UiApplicationContextUtils.initThemeSource(this);
}
public Theme getTheme(String themeName) {
return this.themeSource.getTheme(themeName);
}
/**
* Return diagnostic information.
*/
public String toString() {
StringBuffer sb = new StringBuffer(super.toString());
sb.append("; ");
sb.append("config locations [");
sb.append(StringUtils.arrayToCommaDelimitedString(this.configLocations));
sb.append("]");
return sb.toString();
}
}