Module jakarta.faces

Package com.sun.faces.context

Class FacesContextImpl

java.lang.Object

jakarta.faces.context.FacesContext

com.sun.faces.context.FacesContextImpl

public class FacesContextImpl
extends FacesContext

Constructor Summary

Constructors

Constructor	Description
FacesContextImpl(ExternalContext ec, Lifecycle lifecycle)

Method Summary

Modifier and Type	Method	Description
void	addMessage(String clientId, FacesMessage message)	Append a FacesMessage to the set of messages associated with the specified client identifier, if clientId is not null.
Application	getApplication()	Return the Application instance associated with this web application.
Map<Object,Object>	getAttributes()	Return a mutable Map representing the attributes associated wth this FacesContext instance.
Iterator<String>	getClientIdsWithMessages()	Return an Iterator over the client identifiers for which at least one FacesMessage has been queued.
PhaseId	getCurrentPhaseId()	Return the value last set on this FacesContext instance when FacesContext.setCurrentPhaseId(jakarta.faces.event.PhaseId) was called.
static FacesContext	getDefaultFacesContext()
ELContext	getELContext()	Return the ELContext instance for this FacesContext instance.
ExceptionHandler	getExceptionHandler()	Return the ExceptionHandler for this request.
ExternalContext	getExternalContext()	Return the ExternalContext instance for this FacesContext instance.
Lifecycle	getLifecycle()	Return the Lifecycle instance for this FacesContext instance.
FacesMessage.Severity	getMaximumSeverity()	Return the maximum severity level recorded on any FacesMessages that has been queued, whether or not they are associated with any specific UIComponent.
List<FacesMessage>	getMessageList()	Like FacesContext.getMessages(), but returns a List<FacesMessage>, enabling use from Jakarta Expression Language expressions.
List<FacesMessage>	getMessageList(String clientId)	Like FacesContext.getMessages(java.lang.String), but returns a List<FacesMessage> of messages for the component with client id matching argument clientId.
Iterator<FacesMessage>	getMessages()	Return an Iterator over the FacesMessages that have been queued, whether or not they are associated with any specific client identifier.
Iterator<FacesMessage>	getMessages(String clientId)	Return an Iterator over the FacesMessages that have been queued that are associated with the specified client identifier (if clientId is not null), or over the FacesMessages that have been queued that are not associated with any specific client identifier (if clientId is null).
PartialViewContext	getPartialViewContext()	Return the PartialViewContext for this request.
RenderKit	getRenderKit()	Return the RenderKit instance for the render kit identifier specified on our UIViewRoot, if there is one.
boolean	getRenderResponse()	Return true if the renderResponse() method has been called for the current request.
List<String>	getResourceLibraryContracts()	Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts.
boolean	getResponseComplete()	Return true if the responseComplete() method has been called for the current request.
ResponseStream	getResponseStream()	Return the ResponseStream to which components should direct their binary output.
ResponseWriter	getResponseWriter()	Return the ResponseWriter to which components should direct their character-based output.
UIViewRoot	getViewRoot()	Return the root component that is associated with the this request.
boolean	isPostback()	This utility method simply returns the result of ResponseStateManager.isPostback(FacesContext).
boolean	isReleased()	Return a flag indicating if the resources associated with this FacesContext instance have been released.
boolean	isValidationFailed()	Return true if the validationFailed() method has been called for the current request.
void	release()	Release any resources associated with this FacesContext instance.
void	renderResponse()	Signal the Jakarta 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.
void	responseComplete()	Signal the Jakarta 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.
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.
void	setExceptionHandler(ExceptionHandler exceptionHandler)	Set the ExceptionHandler for this request.
void	setResourceLibraryContracts(List<String> contracts)	Set the resource library contracts calculated as valid to use with this view.
void	setResponseStream(ResponseStream responseStream)	Set the ResponseStream to which components should direct their binary output.
void	setResponseWriter(ResponseWriter responseWriter)	Set the ResponseWriter to which components should direct their character-based output.
void	setViewRoot(UIViewRoot root)	Set the root component that is associated with this request.
void	validationFailed()	Sets a flag which indicates that a conversion or validation error occurred while processing the inputs.

Methods inherited from class jakarta.faces.context.FacesContext

getCurrentInstance, getNamingContainerSeparatorChar, isProcessingEvents, isProjectStage, setCurrentInstance, setProcessingEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FacesContextImpl

public FacesContextImpl(ExternalContext ec,
 Lifecycle lifecycle)

Method Details

getLifecycle

public Lifecycle getLifecycle()

Description copied from class: FacesContext

Return the Lifecycle instance for this FacesContext instance.

Specified by:

getLifecycle in class FacesContext

Returns:

instance of Lifecycle

See Also:

• FacesContext.getLifecycle()

getExternalContext

public ExternalContext getExternalContext()

Description copied from class: FacesContext

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.

Specified by:

getExternalContext in class FacesContext

Returns:

instance of ExternalContext

See Also:

• FacesContext.getExternalContext()

getApplication

public Application getApplication()

Description copied from class: FacesContext

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 Application instance.

Specified by:

getApplication in class FacesContext

Returns:

the Application instance associated with this web application.

See Also:

• FacesContext.getApplication()

getExceptionHandler

public ExceptionHandler getExceptionHandler()

Description copied from class: FacesContext

Return the ExceptionHandler for this request.

Overrides:

getExceptionHandler in class FacesContext

Returns:

instance of ExceptionHandler.

See Also:

• FacesContext.getExceptionHandler()

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Description copied from class: FacesContext

Set the ExceptionHandler for this request.

Overrides:

setExceptionHandler in class FacesContext

Parameters:

exceptionHandler - the ExceptionHandler for this request.

See Also:

• FacesContext.setExceptionHandler(jakarta.faces.context.ExceptionHandler)

getPartialViewContext

public PartialViewContext getPartialViewContext()

Description copied from class: FacesContext

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.

Overrides:

getPartialViewContext in class FacesContext

Returns:

the instance of PartialViewContext for this request.

See Also:

• FacesContext.getPartialViewContext()

isPostback

public boolean isPostback()

Description copied from class: FacesContext

This utility method simply returns the result of ResponseStateManager.isPostback(FacesContext).

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

Overrides:

isPostback in class FacesContext

Returns:

the boolean indicating whether this request is a post one.

See Also:

• FacesContext.isPostback()

isReleased

public boolean isReleased()

Description copied from class: FacesContext

Return a flag indicating if the resources associated with this FacesContext instance have been released.

Overrides:

isReleased in class FacesContext

Returns:

true if the resources have been released.

See Also:

• FacesContext.isReleased()

getAttributes

public Map<Object,Object> getAttributes()

Description copied from class: FacesContext

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 Jakarta 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 FacesContext.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.

Overrides:

getAttributes in class FacesContext

Returns:

mutable Map representing the attributes associated wth this FacesContext instance.

See Also:

• FacesContext.getAttributes()

getELContext

public ELContext getELContext()

Description copied from class: FacesContext

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:

• Call the ELContext.putContext(java.lang.Class<?>, java.lang.Object) method on the instance, passing in FacesContext.class and the this reference for the FacesContext instance itself.

• If the Collection returned by Application.getELContextListeners() is non-empty, create an instance of ELContextEvent and pass it to each ELContextListener instance in the Collection by calling the ELContextListener.contextCreated(jakarta.el.ELContextEvent) method.

Overrides:

getELContext in class FacesContext

Returns:

instance of ELContext.

See Also:

• FacesContext.getELContext()

getClientIdsWithMessages

public Iterator<String> getClientIdsWithMessages()

Description copied from class: FacesContext

Return an Iterator over the client identifiers for which at least one 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 FacesContext.addMessage(java.lang.String, jakarta.faces.application.FacesMessage).

Specified by:

getClientIdsWithMessages in class FacesContext

Returns:

the Iterator over the client identifiers for which at least one FacesMessage has been queued.

See Also:

• FacesContext.getClientIdsWithMessages()

getMaximumSeverity

public FacesMessage.Severity getMaximumSeverity()

Description copied from class: FacesContext

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

Specified by:

getMaximumSeverity in class FacesContext

Returns:

the maximum severity level.

See Also:

• FacesContext.getMaximumSeverity()

getMessageList

public List<FacesMessage> getMessageList()

Description copied from class: FacesContext

Like FacesContext.getMessages(), but returns a List<FacesMessage>, enabling use from Jakarta Expression Language expressions.

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

Overrides:

getMessageList in class FacesContext

Returns:

an immutable List which is effectively a snapshot of the messages present at the time of invocation.

See Also:

• FacesContext.getMessageList()

getMessageList

public List<FacesMessage> getMessageList(String clientId)

Description copied from class: FacesContext

Like FacesContext.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.

Overrides:

getMessageList in class FacesContext

Parameters:

clientId - the client id of a component.

Returns:

an immutable List which is effectively a snapshot of the messages present at the time of invocation.

See Also:

• FacesContext.getMessageList(String)

getMessages

public Iterator<FacesMessage> getMessages()

Description copied from class: FacesContext

Return an Iterator over the 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 FacesContext.addMessage(java.lang.String, jakarta.faces.application.FacesMessage).

Specified by:

getMessages in class FacesContext

Returns:

Iterator over the FacesMessages that have been queued.

See Also:

• FacesContext.getMessages()

getMessages

public Iterator<FacesMessage> getMessages(String clientId)

Description copied from class: FacesContext

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

Specified by:

getMessages in class FacesContext

Parameters:

clientId - The client identifier for which messages are requested, or null for messages not associated with any client identifier

Returns:

Iterator over the FacesMessages.

See Also:

• FacesContext.getMessages(String)

getRenderKit

public RenderKit getRenderKit()

Description copied from class: FacesContext

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.

Specified by:

getRenderKit in class FacesContext

Returns:

instance of RenderKit associated with the UIViewRoot.

See Also:

• FacesContext.getRenderKit()

getResponseStream

public ResponseStream getResponseStream()

Description copied from class: FacesContext

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.

Specified by:

getResponseStream in class FacesContext

Returns:

ResponseStream instance.

See Also:

• FacesContext.getResponseStream()

setResponseStream

public void setResponseStream(ResponseStream responseStream)

Description copied from class: FacesContext

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

Specified by:

setResponseStream in class FacesContext

Parameters:

responseStream - The new ResponseStream for this response

See Also:

• FacesContext.setResponseStream(jakarta.faces.context.ResponseStream)

getViewRoot

public UIViewRoot getViewRoot()

Description copied from class: FacesContext

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().

Specified by:

getViewRoot in class FacesContext

Returns:

UIViewRoot instance.

See Also:

• FacesContext.getViewRoot()

setViewRoot

public void setViewRoot(UIViewRoot root)

Description copied from class: FacesContext

Set the root component that is associated with this request.

This method can be called by the application handler (or a class that the handler calls), during the Invoke Application phase of the request processing lifecycle and during the Restore View phase of the request processing lifecycle (especially when a new root component is created). In the present version of the specification, implementations are not required to enforce this restriction, though a future version of the specification may require enforcement.

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().

Specified by:

setViewRoot in class FacesContext

Parameters:

root - The new component UIViewRoot component

See Also:

• FacesContext.setViewRoot(jakarta.faces.component.UIViewRoot)

getResponseWriter

public ResponseWriter getResponseWriter()

Description copied from class: FacesContext

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.

Specified by:

getResponseWriter in class FacesContext

Returns:

ResponseWriter instance.

See Also:

• FacesContext.getResponseWriter()

setResponseWriter

public void setResponseWriter(ResponseWriter responseWriter)

Description copied from class: FacesContext

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

Specified by:

setResponseWriter in class FacesContext

Parameters:

responseWriter - The new ResponseWriter for this response

See Also:

• FacesContext.setResponseWriter(jakarta.faces.context.ResponseWriter)

addMessage

public void addMessage(String clientId,
 FacesMessage message)

Description copied from class: FacesContext

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

Specified by:

addMessage in class FacesContext

Parameters:

clientId - The client identifier with which this message is associated (if any)

message - The message to be appended

See Also:

• FacesContext.addMessage(String, jakarta.faces.application.FacesMessage)

getCurrentPhaseId

public PhaseId getCurrentPhaseId()

Description copied from class: FacesContext

Return the value last set on this FacesContext instance when FacesContext.setCurrentPhaseId(jakarta.faces.event.PhaseId) was called.

Overrides:

getCurrentPhaseId in class FacesContext

Returns:

the current phase id.

See Also:

• FacesContext.getCurrentPhaseId()

setCurrentPhaseId

public void setCurrentPhaseId(PhaseId currentPhaseId)

Description copied from class: FacesContext

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

Overrides:

setCurrentPhaseId in class FacesContext

Parameters:

currentPhaseId - The PhaseId for the current phase.

See Also:

• FacesContext.setCurrentPhaseId(jakarta.faces.event.PhaseId)

release

public void release()

Description copied from class: FacesContext

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 FacesContext.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 FacesContext.setCurrentInstance(jakarta.faces.context.FacesContext) passing null to remove the association between this thread and this dead FacesContext instance.

Specified by:

release in class FacesContext

See Also:

• FacesContext.release()

renderResponse

public void renderResponse()

Description copied from class: FacesContext

Signal the Jakarta 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.

Specified by:

renderResponse in class FacesContext

See Also:

• FacesContext.renderResponse()

responseComplete

public void responseComplete()

Description copied from class: FacesContext

Signal the Jakarta 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.

Specified by:

responseComplete in class FacesContext

See Also:

• FacesContext.responseComplete()

validationFailed

public void validationFailed()

Description copied from class: FacesContext

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 FacesContext.isValidationFailed().

Overrides:

validationFailed in class FacesContext

See Also:

• FacesContext.validationFailed()

getRenderResponse

public boolean getRenderResponse()

Description copied from class: FacesContext

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

Specified by:

getRenderResponse in class FacesContext

Returns:

flag indicating whether the renderResponse() has been called.

See Also:

• FacesContext.getRenderResponse()

getResourceLibraryContracts

public List<String> getResourceLibraryContracts()

Description copied from class: FacesContext

Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts. The list returned by this method must be immutable. For backward compatibility with implementations of the specification prior to when this method was introduced, an implementation is provided that returns an empty list. Implementations compliant with the version in which this method was introduced must implement this method as specified.

Overrides:

getResourceLibraryContracts in class FacesContext

Returns:

the list of resource library contracts.

setResourceLibraryContracts

public void setResourceLibraryContracts(List<String> contracts)

Description copied from class: FacesContext

Set the resource library contracts calculated as valid to use with this view. The implementation must copy the contents of the incoming List into an immutable List for return from FacesContext.getResourceLibraryContracts(). If the argument is null or empty, the action taken is the same as if the argument is null: a subsequent call to getResourceLibraryContracts returns null. This method may only be called during the processing of ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String) and during the VDL tag handler for the tag corresponding to an instance of UIViewRoot. For backward compatibility with implementations of the specification prior to when this method was introduced, an implementation is provided that takes no action. Implementations compliant with the version in which this method was introduced must implement this method as specified.

Overrides:

setResourceLibraryContracts in class FacesContext

Parameters:

contracts - The new contracts to be returned, as an immutable List. from a subsequent call to FacesContext.getResourceLibraryContracts().

getResponseComplete

public boolean getResponseComplete()

Description copied from class: FacesContext

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

Specified by:

getResponseComplete in class FacesContext

Returns:

the boolean indicating whether responseComplete() method has been called.

See Also:

• FacesContext.getResponseComplete()

isValidationFailed

public boolean isValidationFailed()

Description copied from class: FacesContext

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

Overrides:

isValidationFailed in class FacesContext

Returns:

boolean indicating if the validationFailed() method has been called for the current request

See Also:

• FacesContext.isValidationFailed()

getDefaultFacesContext

public static FacesContext getDefaultFacesContext()