javax.faces.context.FacesContextFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. 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.java.net/public/CDDL+GPL_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.FacesWrapper;
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);
*
*
* Usage: extend this class and push the implementation being wrapped to the
* constructor and use {@link #getWrapped} to access the instance being wrapped.
*
*/
public abstract class FacesContextFactory implements FacesWrapper {
private FacesContextFactory wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public FacesContextFactory() {
}
/**
* If this factory has been decorated,
* the implementation doing the decorating should push the implementation being wrapped to this constructor.
* The {@link #getWrapped()} will then return the implementation being wrapped.
*
* @param wrapped The implementation being wrapped.
*/
public FacesContextFactory(FacesContextFactory wrapped) {
this.wrapped = wrapped;
}
/**
* If this factory has been decorated, the
* implementation doing the decorating may override this method to provide
* access to the implementation being wrapped.
*
* @since 2.0
*/
@Override
public FacesContextFactory getWrapped() {
return wrapped;
}
/**
* 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.
* The implementation must call
* {@link ExternalContextFactory#getExternalContext} to produce the
* {@link ExternalContext} for the {@link FacesContext} instance.
* The default implementation must call
* {@link ExceptionHandlerFactory#getExceptionHandler} and make it
* so the return from that method is what gets returned from a call
* to {@link FacesContext#getExceptionHandler} on the returned
* FacesContext instance.
*
* The default implementation must call
* {@link javax.faces.lifecycle.ClientWindowFactory#getClientWindow} and make it
* so the return from that method is what gets returned from a call
* to {@link ExternalContext#getClientWindow()} on the returned
* ExternalContext 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
*
* @return the instance of FacesContext.
*
* @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;
}