contextloaderlistener.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * 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 de.mindmatters.faces.spring.context;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

/**
 * Bootstrap listener to start up JSF-Spring's root WebApplicationContext.
 * Simply delegates to ContextLoader.
 * 
 * <p>
 * For further informtion please have a look at the documentation of
 * {@link org.springframework.web.context.ContextLoaderListener}.
 * </p>
 * 
 * @author Andreas Kuhrwahl
 */
public class ContextLoaderListener implements ServletContextListener {

    /**
     * The ConfigLoader loading the <i>jsf-spring-config</i> root
     * ConfigWebApplicationContext.
     */
    private ContextLoader contextLoader;

    /**
     * Creates the ConfigLoader to use. Can be overridden in subclasses.
     * 
     * @return the new ConfigLoader
     */
    protected ContextLoader createContextLoader() {
        return new ContextLoader();
    }

    /**
     * Initializes the <i>jsf-spring-config</i> root web application context.
     * 
     * @param event
     *            the ServletContextEvent
     * @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
     */
    public final void contextInitialized(final ServletContextEvent event) {
        this.contextLoader = createContextLoader();
        final ServletContext context = event.getServletContext();
        this.contextLoader.initWebApplicationContext(context);
    }

    /**
     * Closes the <i>jsf-spring-config</i> root web application context.
     * 
     * @param event
     *            the ServletContextEvent
     * @see javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)
     */
    public final void contextDestroyed(final ServletContextEvent event) {
        if (this.contextLoader != null) {
            this.contextLoader.closeWebApplicationContext(event
                    .getServletContext());
        }
    }

}