faceswebapplicationcontext.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 org.springframework.web.context.ConfigurableWebApplicationContext;

import de.mindmatters.faces.spring.factory.ManagedBeanFactory;

/**
 * Provides configuration for managed beans. Typically managed beans implement
 * the business logic related to the frontend integration.
 * 
 * <p>
 * Implementations should take configuration from faces and spring configuration
 * XML documents.<br/> More precisely config files <strong>must</strong> be
 * compatible with the following DTD's or schemas:
 * <ul>
 * <li><a
 * href="http://java.sun.com/dtd/web-facesconfig_1_0.dtd">web-facesconfig_1_0.dtd</a></li>
 * <li><a
 * href="http://java.sun.com/dtd/web-facesconfig_1_1.dtd">web-facesconfig_1_1.dtd</a></li>
 * <li><a
 * href="http://www.springframework.org/dtd/spring-beans.dtd">spring-beans.dtd</a></li>
 * <li><a
 * href="http://www.springframework.org/dtd/spring-beans-2.0.dtd">spring-beans-2.0.dtd</a></li>
 * <li><a
 * href="http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">spring-beans-2.0.xsd</a></li>
 * </ul>
 * <br/>
 * <p>
 * By default, the configuration will be taken from "/WEB-INF/faces-config.xml"
 * (JSF-configuration) and from "/WEB-INF/faces-spring-context.xml" (bean
 * definitions in a common spring configuration XML document) for the faces root
 * context, if the files exist. Furthermore configuration will be taken from
 * "/META-INF/faces-config.xml" and from "/META-INF/faces-spring-context.xml" of
 * any deployed jar in the classpath.
 * </p>
 * 
 * <p>
 * The config location defaults can be overridden via the
 * "javax.faces.CONFIG_FILES" context param and also the
 * "faces.spring.CONTEXT_FILES" context param of
 * {@link de.mindmatters.faces.spring.context.ContextLoader} for configuration
 * files based on the spring beans DTD or schema respectively. Config locations
 * for configuration files based on the spring beans DTD/schema can either
 * denote concrete files like "/WEB-INF/context.xml" or Ant-style patterns like
 * "/WEB-INF/*-context.xml" (see PathMatcher javadoc for pattern details).
 * </p>
 * 
 * @author Andreas Kuhrwahl
 */
public interface FacesWebApplicationContext extends
        ConfigurableWebApplicationContext {

    /**
     * Context attribute to bind faces root WebApplicationContext to on
     * successful startup.
     * <p>
     * Note: If the startup of the root context fails, this attribute can
     * contain an exception or error as value. Use
     * {@link FacesWebApplicationContextUtils} for convenient lookup of the root
     * WebApplicationContext.
     * </p>
     */
    String ROOT_FACES_WEB_APPLICATION_CONTEXT_ATTRIBUTE = FacesWebApplicationContext.class
            + ".ROOT";

    /**
     * Scope identifier for application scope: "application". Similar to
     * standard scope "singleton".
     */
    String SCOPE_APPLICATION = ManagedBeanFactory.SCOPE_APPLICATION;

    /**
     * Scope identifier for none scope: "none". Similar to standard scope
     * "prototype".
     */
    String SCOPE_NONE = ManagedBeanFactory.SCOPE_NONE;

    /**
     * Sets the config locations. Should be config files compatible with the
     * "spring-beans.dtd", "spring-beans-2.0.dtd" respectively the schema
     * "spring-beans-2.0.xsd".
     * 
     * @param locations
     *            the config locations
     */
    void setFacesSpringConfigLocations(String[] locations);

}