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

java.lang.Object
  extended by javax.faces.context.FacesContext
      extended by org.apache.myfaces.orchestra.lib.jsf._PortletFacesContextWrapper

public class _PortletFacesContextWrapper
extends javax.faces.context.FacesContext

Convenient class to wrap the current FacesContext in portlet environment.

Since:
1.4
Version:
$Revision: 922201 $ $Date: 2010-03-12 05:36:39 -0500 (Fri, 12 Mar 2010) $
Author:
Leonardo Uribe (latest modification by $Author: bommel $)

Constructor Summary
_PortletFacesContextWrapper(javax.faces.context.FacesContext facesContext, boolean install, boolean finit, String fnextToken, 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
 void addMessage(String clientId, javax.faces.application.FacesMessage message)
           
 javax.faces.application.Application getApplication()
           
 Iterator getClientIdsWithMessages()
           
 javax.el.ELContext getELContext()
           
 javax.faces.context.ExternalContext getExternalContext()
           
 javax.faces.application.FacesMessage.Severity getMaximumSeverity()
           
 Iterator getMessages()
           
 Iterator getMessages(String clientId)
           
 javax.faces.render.RenderKit getRenderKit()
           
 boolean getRenderResponse()
           
 boolean getResponseComplete()
           
 javax.faces.context.ResponseStream getResponseStream()
           
 javax.faces.context.ResponseWriter getResponseWriter()
           
 javax.faces.component.UIViewRoot getViewRoot()
           
 void release()
           
 void renderResponse()
           
 void responseComplete()
           
 void setResponseStream(javax.faces.context.ResponseStream responsestream)
           
 void setResponseWriter(javax.faces.context.ResponseWriter responsewriter)
           
 void setViewRoot(javax.faces.component.UIViewRoot viewRoot)
           
 
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,
                                   String fnextToken,
                                   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()
Specified by:
release in class javax.faces.context.FacesContext

getApplication

public final javax.faces.application.Application getApplication()
Specified by:
getApplication in class javax.faces.context.FacesContext

getClientIdsWithMessages

public final Iterator getClientIdsWithMessages()
Specified by:
getClientIdsWithMessages in class javax.faces.context.FacesContext

getExternalContext

public javax.faces.context.ExternalContext getExternalContext()
Specified by:
getExternalContext in class javax.faces.context.FacesContext

getMaximumSeverity

public final javax.faces.application.FacesMessage.Severity getMaximumSeverity()
Specified by:
getMaximumSeverity in class javax.faces.context.FacesContext

getMessages

public final Iterator getMessages()
Specified by:
getMessages in class javax.faces.context.FacesContext

getMessages

public final Iterator getMessages(String clientId)
Specified by:
getMessages in class javax.faces.context.FacesContext

getRenderKit

public final javax.faces.render.RenderKit getRenderKit()
Specified by:
getRenderKit in class javax.faces.context.FacesContext

getRenderResponse

public final boolean getRenderResponse()
Specified by:
getRenderResponse in class javax.faces.context.FacesContext

getResponseComplete

public final boolean getResponseComplete()
Specified by:
getResponseComplete in class javax.faces.context.FacesContext

setResponseStream

public final void setResponseStream(javax.faces.context.ResponseStream responsestream)
Specified by:
setResponseStream in class javax.faces.context.FacesContext

getResponseStream

public final javax.faces.context.ResponseStream getResponseStream()
Specified by:
getResponseStream in class javax.faces.context.FacesContext

setResponseWriter

public final void setResponseWriter(javax.faces.context.ResponseWriter responsewriter)
Specified by:
setResponseWriter in class javax.faces.context.FacesContext

getResponseWriter

public final javax.faces.context.ResponseWriter getResponseWriter()
Specified by:
getResponseWriter in class javax.faces.context.FacesContext

setViewRoot

public final void setViewRoot(javax.faces.component.UIViewRoot viewRoot)
Specified by:
setViewRoot in class javax.faces.context.FacesContext

getViewRoot

public final javax.faces.component.UIViewRoot getViewRoot()
Specified by:
getViewRoot in class javax.faces.context.FacesContext

addMessage

public final void addMessage(String clientId,
                             javax.faces.application.FacesMessage message)
Specified by:
addMessage in class javax.faces.context.FacesContext

renderResponse

public final void renderResponse()
Specified by:
renderResponse in class javax.faces.context.FacesContext

responseComplete

public final void responseComplete()
Specified by:
responseComplete in class javax.faces.context.FacesContext

getELContext

public final javax.el.ELContext getELContext()


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