javax.faces.context.FacesContextFactory Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* $Id: FacesContextFactory.java,v 1.19 2007/04/27 22:00:06 ofung Exp $
*/
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.context;
import javax.faces.FacesException;
import javax.faces.lifecycle.Lifecycle;
/**
* FacesContextFactory is a factory object that creates
* (if needed) and returns new {@link FacesContext} instances, initialized
* for the processing of the specified request and response objects.
* Implementations may take advantage of the calls to the
* release() method of the allocated {@link FacesContext}
* instances to pool and recycle them, rather than creating a new instance
* every time.
*
* There must be one FacesContextFactory instance per web
* application that is utilizing JavaServer Faces. This instance can be
* acquired, in a portable manner, by calling:
*
* FacesContextFactory factory = (FacesContextFactory)
* FactoryFinder.getFactory(FactoryFinder.FACES_CONTEXT_FACTORY);
*
*/
public abstract class FacesContextFactory {
/**
* Create (if needed) and return a {@link FacesContext} instance
* that is initialized for the processing of the specified request
* and response objects, utilizing the specified {@link Lifecycle}
* instance, for this web application.
*
* The implementation of this method must ensure that calls to the
* getCurrentInstance() method of {@link FacesContext},
* from the same thread that called this method, will return the same
* {@link FacesContext} instance until the release()
* method is called on that instance.
*
* @param context In servlet environments, the
* ServletContext that is associated with this web
* application
* @param request In servlet environments, the
* ServletRequest that is to be processed
* @param response In servlet environments, the
* ServletResponse that is to be processed
* @param lifecycle The {@link Lifecycle} instance being used
* to process this request
*
* @throws FacesException if a {@link FacesContext} cannot be
* constructed for the specified parameters
* @throws NullPointerException if any of the parameters
* are null
*/
public abstract FacesContext getFacesContext
(Object context, Object request,
Object response, Lifecycle lifecycle)
throws FacesException;
}