Package org.apache.myfaces.context.servlet

Class FacesContextImplBase

java.lang.Object

jakarta.faces.context.FacesContext

org.apache.myfaces.context.servlet.FacesContextImplBase

Direct Known Subclasses:

FacesContextImpl, StartupFacesContextImpl

public abstract class FacesContextImplBase
extends FacesContext

Provides a base implementation of the FacesContext for the use in FacesContextImpl and StartupFacesContextImpl.

Version:

$Revision$ $Date$

Author:

Jakob Korherr (latest modification by $Author$)

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_released

Constructor Summary

Constructors

Constructor	Description
FacesContextImplBase(ExternalContext externalContext, ExternalContext defaultExternalContext)	Base constructor.
FacesContextImplBase(ExternalContext externalContext, ExternalContext defaultExternalContext, ApplicationFactory applicationFactory, RenderKitFactory renderKitFactory)

Method Summary

Modifier and Type	Method	Description
protected void	assertNotReleased()	has to be thrown in many of the methods if the method is called after the instance has been released!
Application	getApplication()
Map<Object,Object>	getAttributes()	Returns a mutable map of attributes associated with this faces context when FacesContext.release() is called the map must be cleared! Note this map is not associated with the request map the request map still is accessible via the ExternalContext.getRequestMap() method! Also the scope is different to the request map, this map has the scope of the context, and is cleared once the release method on the context is called! Also the map does not cause any events according to the spec!
protected FacesContext	getCurrentFacesContext()
jakarta.el.ELContext	getELContext()
ExceptionHandler	getExceptionHandler()
ExternalContext	getExternalContext()
char	getNamingContainerSeparatorChar()
RenderKit	getRenderKit()
List<String>	getResourceLibraryContracts()
UIViewRoot	getViewRoot()
boolean	isProcessingEvents()
boolean	isReleased()
void	purgeFacesContext()
void	release()	Releases the instance fields on FacesContextImplBase.
void	setExceptionHandler(ExceptionHandler exceptionHandler)
void	setProcessingEvents(boolean processingEvents)
void	setResourceLibraryContracts(List<String> contracts)
void	setViewRoot(UIViewRoot viewRoot)

Methods inherited from class jakarta.faces.context.FacesContext

addMessage, getClientIdsWithMessages, getCurrentInstance, getCurrentPhaseId, getLifecycle, getMaximumSeverity, getMessageList, getMessageList, getMessages, getMessages, getPartialViewContext, getRenderResponse, getResponseComplete, getResponseStream, getResponseWriter, isPostback, isProjectStage, isValidationFailed, renderResponse, responseComplete, setCurrentInstance, setCurrentPhaseId, setResponseStream, setResponseWriter, validationFailed

Methods inherited from class java.lang.Object

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

Field Detail

_released

protected boolean _released

Constructor Detail

FacesContextImplBase

public FacesContextImplBase(ExternalContext externalContext,
                            ExternalContext defaultExternalContext)

Base constructor. Calls FacesContext.setCurrentInstance(this);

FacesContextImplBase

public FacesContextImplBase(ExternalContext externalContext,
                            ExternalContext defaultExternalContext,
                            ApplicationFactory applicationFactory,
                            RenderKitFactory renderKitFactory)

Method Detail

release

public void release()

Releases the instance fields on FacesContextImplBase. Must be called by sub-classes, when overriding it!

Specified by:

release in class FacesContext

isReleased

public boolean isReleased()

Overrides:

isReleased in class FacesContext

getExternalContext

public final ExternalContext getExternalContext()

Specified by:

getExternalContext in class FacesContext

getApplication

public final Application getApplication()

Specified by:

getApplication in class FacesContext

purgeFacesContext

public void purgeFacesContext()

getExceptionHandler

public final ExceptionHandler getExceptionHandler()

Overrides:

getExceptionHandler in class FacesContext

setExceptionHandler

public final void setExceptionHandler(ExceptionHandler exceptionHandler)

Overrides:

setExceptionHandler in class FacesContext

isProcessingEvents

public final boolean isProcessingEvents()

Overrides:

isProcessingEvents in class FacesContext

setProcessingEvents

public final void setProcessingEvents(boolean processingEvents)

Overrides:

setProcessingEvents in class FacesContext

getELContext

public final jakarta.el.ELContext getELContext()

Overrides:

getELContext in class FacesContext

getAttributes

public final Map<Object,Object> getAttributes()

Returns a mutable map of attributes associated with this faces context when FacesContext.release() is called the map must be cleared! Note this map is not associated with the request map the request map still is accessible via the ExternalContext.getRequestMap() method! Also the scope is different to the request map, this map has the scope of the context, and is cleared once the release method on the context is called! Also the map does not cause any events according to the spec!

Overrides:

getAttributes in class FacesContext

Throws:

IllegalStateException - if the current context already is released!

Since:

Faces 2.0

getViewRoot

public UIViewRoot getViewRoot()

Specified by:

getViewRoot in class FacesContext

setViewRoot

public final void setViewRoot(UIViewRoot viewRoot)

Specified by:

setViewRoot in class FacesContext

getRenderKit

public final RenderKit getRenderKit()

Specified by:

getRenderKit in class FacesContext

getResourceLibraryContracts

public List<String> getResourceLibraryContracts()

Overrides:

getResourceLibraryContracts in class FacesContext

setResourceLibraryContracts

public void setResourceLibraryContracts(List<String> contracts)

Overrides:

setResourceLibraryContracts in class FacesContext

getNamingContainerSeparatorChar

public char getNamingContainerSeparatorChar()

Overrides:

getNamingContainerSeparatorChar in class FacesContext

assertNotReleased

protected final void assertNotReleased()

has to be thrown in many of the methods if the method is called after the instance has been released!

getCurrentFacesContext

protected FacesContext getCurrentFacesContext()