Mojarra 2.4.0 · com.sun.faces.config.InitFacesContext

Modifier and Type	Field and Description
private Map<Object, Object>	attributes
private ELContext	elContext
private static final String	INIT_FACES_CONTEXT_ATTR_NAME
private static Logger	LOGGER
private ServletContextAdapter	servletContextAdapter
private UIViewRoot	viewRoot

Access	Constructor and Description
public	InitFacesContext(ServletContext servletContext)

Modifier and Type	Method and Description
public void	addInitContextEntryForCurrentThread()
public void	addServletContextEntryForInitContext(ServletContext servletContext)
public static void	cleanupInitMaps(ServletContext servletContext) Clean up entries from the threadInitContext and initContextServletContext maps using a ServletContext.
public Application	getApplication() Implements abstract javax.faces.context.FacesContext.getApplication. Return the `Application` instance associated with this web application.
public Map<Object, Object>	getAttributes() Overrides javax.faces.context.FacesContext.getAttributes. Return a mutable `Map` representing the attributes associated wth this `FacesContext` instance.
public ELContext	getELContext() Overrides javax.faces.context.FacesContext.getELContext. Return the `ELContext` instance for this `FacesContext` instance.
public ExternalContext	getExternalContext() Implements abstract javax.faces.context.FacesContext.getExternalContext. Return the `ExternalContext` instance for this `FacesContext` instance.
pack-priv static Map<InitFacesContext, ServletContext>	getInitContextServletContextMap()
public static InitFacesContext	getInstance(ServletContext servletContext)
pack-priv static Map<Thread, InitFacesContext>	getThreadInitContextMap()
public UIViewRoot	getViewRoot() Implements abstract javax.faces.context.FacesContext.getViewRoot. Return the root component that is associated with the this request.
public boolean	isProjectStage(ProjectStage the `ProjectStage` to check stage) Overrides javax.faces.context.FacesContext.isProjectStage. Return `true` if the current `ProjectStage` as returned by the `Application` instance is equal to `stage`, otherwise return `false`
public void	reInitializeExternalContext(ServletContext sc)
public void	release() Implements abstract javax.faces.context.FacesContext.release. Release any resources associated with this `FacesContext` instance.
public void	releaseCurrentInstance()
public void	removeInitContextEntryForCurrentThread()
public void	removeServletContextEntryForInitContext()
public void	setELContext(ELContext elContext)

attributes	back to summary
private Map<Object, Object> attributes

elContext	back to summary
private ELContext elContext

INIT_FACES_CONTEXT_ATTR_NAME	back to summary
private static final String INIT_FACES_CONTEXT_ATTR_NAME

LOGGER	back to summary
private static Logger LOGGER

servletContextAdapter	back to summary
private ServletContextAdapter servletContextAdapter

viewRoot	back to summary
private UIViewRoot viewRoot

InitFacesContext	back to summary
public InitFacesContext(ServletContext servletContext)

Method Detail

addInitContextEntryForCurrentThread	back to summary
public void addInitContextEntryForCurrentThread()

addServletContextEntryForInitContext	back to summary
public void addServletContextEntryForInitContext(ServletContext servletContext)

cleanupInitMaps	back to summary
public static void cleanupInitMaps(ServletContext servletContext) Clean up entries from the threadInitContext and initContextServletContext maps using a ServletContext. First remove entry(s) with matching ServletContext from initContextServletContext map. Then remove entries from threadInitContext map where the entry value(s) match the initFacesContext (associated with the ServletContext).

getApplication back to summary

getApplication	back to summary
public Application getApplication() Implements abstract javax.faces.context.FacesContext.getApplication. Doc from javax.faces.context.FacesContext.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. Returns:Application the `Application` instance associated with this web application. Annotations @Override

public Application getApplication()

Implements abstract javax.faces.context.FacesContext.getApplication.

Doc from javax.faces.context.FacesContext.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.

Returns:Application

the Application instance associated with this web application.

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public Map<Object, Object> getAttributes() Overrides javax.faces.context.FacesContext.getAttributes. Doc from javax.faces.context.FacesContext.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. Returns:Map<Object, Object> mutable `Map` representing the attributes associated wth this `FacesContext` instance. Annotations @Override

public Map<Object, Object> getAttributes()

Overrides javax.faces.context.FacesContext.getAttributes.

Doc from javax.faces.context.FacesContext.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.

Returns:Map<Object, Object>

mutable Map representing the attributes associated wth this FacesContext instance.

Annotations

@Override

getELContext back to summary

getELContext	back to summary
public ELContext getELContext() Overrides javax.faces.context.FacesContext.getELContext. Doc from javax.faces.context.FacesContext.getELContext. 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` method on the instance, passing in `FacesContext.class` and the `this` reference for the `FacesContext` instance itself. If the `Collection` returned by `javax.faces.application.Application#getELContextListeners` is non-empty, create an instance of `javax.el.ELContextEvent` and pass it to each `javax.el.ELContextListener` instance in the `Collection` by calling the `javax.el.ELContextListener#contextCreated` method. Returns:ELContext instance of `ELContext`. Annotations @Override

public ELContext getELContext()

Overrides javax.faces.context.FacesContext.getELContext.

Doc from javax.faces.context.FacesContext.getELContext.

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 method on the instance, passing in FacesContext.class and the this reference for the FacesContext instance itself.
If the Collection returned by javax.faces.application.Application#getELContextListeners is non-empty, create an instance of javax.el.ELContextEvent and pass it to each javax.el.ELContextListener instance in the Collection by calling the javax.el.ELContextListener#contextCreated method.

Returns:ELContext

instance of ELContext.

Annotations

@Override

getExternalContext back to summary

getExternalContext	back to summary
public ExternalContext getExternalContext() Implements abstract javax.faces.context.FacesContext.getExternalContext. Doc from javax.faces.context.FacesContext.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. Returns:ExternalContext instance of `ExternalContext` Annotations @Override

public ExternalContext getExternalContext()

Implements abstract javax.faces.context.FacesContext.getExternalContext.

Doc from javax.faces.context.FacesContext.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.

Returns:ExternalContext

instance of ExternalContext

Annotations

@Override

getInitContextServletContextMap	back to summary
pack-priv static Map<InitFacesContext, ServletContext> getInitContextServletContextMap() Annotations @SuppressWarnings:unchecked

getInstance	back to summary
public static InitFacesContext getInstance(ServletContext servletContext)

getThreadInitContextMap	back to summary
pack-priv static Map<Thread, InitFacesContext> getThreadInitContextMap() Annotations @SuppressWarnings:unchecked

getViewRoot back to summary

getViewRoot	back to summary
public UIViewRoot getViewRoot() Implements abstract javax.faces.context.FacesContext.getViewRoot. Doc from javax.faces.context.FacesContext.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()`. Returns:UIViewRoot `UIViewRoot` instance. Annotations @Override

public UIViewRoot getViewRoot()

Implements abstract javax.faces.context.FacesContext.getViewRoot.

Doc from javax.faces.context.FacesContext.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().

Returns:UIViewRoot

UIViewRoot instance.

Annotations

@Override

isProjectStage back to summary

isProjectStage	back to summary
public boolean isProjectStage(ProjectStage stage) Overrides javax.faces.context.FacesContext.isProjectStage. Doc from javax.faces.context.FacesContext.isProjectStage. Return `true` if the current `ProjectStage` as returned by the `Application` instance is equal to `stage`, otherwise return `false` Parameters stage:ProjectStage the `ProjectStage` to check Returns:boolean boolean indicating whether the application has the same stage. Annotations @Override

public boolean isProjectStage(ProjectStage stage)

Overrides javax.faces.context.FacesContext.isProjectStage.

Doc from javax.faces.context.FacesContext.isProjectStage.

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

Parameters

stage:ProjectStage: the ProjectStage to check

Returns:boolean

boolean indicating whether the application has the same stage.

Annotations

@Override

reInitializeExternalContext	back to summary
public void reInitializeExternalContext(ServletContext sc)

release back to summary

release	back to summary
public void release() Implements abstract javax.faces.context.FacesContext.release. Doc from javax.faces.context.FacesContext.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. Annotations @Override

public void release()

Implements abstract javax.faces.context.FacesContext.release.

Doc from javax.faces.context.FacesContext.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.

Annotations

@Override

releaseCurrentInstance	back to summary
public void releaseCurrentInstance()

removeInitContextEntryForCurrentThread	back to summary
public void removeInitContextEntryForCurrentThread()

removeServletContextEntryForInitContext	back to summary
public void removeServletContextEntryForInitContext()

setELContext	back to summary
public void setELContext(ELContext elContext)

public Class InitFacesContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail