org.beangle.inject.spring.web.DwrSpringServlet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of beangle-ioc-spring Show documentation
The newest version!
/*
 * Beangle, Agile Development Scaffold and Toolkits.
 *
 * Copyright © 2005, The Beangle Software.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */

package org.beangle.inject.spring.web;

import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import org.directwebremoting.Container;
import org.directwebremoting.WebContextFactory.WebContextBuilder;
import org.directwebremoting.extend.Configurator;
import org.directwebremoting.impl.StartupUtil;
import org.directwebremoting.servlet.DwrServlet;
import org.directwebremoting.spring.SpringContainer;
import org.directwebremoting.spring.namespace.ConfigurationParser;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * The servlet that handles all calls to DWR. 

 * It retrieves its configuration from the Spring IoC container. This is done in two ways:
 * 
 * Use the Spring namespace. When using the Spring namespace for DWR, the confgiuration for DWR
 * is automatically picked up by this servlet.
 * Explicitly specify which configurations to pick up. When explicitly defining the DWR
 * configuration in Spring yourself, you can explicitely specify them in the init parameters.
 * 
 * Same as with the DwrServlet, you can specify a debug init parameter on
 * this servlet
 * to put DWR in debug mode (allowing access to the very handy debug pages).
 *
 * @author chaostone
 * @see org.directwebremoting.servlet.DwrServlet
 */
public class DwrSpringServlet extends DwrServlet {
  private static final long serialVersionUID = 1843603170043922633L;

  /**
   * Do we prefix the list of Configurators with a default to read the system
   * dwr.xml file?
   */
  private boolean includeDefaultConfig = true;

  /**
   * What Configurators exist for us to configure ourselves.
   */
  private List configurators = new ArrayList();

  /**
   * The WebContext that keeps http objects local to a thread
   */
  protected WebContextBuilder webContextBuilder = null;

  @Override
  protected SpringContainer createContainer(ServletConfig servletConfig) {
    ApplicationContext appContext = getApplicationContext(servletConfig.getServletContext());

    SpringContainer springContainer = new SpringContainer();
    springContainer.setBeanFactory(appContext);
    StartupUtil.setupDefaultContainer(springContainer, servletConfig);
    return springContainer;
  }

  @Override
  protected void configureContainer(Container container, ServletConfig servletConfig)
    throws ServletException, IOException {
    try {
      ApplicationContext appContext = getApplicationContext(servletConfig.getServletContext());
      configurators
        .add((Configurator) appContext.getBean(ConfigurationParser.DEFAULT_SPRING_CONFIGURATOR_ID));
    } catch (NoSuchBeanDefinitionException ex) {
      throw new ServletException(
        "No DWR configuration was found in your application context, make sure to define one", ex);
    }

    try {
      if (includeDefaultConfig) {
        StartupUtil.configureFromSystemDwrXml(container);
      }

      StartupUtil.configureFromInitParams(container, servletConfig);
      StartupUtil.configure(container, configurators);
    } catch (IOException ex) {
      throw ex;
    } catch (Exception ex) {
      throw new ServletException(ex);
    }
  }

  protected ApplicationContext getApplicationContext(ServletContext servletContext) {
    return ContextLoader.getContext(servletContext);
  }

  /**
   * Setter for use by the Spring IoC container to tell us what Configurators
   * exist for us to configure ourselves.
   *
   * @param configurators
   */
  public void setConfigurators(List configurators) {
    this.configurators = configurators;
  }

  /**
   * Do we prefix the list of Configurators with a default to read the system
   * dwr.xml file?
   *
   * @param includeDefaultConfig the includeDefaultConfig to set
   */
  public void setIncludeDefaultConfig(boolean includeDefaultConfig) {
    this.includeDefaultConfig = includeDefaultConfig;
  }

}