Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * $Id: FacesContext.java,v 1.72 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;
 
 
 

FacesContext contains all of the per-request state information related to the processing of a single JavaServer Faces request, and the rendering of the corresponding response. It is passed to, and potentially modified by, each phase of the request processing lifecycle.

A FacesContext instance is associated with a particular request at the beginning of request processing, by a call to the getFacesContext() method of the FacesContextFactory instance associated with the current web application. The instance remains active until its release() method is called, after which no further references to this instance are allowed. While a FacesContext instance is active, it must not be referenced from any thread other than the one upon which the servlet container executing this web application utilizes for the processing of this request.

 
 
 public abstract class FacesContext {
 
 
     // -------------------------------------------------------------- Properties
 

    

Return the javax.faces.application.Application instance associated with this web application.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
 
     public abstract Application getApplication();


    

Return an Iterator over the client identifiers for which at least one javax.faces.application.FacesMessage has been queued. If there are no such client identifiers, an empty Iterator is returned. If any messages have been queued that were not associated with any specific client identifier, a null value will be included in the iterated values. The elements in the Iterator must be returned in the order in which they were added with addMessage(java.lang.String,javax.faces.application.FacesMessage).

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract Iterator<StringgetClientIdsWithMessages();

    

Return the ELContext instance for this FacesContext instance. This ELContext instance has the same lifetime and scope as the FacesContext instance with which it is associated, and may be created lazily the first time this method is called for a given FacesContext instance. Upon creation of the ELContext instance, the implementation must take the following action:

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
Since:
1.2
 
    public ELContext getELContext() {
        FacesContext impl;
        if (null != (impl = (FacesContextgetExternalContext().getRequestMap().
                get("com.sun.faces.FacesContextImpl"))) {
            //noinspection TailRecursion
            return impl.getELContext();
        }
        throw new UnsupportedOperationException();
    }
    
    

Return the ExternalContext instance for this FacesContext instance.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract ExternalContext getExternalContext();


    

Return the maximum severity level recorded on any javax.faces.application.FacesMessages that has been queued, whether or not they are associated with any specific javax.faces.component.UIComponent. If no such messages have been queued, return null.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract Severity getMaximumSeverity();


    

Return an Iterator over the javax.faces.application.FacesMessages that have been queued, whether or not they are associated with any specific client identifier. If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to addMessage(java.lang.String,javax.faces.application.FacesMessage).

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract Iterator<FacesMessagegetMessages();


    

Return an Iterator over the javax.faces.application.FacesMessages that have been queued that are associated with the specified client identifier (if clientId is not null), or over the javax.faces.application.FacesMessages that have been queued that are not associated with any specific client identifier (if clientId is null). If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to addMessage(java.lang.String,javax.faces.application.FacesMessage).

Parameters:
clientId The client identifier for which messages are requested, or null for messages not associated with any client identifier
Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract Iterator<FacesMessagegetMessages(String clientId);


    

Return the javax.faces.render.RenderKit instance for the render kit identifier specified on our javax.faces.component.UIViewRoot, if there is one. If there is no current javax.faces.component.UIViewRoot, if the javax.faces.component.UIViewRoot does not have a specified renderKitId, or if there is no javax.faces.render.RenderKit for the specified identifier, return null instead.

    public abstract RenderKit getRenderKit();


    

Return true if the renderResponse() method has been called for the current request.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract boolean getRenderResponse();


    

Return true if the responseComplete() method has been called for the current request.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract boolean getResponseComplete();


    

Return the ResponseStream to which components should direct their binary output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract ResponseStream getResponseStream();


    

Set the ResponseStream to which components should direct their binary output.

Parameters:
responseStream The new ResponseStream for this response
Throws:
java.lang.NullPointerException if responseStream is null
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract void setResponseStream(ResponseStream responseStream);


    

Return the ResponseWriter to which components should direct their character-based output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract ResponseWriter getResponseWriter();


    

Set the ResponseWriter to which components should direct their character-based output.

Parameters:
responseWriter The new ResponseWriter for this response
Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
java.lang.NullPointerException if responseWriter is null
    public abstract void setResponseWriter(ResponseWriter responseWriter);


    

Return the root component that is associated with the this request.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract UIViewRoot getViewRoot();


    

Set the root component that is associated with this request. This method can only be called by the application handler (or a class that the handler calls), and only during the Invoke Application phase of the request processing lifecycle.

Parameters:
root The new component javax.faces.component.UIViewRoot component
Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
java.lang.NullPointerException if root is null
    public abstract void setViewRoot(UIViewRoot root);
    // ---------------------------------------------------------- Public Methods


    

Append a javax.faces.application.FacesMessage to the set of messages associated with the specified client identifier, if clientId is not null. If clientId is null, this javax.faces.application.FacesMessage is assumed to not be associated with any specific component instance.

Parameters:
clientId The client identifier with which this message is associated (if any)
message The message to be appended
Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
java.lang.NullPointerException if message is null
    public abstract void addMessage(String clientIdFacesMessage message);


    

Release any resources associated with this FacesContext instance. Faces implementations may choose to pool instances in the associated FacesContextFactory to avoid repeated object creation and garbage collection. After release() is called on a FacesContext instance (until the FacesContext instance has been recycled by the implementation for re-use), calling any other methods will cause an IllegalStateException to be thrown.

The implementation must call setCurrentInstance(javax.faces.context.FacesContext) passing null to remove the association between this thread and this dead FacesContext instance.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract void release();


    

Signal the JavaServer faces implementation that, as soon as the current phase of the request processing lifecycle has been completed, control should be passed to the Render Response phase, bypassing any phases that have not been executed yet.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract void renderResponse();


    

Signal the JavaServer Faces implementation that the HTTP response for this request has already been generated (such as an HTTP redirect), and that the request processing lifecycle should be terminated as soon as the current phase is completed.

Throws:
java.lang.IllegalStateException if this method is called after this instance has been released
    public abstract void responseComplete();
    // ---------------------------------------------------------- Static Methods


    

The ThreadLocal variable used to record the FacesContext instance for each processing thread.

    private static ThreadLocal<FacesContextinstance = new ThreadLocal<FacesContext>() {
            protected FacesContext initialValue() { return (null); }
        };


    

Return the FacesContext instance for the request that is being processed by the current thread, if any.

    public static FacesContext getCurrentInstance() {
        return (.get());
    }


    

Set the FacesContext instance for the request that is being processed by the current thread.

Parameters:
context The FacesContext instance for the current thread, or null if this thread no longer has a FacesContext instance.
    protected static void setCurrentInstance(FacesContext context) {
        .set(context);
    }
New to GrepCode? Check out our FAQ X