org.springframework.faces.webflow

Class FlowResponseStateManager

java.lang.Object

javax.faces.render.ResponseStateManager

org.springframework.faces.support.ResponseStateManagerWrapper

org.springframework.faces.webflow.FlowResponseStateManager

All Implemented Interfaces:

javax.faces.FacesWrapper<javax.faces.render.ResponseStateManager>

public class FlowResponseStateManager
extends ResponseStateManagerWrapper

A custom ResponseStateManager that writes JSF state to a Web Flow managed view-scoped variable. This class is plugged in via FlowRenderKit.

Since:

2.2.0

Author:

Rossen Stoyanchev, Phillip Webb

Field Summary

Fields inherited from class javax.faces.render.ResponseStateManager

CLIENT_WINDOW_PARAM, CLIENT_WINDOW_URL_PARAM, NON_POSTBACK_VIEW_TOKEN_PARAM, RENDER_KIT_ID_PARAM, VIEW_STATE_PARAM

Constructor Summary

Constructors

Constructor and Description
FlowResponseStateManager(javax.faces.render.ResponseStateManager wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getState(javax.faces.context.FacesContext facesContext, java.lang.String viewId)
java.lang.String	getViewState(javax.faces.context.FacesContext facesContext, java.lang.Object state) This method returns the flow execution key to be used as the value for the "javax.faces.ViewState" hidden input field.
javax.faces.render.ResponseStateManager	getWrapped()
void	writeState(javax.faces.context.FacesContext facesContext, java.lang.Object state)

Methods inherited from class org.springframework.faces.support.ResponseStateManagerWrapper

getComponentStateToRestore, getTreeStructureToRestore, isPostback, writeState

Methods inherited from class javax.faces.render.ResponseStateManager

getCryptographicallyStrongTokenFromSession, isStateless

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowResponseStateManager

public FlowResponseStateManager(javax.faces.render.ResponseStateManager wrapped)

Method Detail

getWrapped

public javax.faces.render.ResponseStateManager getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<javax.faces.render.ResponseStateManager>

Specified by:

getWrapped in class ResponseStateManagerWrapper

writeState

public void writeState(javax.faces.context.FacesContext facesContext,
              java.lang.Object state)
                throws java.io.IOException

Overrides:

writeState in class ResponseStateManagerWrapper

Throws:

java.io.IOException

getState

public java.lang.Object getState(javax.faces.context.FacesContext facesContext,
                        java.lang.String viewId)

Overrides:

getState in class ResponseStateManagerWrapper

getViewState

public java.lang.String getViewState(javax.faces.context.FacesContext facesContext,
                            java.lang.Object state)

This method returns the flow execution key to be used as the value for the "javax.faces.ViewState" hidden input field. The value of this key is not important because JSF state is stored in a Web Flow managed view scoped variable. However the presence of the view state parameter alone is important for triggering actions. Hence we return the most logical value, which is the flow execution key.

Overrides:

getViewState in class ResponseStateManagerWrapper