org.sakaiproject.util.ContextLoaderListener.java Source code

Introduction

Here is the source code for org.sakaiproject.util.ContextLoaderListener.java

Source

/**********************************************************************************
 * $URL$
 * $Id$
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 Sakai Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.sakaiproject.util;

import javax.servlet.ServletContextEvent;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.component.impl.ContextLoader;
import org.sakaiproject.component.impl.SpringCompMgr;

/**
 * <p>
 * Sakai's extension to the Spring ContextLoaderListener - use our ContextLoader, and increment / decrement the child count of the ComponentManager on init / destroy.
 * </p>
 */
public class ContextLoaderListener extends org.springframework.web.context.ContextLoaderListener {
    private static final Log log = LogFactory.getLog(ContextLoaderListener.class);

    /**
     * Create the ContextLoader to use. Can be overridden in subclasses.
     * 
     * @return the new ContextLoader
     */
    protected org.springframework.web.context.ContextLoader createContextLoader() {
        return new ContextLoader();
    }

    /**
     * Initialize the root web application context.
     */
    public void contextInitialized(ServletContextEvent event) {
        super.contextInitialized(event);

        // increment the count of children for the component manager
        ((SpringCompMgr) ComponentManager.getInstance()).addChildAc();
    }

    /**
     * Close the root web application context.
     */
    public void contextDestroyed(ServletContextEvent event) {
        super.contextDestroyed(event);

        log.info("Destroying Components in " + event.getServletContext().getServletContextName());

        // decrement the count of children for the component manager
        ((SpringCompMgr) ComponentManager.getInstance()).removeChildAc();
    }
}