jsfenvironment.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.test;

import javax.servlet.ServletContext;

import org.springframework.web.context.ConfigurableWebApplicationContext;

/**
 * Encapsulates the whole configuration of a JSF environment with the use of
 * JSF-Spring. Delivers the {@link JsfStartupDriver} representing a concrete JSF
 * implementation and the corresponding
 * {@link org.springframework.web.context.WebApplicationContext} usually created
 * by JSF-Spring.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
public interface JsfEnvironment {

    /**
     * Loads the appropriate
     * {@link org.springframework.web.context.WebApplicationContext}.
     * 
     * @param servletContext
     *            the {@link ServletContext}
     * @return the {@link org.springframework.web.context.WebApplicationContext}
     * @throws Exception
     *             in case of errors
     */
    ConfigurableWebApplicationContext loadContext(ServletContext servletContext)
            throws Exception;

    /**
     * Loads the appropriate {@link JsfStartupDriver}.
     * 
     * @param servletContext
     *            the {@link ServletContext}
     * @return the {@link JsfStartupDriver}
     * @throws Exception
     *             in case of errors
     */
    JsfStartupDriver loadJsfImplementation(ServletContext servletContext)
            throws Exception;

}