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

Field Summary

Modifier and Type	Field and Description
protected boolean	compressViewState Flag indicating whether or not view state should be compressed to reduce the memory/bandwidth footprint.
protected char[]	fieldEnd This will be used the by the different `StateHelper` implementations when writing the end of the state or viewId field.
protected char[]	fieldMiddle This will be used by the different `StateHelper` implementations when writing the middle of the state or viewId fields.
private static final Logger	LOGGER
protected SerializationProvider	serialProvider Factory for serialization streams.
protected char[]	stateFieldStart This will be used the by the different `StateHelper` implementations when writing the start of the state field.
private static final String	TOKEN_NAME
protected WebConfiguration	webConfig Access to the context init parameters that configure this application.

Constructor Summary

Access	Constructor and Description
public	StateHelper() Constructs a new `StateHelper` instance.

Method Summary

Modifier and Type	Method and Description
public static void	createAndStoreCryptographicallyStrongTokenInSession(HttpSession session)
public String	getCryptographicallyStrongTokenFromSession(FacesContext context)
public abstract Object	getState(FacesContext ctx, String viewId)
protected static String	Returns: the view state from this request getStateParamValue(FacesContext the `FacesContext` for the current request context) Get our view state from this request
public abstract boolean	isStateless(FacesContext ctx, String viewId)
protected void	writeClientWindowField(FacesContext the Faces context. context, ResponseWriter the response writer. writer) Write the client window state field.
protected void	writeRenderKitIdField(FacesContext the `FacesContext` for the current request context, ResponseWriter the `ResponseWriter` to write to writer) If a custom `RenderKit` is used, write out the ID of the `RenderKit` out as a hidden field.
public abstract void	writeState(FacesContext ctx, Object state, StringBuilder stateCapture) Functionally similar to ResponseStateManager#writeState(FacesContext, Object) with an option to write the state directly to the provided `StringBuilder` without sending any markup to the client.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

compressViewState	back to summary
protected boolean compressViewState Flag indicating whether or not view state should be compressed to reduce the memory/bandwidth footprint. This option is common to both types of state saving.

fieldEnd	back to summary
protected char[] fieldEnd This will be used the by the different `StateHelper` implementations when writing the end of the state or viewId field. This value of this field is determined by the value of the `com.sun.faces.config.WebConfiguration.BooleanWebContextInitParameter#AutoCompleteOffOnViewState`

fieldMiddle	back to summary
protected char[] fieldMiddle This will be used by the different `StateHelper` implementations when writing the middle of the state or viewId fields.

LOGGER	back to summary
private static final Logger LOGGER

serialProvider	back to summary
protected SerializationProvider serialProvider Factory for serialization streams. These are pluggable via the WebConfiguration.WebContextInitParameter#SerializationProviderClass.

stateFieldStart	back to summary
protected char[] stateFieldStart This will be used the by the different `StateHelper` implementations when writing the start of the state field.

TOKEN_NAME	back to summary
private static final String TOKEN_NAME

webConfig	back to summary
protected WebConfiguration webConfig Access to the context init parameters that configure this application.

Constructor Detail

StateHelper	back to summary
public StateHelper() Constructs a new `StateHelper` instance.

Method Detail

createAndStoreCryptographicallyStrongTokenInSession	back to summary
public static void createAndStoreCryptographicallyStrongTokenInSession(HttpSession session)

getCryptographicallyStrongTokenFromSession	back to summary
public String getCryptographicallyStrongTokenFromSession(FacesContext context)

getState	back to summary
public abstract Object getState(FacesContext ctx, String viewId) throws IOException See Also `javax.faces.render.ResponseStateManager#getState(javax.faces.context.FacesContext, String)`

getStateParamValue back to summary

getStateParamValue	back to summary
protected static String getStateParamValue(FacesContext context) Get our view state from this request Parameters context:FacesContext the `FacesContext` for the current request Returns:String the view state from this request

protected static String getStateParamValue(FacesContext context)

Get our view state from this request

Parameters

context:FacesContext: the FacesContext for the current request

Returns:String

the view state from this request

isStateless	back to summary
public abstract boolean isStateless(FacesContext ctx, String viewId) throws IllegalStateException See Also `javax.faces.render.ResponseStateManager#isStateless(javax.faces.context.FacesContext, String)`

writeClientWindowField	back to summary
protected void writeClientWindowField(FacesContext context, ResponseWriter writer) throws IOException Write the client window state field. Parameters context:FacesContext the Faces context. writer:ResponseWriter the response writer. Exceptions IOException: when an I/O error occurs.

writeClientWindowField

back to summary

protected void writeClientWindowField(FacesContext context, ResponseWriter writer) throws IOException

Write the client window state field.

Parameters

context:FacesContext: the Faces context.
writer:ResponseWriter: the response writer.

Exceptions

IOException:: when an I/O error occurs.

writeRenderKitIdField back to summary

writeRenderKitIdField	back to summary
protected void writeRenderKitIdField(FacesContext context, ResponseWriter writer) throws IOException If a custom `RenderKit` is used, write out the ID of the `RenderKit` out as a hidden field. This will be used when restoring the view state. Parameters context:FacesContext the `FacesContext` for the current request writer:ResponseWriter the `ResponseWriter` to write to Exceptions IOException: if an error occurs writing to the client

protected void writeRenderKitIdField(FacesContext context, ResponseWriter writer) throws IOException

If a custom RenderKit is used, write out the ID of the RenderKit out as a hidden field. This will be used when restoring the view state.

Parameters

context:FacesContext: the FacesContext for the current request
writer:ResponseWriter: the ResponseWriter to write to

Exceptions

IOException:: if an error occurs writing to the client

writeState back to summary

writeState	back to summary
public abstract void writeState(FacesContext ctx, Object state, StringBuilder stateCapture) throws IOException Functionally similar to ResponseStateManager#writeState(FacesContext, Object) with an option to write the state directly to the provided `StringBuilder` without sending any markup to the client. See Also `ResponseStateManager#writeState(javax.faces.context.FacesContext, java.lang.Object)`

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

Functionally similar to ResponseStateManager#writeState(FacesContext, Object) with an option to write the state directly to the provided StringBuilder without sending any markup to the client.

See Also: ResponseStateManager#writeState(javax.faces.context.FacesContext, java.lang.Object)

public abstract Class StateHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail