Module org.omnifaces

Package org.omnifaces.viewhandler

Class OmniViewHandler

java.lang.Object

jakarta.faces.application.ViewHandler

jakarta.faces.application.ViewHandlerWrapper

org.omnifaces.viewhandler.OmniViewHandler

All Implemented Interfaces:

FacesWrapper<ViewHandler>

public class OmniViewHandler
extends ViewHandlerWrapper

OmniFaces view handler. This class was before version 2.5 known as RestorableViewHandler. This view handler performs the following tasks:

1. Since 1.3: Recreate entire view when EnableRestorableView tag is in the metadata. This effectively prevents the ViewExpiredException on the view.
2. Since 2.2: Detect unload requests coming from ViewScoped beans. This will create a dummy view and only restore the view scoped state instead of building and restoring the entire view.
3. Since 2.5: If project stage is development, then throw an IllegalStateException when there's a nested UIForm component.
4. Since 3.10: If ViewResourceHandler.isViewResourceRequest(FacesContext) is true, then replace the HTML response writer with a XML response writer in renderView(FacesContext, UIViewRoot), and ensure that proper action URL is returned in ViewHandlerWrapper.getActionURL(FacesContext, String).

Since:

1.3

Author:

Bauke Scholtz

See Also:

• EnableRestorableView
• ViewScopeManager

Field Summary

Fields inherited from class jakarta.faces.application.ViewHandler

CHARACTER_ENCODING_KEY, DEFAULT_FACELETS_SUFFIX, DEFAULT_SUFFIX, DEFAULT_SUFFIX_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	Description
OmniViewHandler(ViewHandler wrapped)	Construct a new OmniFaces view handler around the given wrapped view handler.

Method Summary

Modifier and Type	Method	Description
UIViewRoot	createView(FacesContext context, String viewId)	If the current request is a sw.js request from PWAResourceHandler, then create a dummy view and trigger FacesContext.responseComplete() so that it won't be built nor rendered.
void	renderView(FacesContext context, UIViewRoot viewToRender)
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 jakarta.faces.application.ViewHandlerWrapper

addProtectedView, calculateCharacterEncoding, calculateLocale, calculateRenderKitId, deriveLogicalViewId, deriveViewId, getActionURL, getBookmarkableURL, getProtectedViewsUnmodifiable, getRedirectURL, getResourceURL, getViewDeclarationLanguage, getViews, getViews, getWebsocketURL, getWrapped, initView, removeProtectedView, writeState

Methods inherited from class java.lang.Object

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

Constructor Details

OmniViewHandler

public OmniViewHandler(ViewHandler wrapped)

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

Parameters:

wrapped - The wrapped view handler.

Method Details

createView

public UIViewRoot createView(FacesContext context,
 String viewId)

If the current request is a sw.js request from PWAResourceHandler, then create a dummy view and trigger FacesContext.responseComplete() so that it won't be built nor rendered.

Overrides:

createView in class ViewHandlerWrapper

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

renderView

public void renderView(FacesContext context,
 UIViewRoot viewToRender)
                throws IOException

Overrides:

renderView in class ViewHandlerWrapper

Throws:

IOException