package org.apache.commons.jcs3.utils.servlet;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.
   */
  
  import javax.servlet.ServletContextEvent;
  import javax.servlet.ServletContextListener;
  
  import org.apache.commons.jcs3.JCS;
  import org.apache.commons.jcs3.log.Log;
  import org.apache.commons.jcs3.log.LogManager;
  
  /**
   * If you add this to the context listeners section of your web.xml file, this will shutdown JCS
   * gracefully.
   * <p>
   * Add the following to the top of your web.xml file.
   *
   * <pre>
   *  &lt;listener&gt;
   *  &lt;listener-class&gt;
   *  org.apache.commons.jcs3.utils.servlet.JCSServletContextListener
   *  &lt;/listener-class&gt;
   *  &lt;/listener&gt;
   * </pre>
   */
  public class JCSServletContextListener
      implements ServletContextListener
  {
      /** The logger */
      private static final Log log = LogManager.getLog( JCSServletContextListener.class );
  
      /**
       * This does nothing. We don't want to initialize the cache here.
       * <p>
       * @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
       */
      @Override
      public void contextInitialized( final ServletContextEvent arg0 )
      {
          log.debug( "contextInitialized" );
      }
  
      /**
       * Shutdown JCS.
       * <p>
       * @see javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)
       */
      @Override
      public void contextDestroyed( final ServletContextEvent arg0 )
      {
          log.debug( "contextDestroyed, shutting down JCS." );
  
          JCS.shutdown();
      }
  }