org.apache.myfaces.renderkit.html
Class HtmlResponseStateManager

java.lang.Object
  extended by javax.faces.render.ResponseStateManager
      extended by org.apache.myfaces.renderkit.MyfacesResponseStateManager
          extended by org.apache.myfaces.renderkit.html.HtmlResponseStateManager

public class HtmlResponseStateManager
extends MyfacesResponseStateManager

Version:
$Revision: 1410173 $ $Date: 2012-11-15 21:52:41 -0500 (Thu, 15 Nov 2012) $
Author:
Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary
static String INIT_PARAM_HANDLE_STATE_CACHING_MECHANICS
          Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used.
static String STANDARD_STATE_SAVING_PARAM
           
 
Fields inherited from class javax.faces.render.ResponseStateManager
RENDER_KIT_ID_PARAM, VIEW_STATE_PARAM
 
Constructor Summary
HtmlResponseStateManager()
           
 
Method Summary
 Object getState(FacesContext facesContext, String viewId)
           
protected  StateCache getStateCache(FacesContext facesContext)
           
 String getViewState(FacesContext facesContext, Object baseState)
           
protected  boolean isHandlingStateCachingMechanics(FacesContext facesContext)
           
 boolean isPostback(FacesContext context)
          Checks if the current request is a postback
 boolean isWriteStateAfterRenderViewRequired(FacesContext facesContext)
          Indicates if the call to ResponseStateManager.writeState should be done after the view is fully rendered.
 void saveState(FacesContext facesContext, Object state)
          Execute additional operations like save the state on a cache when server side state saving is used.
 void writeState(FacesContext facesContext, Object state)
           
 
Methods inherited from class org.apache.myfaces.renderkit.MyfacesResponseStateManager
writeStateAsUrlParams
 
Methods inherited from class javax.faces.render.ResponseStateManager
getComponentStateToRestore, getTreeStructureToRestore, writeState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STANDARD_STATE_SAVING_PARAM

public static final String STANDARD_STATE_SAVING_PARAM
See Also:
Constant Field Values

INIT_PARAM_HANDLE_STATE_CACHING_MECHANICS

@JSFWebConfigParam(since="2.0.6",
                   expectedValues="true, false",
                   defaultValue="true",
                   group="state")
public static final String INIT_PARAM_HANDLE_STATE_CACHING_MECHANICS
Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used.

This param is used to keep compatibility with previous state managers implementations depending from old myfaces way to deal with this. For example, JspStateManagerImpl requires this param set to false, but by default it is set to true, to keep aligned with the Reference Implementation (RI). Note also the default StateManagerImpl requires this property set to true in order to work correctly, so if you set this param to false, please remember to add an entry into your faces-config.xml setting up JspStateManagerImpl as the state manager to use.

See Also:
Constant Field Values
Constructor Detail

HtmlResponseStateManager

public HtmlResponseStateManager()
Method Detail

isHandlingStateCachingMechanics

protected boolean isHandlingStateCachingMechanics(FacesContext facesContext)

writeState

public void writeState(FacesContext facesContext,
                       Object state)
                throws IOException
Overrides:
writeState in class ResponseStateManager
Throws:
IOException

saveState

public void saveState(FacesContext facesContext,
                      Object state)
Description copied from class: MyfacesResponseStateManager
Execute additional operations like save the state on a cache when server side state saving is used.

Overrides:
saveState in class MyfacesResponseStateManager

getState

public Object getState(FacesContext facesContext,
                       String viewId)
Overrides:
getState in class ResponseStateManager

isPostback

public boolean isPostback(FacesContext context)
Checks if the current request is a postback

Overrides:
isPostback in class ResponseStateManager
Since:
1.2

getViewState

public String getViewState(FacesContext facesContext,
                           Object baseState)
Overrides:
getViewState in class ResponseStateManager

isWriteStateAfterRenderViewRequired

public boolean isWriteStateAfterRenderViewRequired(FacesContext facesContext)
Description copied from class: MyfacesResponseStateManager
Indicates if the call to ResponseStateManager.writeState should be done after the view is fully rendered. Usually this is required for client side state saving, but it is not for server side state saving, because ResponseStateManager.writeState could render a just a marker and then StateManager.saveState could be called, preventing use an additional buffer.

Overrides:
isWriteStateAfterRenderViewRequired in class MyfacesResponseStateManager
Returns:

getStateCache

protected StateCache getStateCache(FacesContext facesContext)


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