org.apache.myfaces.orchestra.lib.jsf
Class _PortletFacesContextWrapper

java.lang.Object
  extended by javax.faces.context.FacesContext
      extended by javax.faces.context.FacesContextWrapper
          extended by org.apache.myfaces.orchestra.lib.jsf._PortletFacesContextWrapper
All Implemented Interfaces:
javax.faces.FacesWrapper<javax.faces.context.FacesContext>

public class _PortletFacesContextWrapper
extends javax.faces.context.FacesContextWrapper

Convenient class to wrap the current FacesContext in portlet environment.

Since:
1.4
Version:
$Revision: 798382 $ $Date: 2009-07-27 22:23:02 -0500 (lun, 27 jul 2009) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Constructor Summary
_PortletFacesContextWrapper(javax.faces.context.FacesContext facesContext, boolean install, boolean finit, java.lang.String fnextToken, java.util.List fhandlers, RequestHandler fcontextLockHandler)
          The install parameter controls whether this object will be configured as the object returned from calls to FacesContext.getCurrentInstance() or not.
 
Method Summary
 javax.faces.context.ExternalContext getExternalContext()
           
 javax.faces.context.FacesContext getWrapped()
           
 void release()
           
 
Methods inherited from class javax.faces.context.FacesContextWrapper
addMessage, getApplication, getAttributes, getClientIdsWithMessages, getCurrentPhaseId, getELContext, getExceptionHandler, getMaximumSeverity, getMessageList, getMessageList, getMessages, getMessages, getPartialViewContext, getRenderKit, getRenderResponse, getResponseComplete, getResponseStream, getResponseWriter, getViewRoot, isPostback, isProcessingEvents, isProjectStage, isValidationFailed, renderResponse, responseComplete, setCurrentPhaseId, setExceptionHandler, setProcessingEvents, setResponseStream, setResponseWriter, 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
 

Constructor Detail

_PortletFacesContextWrapper

public _PortletFacesContextWrapper(javax.faces.context.FacesContext facesContext,
                                   boolean install,
                                   boolean finit,
                                   java.lang.String fnextToken,
                                   java.util.List fhandlers,
                                   RequestHandler fcontextLockHandler)
The install parameter controls whether this object will be configured as the object returned from calls to FacesContext.getCurrentInstance() or not.

When only overriding the release() method, then install=false is ok as that is called directly by the FacesServlet on the instance returned by the FacesContextFactory. However all other methods are invoked on the object that is returned from FacesContext.getCurrentInstance, so install=true is needed in order for any other method overrides to have any effect.

IMPORTANT: install=true should not be used until MYFACES-1820 is fixed.

Method Detail

release

public void release()
Overrides:
release in class javax.faces.context.FacesContextWrapper

getWrapped

public javax.faces.context.FacesContext getWrapped()
Specified by:
getWrapped in interface javax.faces.FacesWrapper<javax.faces.context.FacesContext>
Overrides:
getWrapped in class javax.faces.context.FacesContextWrapper

getExternalContext

public javax.faces.context.ExternalContext getExternalContext()
Overrides:
getExternalContext in class javax.faces.context.FacesContextWrapper


Copyright © 2009 The Apache Software Foundation. All Rights Reserved.