com.webmethods.caf.faces.portlet

Class PortletFacesContext

java.lang.Object

javax.faces.context.FacesContext

javax.faces.context.FacesContextWrapper

com.webmethods.caf.faces.context.FacesContextWrapper

com.webmethods.caf.faces.context.BaseFacesContext

com.webmethods.caf.faces.portlet.PortletFacesContext

All Implemented Interfaces:

FacesWrapper<FacesContext>

public class PortletFacesContext
extends BaseFacesContext

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

A PortletFacesContext instance is associated with a particular request at the beginning of request processing, by a call to the getFacesContext() method of the PortletFacesContextFactory 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 PortletFacesContext 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PortletFacesContext.PortletExternalContext This class allows the Faces API to be unaware of the nature of its containing application environment.

Nested classes/interfaces inherited from class com.webmethods.caf.faces.context.BaseFacesContext

BaseFacesContext.BaseExternalContext

Field Summary

Fields

Modifier and Type	Field and Description
protected PortletFacesContext.PortletExternalContext	m_externalContext
protected javax.portlet.PortletConfig	m_portletConfig
protected javax.portlet.PortletContext	m_portletContext
protected javax.portlet.PortletRequest	m_request
protected javax.portlet.PortletResponse	m_response

Fields inherited from class com.webmethods.caf.faces.context.BaseFacesContext

m_application, m_elContext, m_released, m_stream, m_useCAFViewHandler, m_writer

Fields inherited from class com.webmethods.caf.faces.context.FacesContextWrapper

m_wrapped

Constructor Summary

Constructors

Constructor and Description
PortletFacesContext() Default constructor.
PortletFacesContext(FacesContext wrapped) Create a PortletFacesContext with a wrapped FacesContext.

Method Summary

Modifier and Type	Method and Description
ExternalContext	getExternalContext() Return the ExternalContext instance for this FacesContext instance.
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.
void	initialize(Object context, Object request, Object response) Initialize this PortletFacesContext with PortletConfig or PortletContext, PortletRequest and PortletResponse.
boolean	isPostback()
void	release() Release any resources associated with this PortletFacesContext instance.

Methods inherited from class com.webmethods.caf.faces.context.BaseFacesContext

addMessage, assertNotReleased, getApplication, getELContext, setResponseStream, setResponseWriter, useCAFViewHandler

Methods inherited from class com.webmethods.caf.faces.context.FacesContextWrapper

getWrapped, setWrapped

Methods inherited from class javax.faces.context.FacesContextWrapper

getAttributes, getClientIdsWithMessages, getCurrentPhaseId, getExceptionHandler, getMaximumSeverity, getMessageList, getMessageList, getMessages, getMessages, getNamingContainerSeparatorChar, getPartialViewContext, getRenderKit, getRenderResponse, getResourceLibraryContracts, getResponseComplete, getViewRoot, isProcessingEvents, isProjectStage, isReleased, isValidationFailed, renderResponse, responseComplete, setCurrentPhaseId, setExceptionHandler, setProcessingEvents, setResourceLibraryContracts, setViewRoot, validationFailed

Methods inherited from class javax.faces.context.FacesContext

getCurrentInstance, setCurrentInstance

Methods inherited from class java.lang.Object

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

Field Detail

m_portletContext

protected javax.portlet.PortletContext m_portletContext

m_portletConfig

protected javax.portlet.PortletConfig m_portletConfig

m_request

protected javax.portlet.PortletRequest m_request

m_response

protected javax.portlet.PortletResponse m_response

m_externalContext

protected PortletFacesContext.PortletExternalContext m_externalContext

Constructor Detail

PortletFacesContext

public PortletFacesContext()

Default constructor.

PortletFacesContext

public PortletFacesContext(FacesContext wrapped)

Create a PortletFacesContext with a wrapped FacesContext.

Parameters:

wrapped - FacesContext

Method Detail

getExternalContext

public ExternalContext getExternalContext()

Return the ExternalContext instance for this FacesContext instance.

Overrides:

getExternalContext in class FacesContextWrapper

isPostback

public boolean isPostback()

Overrides:

isPostback in class FacesContextWrapper

getResponseStream

public ResponseStream getResponseStream()

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

Overrides:

getResponseStream in class BaseFacesContext

getResponseWriter

public ResponseWriter getResponseWriter()

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

Overrides:

getResponseWriter in class BaseFacesContext

release

public void release()

Release any resources associated with this PortletFacesContext instance.

Overrides:

release in class BaseFacesContext

initialize

public void initialize(Object context,
                       Object request,
                       Object response)

Initialize this PortletFacesContext with PortletConfig or PortletContext, PortletRequest and PortletResponse.

Parameters:

context - PortletConfig or PortletContext

request - PortletRequest

response - PortletResponse