Home » Mojarra-2.0.1 » javax » faces » context » [javadoc | source]
javax.faces.context
abstract public class: FacesContext [javadoc | source]
java.lang.Object
   javax.faces.context.FacesContext

Direct Known Subclasses:
    FacesContextWrapper

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.

Method from javax.faces.context.FacesContext Summary:
addMessage,   getApplication,   getAttributes,   getClientIdsWithMessages,   getCurrentInstance,   getCurrentPhaseId,   getELContext,   getExceptionHandler,   getExternalContext,   getMaximumSeverity,   getMessageList,   getMessageList,   getMessages,   getMessages,   getPartialViewContext,   getRenderKit,   getRenderResponse,   getResponseComplete,   getResponseStream,   getResponseWriter,   getViewRoot,   isPostback,   isProcessingEvents,   isProjectStage,   isValidationFailed,   release,   renderResponse,   responseComplete,   setCurrentInstance,   setCurrentPhaseId,   setExceptionHandler,   setProcessingEvents,   setResponseStream,   setResponseWriter,   setViewRoot,   validationFailed
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.faces.context.FacesContext Detail:
 abstract public  void addMessage(String clientId,
    FacesMessage message)
 abstract public Application getApplication()

    Return the Application instance associated with this web application.

    It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, returns the correct current javax.faces.application.Application instance.

 public Map<Object, Object> getAttributes() 

    Return a mutable Map representing the attributes associated wth this FacesContext instance. This Map is useful to store attributes that you want to go out of scope when the Faces lifecycle for the current request ends, which is not always the same as the request ending, especially in the case of Servlet filters that are invoked after the Faces lifecycle for this request completes. Accessing this Map does not cause any events to fire, as is the case with the other maps: for request, session, and application scope. When #release() is invoked, the attributes must be cleared.

    The Map returned by this method is not associated with the request. If you would like to get or set request attributes, see ExternalContext#getRequestMap .

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

 abstract public Iterator<String> getClientIdsWithMessages()

    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 .

 public static FacesContext getCurrentInstance() 

    Return the FacesContext instance for the request that is being processed by the current thread. If called during application initialization or shutdown, any method documented as "valid to call this method during application startup or shutdown" must be supported during application startup or shutdown time. The result of calling a method during application startup or shutdown time that does not have this designation is undefined.

 public PhaseId getCurrentPhaseId() 

    Return the value last set on this FacesContext instance when #setCurrentPhaseId was called.

 public ELContext getELContext() 
 public ExceptionHandler getExceptionHandler() 
 abstract public ExternalContext getExternalContext()

    Return the ExternalContext instance for this FacesContext instance.

    It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns an ExternalContext instance with the special behaviors indicated in the javadoc for that class. Methods document as being valid to call during application startup or shutdown must be supported.

 abstract public Severity getMaximumSeverity()
 public List<FacesMessage> getMessageList() 

    Like #getMessages , but returns a List<FacesMessage>, enabling use from EL expressions.

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

 public List<FacesMessage> getMessageList(String clientId) 

    Like #getMessages(java.lang.String) , but returns a List<FacesMessage> of messages for the component with client id matching argument clientId.

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

 abstract public Iterator<FacesMessage> getMessages()

    Return an Iterator over the javax.faces.application.FacesMessage s 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 .

 abstract public Iterator<FacesMessage> getMessages(String clientId)

    Return an Iterator over the javax.faces.application.FacesMessage s that have been queued that are associated with the specified client identifier (if clientId is not null), or over the javax.faces.application.FacesMessage s 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 .

 public PartialViewContext getPartialViewContext() 

    Return the PartialViewContext for this request. The PartialViewContext is used to control the processing of specified components during the execute portion of the request processing lifecycle (known as partial processing) and the rendering of specified components (known as partial rendering). This method must return a new PartialViewContext if one does not already exist.

 abstract public RenderKit getRenderKit()

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

 abstract public boolean getRenderResponse()

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

 abstract public boolean getResponseComplete()

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

 abstract public ResponseStream getResponseStream()

    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.

 abstract public ResponseWriter getResponseWriter()

    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.

 abstract public UIViewRoot getViewRoot()

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

    It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns a new UIViewRoot with its locale set to Locale.getDefault().

 public boolean isPostback() 
 public boolean isProcessingEvents() 

    Returns a flag indicating whether or not the runtime should publish events when asked to do so.

 public boolean isProjectStage(ProjectStage stage) 

    Return true if the current ProjectStage as returned by the Application instance is equal to stage, otherwise return false

 public boolean isValidationFailed() 

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

 abstract public  void release()

    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.

    If a call was made to #getAttributes during the processing for this request, the implementation must call clear() on the Map returned from getAttributes(), and then de-allocate the data-structure behind that Map.

    The implementation must call #setCurrentInstance passing null to remove the association between this thread and this dead FacesContext instance.

 abstract public  void renderResponse()

    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.

 abstract public  void responseComplete()

    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.

 protected static  void setCurrentInstance(FacesContext context) 

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

 public  void setCurrentPhaseId(PhaseId currentPhaseId) 

    The implementation must call this method at the earliest possble point in time after entering into a new phase in the request processing lifecycle.

 public  void setExceptionHandler(ExceptionHandler exceptionHandler) 
 public  void setProcessingEvents(boolean processingEvents) 
 abstract public  void setResponseStream(ResponseStream responseStream)

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

 abstract public  void setResponseWriter(ResponseWriter responseWriter)

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

 abstract public  void setViewRoot(UIViewRoot root)

    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.

    If the current UIViewRoot is non-null, and calling equals() on the argument root, passing the current UIViewRoot returns false, the clear method must be called on the Map returned from UIViewRoot#getViewMap .

 public  void validationFailed() 

    Sets a flag which indicates that a conversion or validation error occurred while processing the inputs. Inputs consist of either page parameters or form bindings. This flag can be read using #isValidationFailed .