org.omnifaces.viewhandler

Class RestorableViewHandler

java.lang.Object

javax.faces.application.ViewHandler

javax.faces.application.ViewHandlerWrapper

org.omnifaces.viewhandler.RestorableViewHandler

All Implemented Interfaces:

FacesWrapper<ViewHandler>

public class RestorableViewHandler
extends ViewHandlerWrapper

This view handler implementation will recreate the entire view state whenever the view has apparently been expired, i.e. whenever restoreView(FacesContext, String) returns null and the current request is a postback and the view in question has <enableRestorableView> in the metadata. This effectively prevents the ViewExpiredException on the view.

Since OmniFaces 2.2, this view handler implementation also detects unload requests coming from ViewScoped beans and will create a dummy view and only restore the view scoped state instead of building and restoring the entire view.

Since:

1.3

Author:

Bauke Scholtz

See Also:

EnableRestorableView, ViewScoped

Field Summary

Fields inherited from class javax.faces.application.ViewHandler

CHARACTER_ENCODING_KEY, DEFAULT_FACELETS_SUFFIX, DEFAULT_SUFFIX, DEFAULT_SUFFIX_PARAM_NAME, DISABLE_FACELET_JSF_VIEWHANDLER_PARAM_NAME, FACELETS_BUFFER_SIZE_PARAM_NAME, FACELETS_DECORATORS_PARAM_NAME, FACELETS_LIBRARIES_PARAM_NAME, FACELETS_REFRESH_PERIOD_PARAM_NAME, FACELETS_SKIP_COMMENTS_PARAM_NAME, FACELETS_SUFFIX_PARAM_NAME, FACELETS_VIEW_MAPPINGS_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
RestorableViewHandler(ViewHandler wrapped) Construct a new restorable view handler around the given wrapped view handler.

Method Summary

Modifier and Type	Method and Description
ViewHandler	getWrapped()
UIViewRoot	restoreView(FacesContext context, String viewId) If the current request is an unload request from ViewScoped, then create a dummy view, restore only the view root state and then immediately explicitly destroy the view, else restore the view as usual.

Methods inherited from class javax.faces.application.ViewHandlerWrapper

addProtectedView, calculateCharacterEncoding, calculateLocale, calculateRenderKitId, createView, deriveLogicalViewId, deriveViewId, getActionURL, getBookmarkableURL, getProtectedViewsUnmodifiable, getRedirectURL, getResourceURL, getViewDeclarationLanguage, initView, removeProtectedView, renderView, writeState

Methods inherited from class java.lang.Object

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

Constructor Detail

RestorableViewHandler

public RestorableViewHandler(ViewHandler wrapped)

Construct a new restorable view handler around the given wrapped view handler.

Parameters:

wrapped - The wrapped view handler.

Method Detail

restoreView

public UIViewRoot restoreView(FacesContext context,
                              String viewId)

If the current request is an unload request from ViewScoped, then create a dummy view, restore only the view root state and then immediately explicitly destroy the view, else restore the view as usual. If the <o:enableRestoreView> is used once in the application, and the restored view is null and the current request is a postback, then recreate and rebuild the view from scratch. If it indeed contains the <o:enableRestoreView>, then return the newly created view, else return null.

Overrides:

restoreView in class ViewHandlerWrapper

getWrapped

public ViewHandler getWrapped()

Specified by:

getWrapped in interface FacesWrapper<ViewHandler>

Overrides:

getWrapped in class ViewHandlerWrapper