Mojarra 2.4.0 · com.sun.faces.renderkit.ServerSideStateHelper

Field Summary

Modifier and Type	Field and Description
protected boolean	generateUniqueStateIds Flag determining how server state IDs are generated.
private static final Logger	LOGGER Hides com.sun.faces.renderkit.StateHelper.LOGGER.
public static final String	LOGICAL_VIEW_MAP The top level attribute name for storing the state structures within the session.
protected final Integer	numberOfLogicalViews The number of logical views as configured by the user.
protected final Integer	numberOfViews The number of views as configured by the user.
protected final SecureRandom	random Used to generate unique server state IDs.
public static final String	STATEMANAGED_SERIAL_ID_KEY Key to store the `AtomicInteger` used to generate unique state map keys.

Inherited from com.sun.faces.renderkit.StateHelper:: compressViewState fieldEnd fieldMiddle serialProvider stateFieldStart webConfig

Constructor Summary

Access	Constructor and Description
public	ServerSideStateHelper() Construct a new `ServerSideStateHelper` instance.

Method Summary

Modifier and Type	Method and Description
private String	Returns: a unique ID for building the keys used to store views within a session createIncrementalRequestId(FacesContext the `FacesContext` for the current request ctx)
private String	createRandomId()
protected Integer	Returns: the Integer representation of the parameter value getIntegerConfigValue(WebConfiguration.WebContextInitParameter the paramter to parse param) Utility method for obtaining the `Integer` based configuration values used to change the behavior of the `ServerSideStateHelper`.
public Object	getState(FacesContext ctx, String viewId) Implements abstract com.sun.faces.renderkit.StateHelper.getState. Inspects the incoming request parameters for the standardized state parameter name.
protected Object	Returns: an object that can be passed to `UIViewRoot.processRestoreState`. If `com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter#SerializeServerStateDeprecated` de-serialize the state prior to returning it, otherwise return `state` as is. handleRestoreState(Object the state as it was stored in the session state)
protected Object	Returns: If `com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter#SerializeServerStateDeprecated` is `true`, serialize and return the state, otherwise, return `state` unchanged. handleSaveState(Object the object returned from `UIView.processSaveState` state)
public boolean	Returns: true if stateless, false otherwise. isStateless(FacesContext the Faces context. facesContext, String the view id. viewId) Implements abstract com.sun.faces.renderkit.StateHelper.isStateless. Is stateless.
public void	writeState(FacesContext ctx, Object state, StringBuilder stateCapture) Implements abstract com.sun.faces.renderkit.StateHelper.writeState. Stores the provided state within the session obtained from the provided `FacesContext` If `stateCapture` is `null`, the composite key used to look up the actual and logical views will be written to the client as a hidden field using the `ResponseWriter` from the provided `FacesContext`.

Inherited from com.sun.faces.renderkit.StateHelper:: createAndStoreCryptographicallyStrongTokenInSession getCryptographicallyStrongTokenFromSession getStateParamValue writeClientWindowField writeRenderKitIdField

Field Detail

generateUniqueStateIds	back to summary
protected boolean generateUniqueStateIds Flag determining how server state IDs are generated.

LOGGER	back to summary
private static final Logger LOGGER Hides com.sun.faces.renderkit.StateHelper.LOGGER.

LOGICAL_VIEW_MAP	back to summary
public static final String LOGICAL_VIEW_MAP The top level attribute name for storing the state structures within the session.

numberOfLogicalViews	back to summary
protected final Integer numberOfLogicalViews The number of logical views as configured by the user.

numberOfViews	back to summary
protected final Integer numberOfViews The number of views as configured by the user.

random	back to summary
protected final SecureRandom random Used to generate unique server state IDs.

STATEMANAGED_SERIAL_ID_KEY	back to summary
public static final String STATEMANAGED_SERIAL_ID_KEY Key to store the `AtomicInteger` used to generate unique state map keys.

Constructor Detail

ServerSideStateHelper	back to summary
public ServerSideStateHelper() Construct a new `ServerSideStateHelper` instance.

Method Detail

createIncrementalRequestId	back to summary
private String createIncrementalRequestId(FacesContext ctx) Parameters ctx:FacesContext the `FacesContext` for the current request Returns:String a unique ID for building the keys used to store views within a session

createRandomId	back to summary
private String createRandomId()

getIntegerConfigValue back to summary

getIntegerConfigValue	back to summary
protected Integer getIntegerConfigValue(WebConfiguration.WebContextInitParameter param) Utility method for obtaining the `Integer` based configuration values used to change the behavior of the `ServerSideStateHelper`. Parameters param:WebConfiguration.WebContextInitParameter the paramter to parse Returns:Integer the Integer representation of the parameter value

protected Integer getIntegerConfigValue(WebConfiguration.WebContextInitParameter param)

Utility method for obtaining the Integer based configuration values used to change the behavior of the ServerSideStateHelper.

Parameters

param:WebConfiguration.WebContextInitParameter: the paramter to parse

Returns:Integer

the Integer representation of the parameter value

getState back to summary

getState	back to summary
public Object getState(FacesContext ctx, String viewId) Implements abstract com.sun.faces.renderkit.StateHelper.getState. Inspects the incoming request parameters for the standardized state parameter name. In this case, the parameter value will be the composite ID generated by ServerSideStateHelper#writeState(FacesContext, Object, StringBuilder). The composite key will be used to find the appropriate view within the session obtained from the provided `FacesContext` Annotations @Override

public Object getState(FacesContext ctx, String viewId)

Implements abstract com.sun.faces.renderkit.StateHelper.getState.

Inspects the incoming request parameters for the standardized state parameter name. In this case, the parameter value will be the composite ID generated by ServerSideStateHelper#writeState(FacesContext, Object, StringBuilder).

The composite key will be used to find the appropriate view within the session obtained from the provided FacesContext

Annotations

@Override

handleRestoreState	back to summary
protected Object handleRestoreState(Object state) Parameters state:Object the state as it was stored in the session Returns:Object an object that can be passed to `UIViewRoot.processRestoreState`. If `com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter#SerializeServerStateDeprecated` de-serialize the state prior to returning it, otherwise return `state` as is.

handleSaveState	back to summary
protected Object handleSaveState(Object state) Parameters state:Object the object returned from `UIView.processSaveState` Returns:Object If `com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter#SerializeServerStateDeprecated` is `true`, serialize and return the state, otherwise, return `state` unchanged.

isStateless	back to summary
public boolean isStateless(FacesContext facesContext, String viewId) throws IllegalStateException Implements abstract com.sun.faces.renderkit.StateHelper.isStateless. Is stateless. Parameters facesContext:FacesContext the Faces context. viewId:String the view id. Returns:boolean true if stateless, false otherwise. Annotations @Override Exceptions IllegalStateException: when the request was not a postback.

isStateless

back to summary

public boolean isStateless(FacesContext facesContext, String viewId) throws IllegalStateException

Implements abstract com.sun.faces.renderkit.StateHelper.isStateless.

Is stateless.

Parameters

facesContext:FacesContext: the Faces context.
viewId:String: the view id.

Returns:boolean

true if stateless, false otherwise.

Annotations

@Override

Exceptions

IllegalStateException:: when the request was not a postback.

writeState back to summary

writeState	back to summary
public void writeState(FacesContext ctx, Object state, StringBuilder stateCapture) throws IOException Implements abstract com.sun.faces.renderkit.StateHelper.writeState. Stores the provided state within the session obtained from the provided `FacesContext` If `stateCapture` is `null`, the composite key used to look up the actual and logical views will be written to the client as a hidden field using the `ResponseWriter` from the provided `FacesContext`. If `stateCapture` is not `null`, the composite key will be appended to the `StringBuilder without any markup included or any content written to the client.` `Annotations @Override`

public void writeState(FacesContext ctx, Object state, StringBuilder stateCapture) throws IOException

Implements abstract com.sun.faces.renderkit.StateHelper.writeState.

Stores the provided state within the session obtained from the provided FacesContext

If stateCapture is null, the composite key used to look up the actual and logical views will be written to the client as a hidden field using the ResponseWriter from the provided FacesContext.

If stateCapture is not null, the composite key will be appended to the StringBuilder without any markup included or any content written to the client.

Annotations: @Override