Open Source Repository

Home /spring/spring-web-3.0.5 | Repository Home


org/springframework/web/context/support/GenericWebApplicationContext.java
/*
 * Copyright 2002-2009 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.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.support.GenericApplicationContext;
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.web.context.ServletContextAware;
import org.springframework.web.context.WebApplicationContext;

/**
 * Subclass of {@link GenericApplicationContext}, suitable for web environments.
 *
 <p>Implements the {@link WebApplicationContext} interface, but not
 {@link org.springframework.web.context.ConfigurableWebApplicationContext},
 * as it is not intended for declarative setup in <code>web.xml</code>. Instead,
 * it is designed for programmatic setup, for example for building nested contexts.
 *
 <p><b>If you intend to implement a WebApplicationContext that reads bean definitions
 * from configuration files, consider deriving from AbstractRefreshableWebApplicationContext,
 * reading the bean definitions in an implementation of the <code>loadBeanDefinitions</code>
 * method.</b>
 *
 <p>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.
 *
 <p>In addition to the special beans detected by
 {@link org.springframework.context.support.AbstractApplicationContext},
 * this class detects a ThemeSource bean in the context, with the name "themeSource".
 *
 @author Juergen Hoeller
 @since 1.2
 */
public class GenericWebApplicationContext extends GenericApplicationContext
    implements WebApplicationContext, ThemeSource {

  private ServletContext servletContext;

  private ThemeSource themeSource;


  /**
   * Create a new GenericWebApplicationContext.
   @see #setServletContext
   @see #registerBeanDefinition
   @see #refresh
   */
  public GenericWebApplicationContext() {
    super();
  }

  /**
   * Create a new GenericWebApplicationContext for the given ServletContext.
   @param servletContext the ServletContext to run in
   @see #registerBeanDefinition
   @see #refresh
   */
  public GenericWebApplicationContext(ServletContext servletContext) {
    this.servletContext = servletContext;
  }

  /**
   * Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.
   @param beanFactory the DefaultListableBeanFactory instance to use for this context
   @see #setServletContext
   @see #registerBeanDefinition
   @see #refresh
   */
  public GenericWebApplicationContext(DefaultListableBeanFactory beanFactory) {
    super(beanFactory);
  }

  /**
   * Create a new GenericWebApplicationContext with the given DefaultListableBeanFactory.
   @param beanFactory the DefaultListableBeanFactory instance to use for this context
   @param servletContext the ServletContext to run in
   @see #registerBeanDefinition
   @see #refresh
   */
  public GenericWebApplicationContext(DefaultListableBeanFactory beanFactory, ServletContext servletContext) {
    super(beanFactory);
    this.servletContext = servletContext;
  }


  /**
   * Set the ServletContext that this WebApplicationContext runs in.
   */
  public void setServletContext(ServletContext servletContext) {
    this.servletContext = servletContext;
  }

  public ServletContext getServletContext() {
    return this.servletContext;
  }


  /**
   * Register ServletContextAwareProcessor.
   @see ServletContextAwareProcessor
   */
  @Override
  protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
    beanFactory.addBeanPostProcessor(new ServletContextAwareProcessor(this.servletContext));
    beanFactory.ignoreDependencyInterface(ServletContextAware.class);

    WebApplicationContextUtils.registerWebApplicationScopes(beanFactory, this.servletContext);
    WebApplicationContextUtils.registerEnvironmentBeans(beanFactory, this.servletContext);
  }

  /**
   * This implementation supports file paths beneath the root of the ServletContext.
   @see ServletContextResource
   */
  @Override
  protected Resource getResourceByPath(String path) {
    return new ServletContextResource(this.servletContext, path);
  }

  /**
   * This implementation supports pattern matching in unexpanded WARs too.
   @see ServletContextResourcePatternResolver
   */
  @Override
  protected ResourcePatternResolver getResourcePatternResolver() {
    return new ServletContextResourcePatternResolver(this);
  }

  /**
   * Initialize the theme capability.
   */
  @Override
  protected void onRefresh() {
    this.themeSource = UiApplicationContextUtils.initThemeSource(this);
  }

  public Theme getTheme(String themeName) {
    return this.themeSource.getTheme(themeName);
  }

}