Module jakarta.faces

Package jakarta.faces.application

Class ViewHandlerWrapper

java.lang.Object

jakarta.faces.application.ViewHandler

jakarta.faces.application.ViewHandlerWrapper

All Implemented Interfaces:

FacesWrapper<ViewHandler>

public abstract class ViewHandlerWrapper
extends ViewHandler
implements FacesWrapper<ViewHandler>

Provides a simple implementation of ViewHandler that can be subclassed by developers wishing to provide specialized behavior to an existing ViewHandler instance. The default implementation of all methods is to call through to the wrapped ViewHandler.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to access the instance being wrapped.

Since:

1.2

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
ViewHandlerWrapper()	Deprecated. Use the other constructor taking the implementation being wrapped.
ViewHandlerWrapper(ViewHandler wrapped)	If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method	Description
void	addProtectedView(String urlPattern)	The default behavior of this method is to call ViewHandler.addProtectedView(java.lang.String) on the wrapped ViewHandler object.
String	calculateCharacterEncoding(FacesContext context)	The default behavior of this method is to call ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.
Locale	calculateLocale(FacesContext context)	The default behavior of this method is to call ViewHandler.calculateLocale(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.
String	calculateRenderKitId(FacesContext context)	The default behavior of this method is to call ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.
UIViewRoot	createView(FacesContext context, String viewId)	The default behavior of this method is to call ViewHandler.createView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
String	deriveLogicalViewId(FacesContext context, String requestViewId)	The default behavior of this method is to call ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
String	deriveViewId(FacesContext context, String requestViewId)	The default behavior of this method is to call ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
String	getActionURL(FacesContext context, String viewId)	The default behavior of this method is to call ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
String	getBookmarkableURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)	The default behavior of this method is to call ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object.
Set<String>	getProtectedViewsUnmodifiable()	The default behavior of this method is to call ViewHandler.getProtectedViewsUnmodifiable() on the wrapped ViewHandler object.
String	getRedirectURL(FacesContext context, String viewId, Map<String,List<String>> parameters, boolean includeViewParams)	The default behavior of this method is to call ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object.
String	getResourceURL(FacesContext context, String path)	The default behavior of this method is to call ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
ViewDeclarationLanguage	getViewDeclarationLanguage(FacesContext context, String viewId)	The default behavior of this method is to call ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String) on the wrapped ViewHandler object.
Stream<String>	getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options)	The default behavior of this method is to call ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...) on the wrapped ViewHandler object.
Stream<String>	getViews(FacesContext context, String path, ViewVisitOption... options)	The default behavior of this method is to call ViewHandler.getViews(FacesContext, String, ViewVisitOption...) on the wrapped ViewHandler object.
String	getWebsocketURL(FacesContext context, String channel)	The default behavior of this method is to call ViewHandler.getWebsocketURL(FacesContext, String) on the wrapped ViewHandler object.
ViewHandler	getWrapped()	A class that implements this interface uses this method to return an instance of the class being wrapped.
void	initView(FacesContext context)	The default behavior of this method is to call ViewHandler.initView(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.
boolean	removeProtectedView(String urlPattern)	The default behavior of this method is to call ViewHandler.removeProtectedView(java.lang.String) on the wrapped ViewHandler object.
void	renderView(FacesContext context, UIViewRoot viewToRender)	The default behavior of this method is to call ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) on the wrapped ViewHandler object.
UIViewRoot	restoreView(FacesContext context, String viewId)	The default behavior of this method is to call ViewHandler.restoreView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.
void	writeState(FacesContext context)	The default behavior of this method is to call ViewHandler.writeState(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewHandlerWrapper

public ViewHandlerWrapper(ViewHandler wrapped)

If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters:

wrapped - The implementation being wrapped.

Since:

2.3

ViewHandlerWrapper

@Deprecated
public ViewHandlerWrapper()

Deprecated.

Use the other constructor taking the implementation being wrapped.

Method Details

getWrapped

public ViewHandler getWrapped()

Description copied from interface: FacesWrapper

A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:

getWrapped in interface FacesWrapper<ViewHandler>

Returns:

the wrapped instance.

initView

public void initView(FacesContext context)
              throws FacesException

The default behavior of this method is to call ViewHandler.initView(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Overrides:

initView in class ViewHandler

Parameters:

context - the Faces context.

Throws:

FacesException - if a problem occurs setting the encoding, such as the UnsupportedEncodingException thrown by the underlying Jakarta Servlet or Portlet technology when the encoding is not supported.

Since:

1.2

See Also:

• ViewHandler.initView(jakarta.faces.context.FacesContext)

restoreView

public UIViewRoot restoreView(FacesContext context,
 String viewId)

The default behavior of this method is to call ViewHandler.restoreView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:

restoreView in class ViewHandler

Parameters:

context - FacesContext for the current request

viewId - the view identifier for the current request

Returns:

the restored view root, or null.

Since:

1.2

See Also:

• ViewHandler.restoreView(jakarta.faces.context.FacesContext, String)

createView

public UIViewRoot createView(FacesContext context,
 String viewId)

The default behavior of this method is to call ViewHandler.createView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:

createView in class ViewHandler

Parameters:

context - the Faces context.

viewId - the view id.

Returns:

the viewroot.

Since:

1.2

See Also:

• ViewHandler.createView(jakarta.faces.context.FacesContext, String)

renderView

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

The default behavior of this method is to call ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) on the wrapped ViewHandler object.

Specified by:

renderView in class ViewHandler

Parameters:

context - FacesContext for the current request

viewToRender - the view to render

Throws:

IOException - if an input/output error occurs

FacesException - if a Jakarta Servlet error occurs

Since:

1.2

See Also:

• ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)

calculateCharacterEncoding

public String calculateCharacterEncoding(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Overrides:

calculateCharacterEncoding in class ViewHandler

Parameters:

context - the Faces context.

Returns:

the character encoding, or null

Since:

1.2

See Also:

• ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)

calculateLocale

public Locale calculateLocale(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateLocale(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:

calculateLocale in class ViewHandler

Parameters:

context - FacesContext for the current request

Returns:

the locale.

Since:

1.2

See Also:

• ViewHandler.calculateLocale(jakarta.faces.context.FacesContext)

deriveViewId

public String deriveViewId(FacesContext context,
 String requestViewId)

The default behavior of this method is to call ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Overrides:

deriveViewId in class ViewHandler

Parameters:

context - the FacesContext for this request

requestViewId - the viewId to derive,

Returns:

the derived view id.

Since:

2.0

See Also:

• ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)

deriveLogicalViewId

public String deriveLogicalViewId(FacesContext context,
 String requestViewId)

The default behavior of this method is to call ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Overrides:

deriveLogicalViewId in class ViewHandler

Parameters:

context - the FacesContext for this request

requestViewId - the viewId to derive,

Returns:

the derived logical view id.

Since:

2.1

See Also:

• ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)

calculateRenderKitId

public String calculateRenderKitId(FacesContext context)

The default behavior of this method is to call ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:

calculateRenderKitId in class ViewHandler

Parameters:

context - FacesContext for the current request

Returns:

the render kit id.

Since:

1.2

See Also:

• ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)

getActionURL

public String getActionURL(FacesContext context,
 String viewId)

The default behavior of this method is to call ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:

getActionURL in class ViewHandler

Parameters:

context - FacesContext for this request

viewId - View identifier of the desired view

Returns:

the action url.

Since:

1.2

See Also:

• ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)

getProtectedViewsUnmodifiable

public Set<String> getProtectedViewsUnmodifiable()

The default behavior of this method is to call ViewHandler.getProtectedViewsUnmodifiable() on the wrapped ViewHandler object.

Overrides:

getProtectedViewsUnmodifiable in class ViewHandler

Returns:

the unmodifiable set of protected views.

Since:

2.2

See Also:

• ViewHandler.getProtectedViewsUnmodifiable()

addProtectedView

public void addProtectedView(String urlPattern)

The default behavior of this method is to call ViewHandler.addProtectedView(java.lang.String) on the wrapped ViewHandler object.

Overrides:

addProtectedView in class ViewHandler

Parameters:

urlPattern - the url-pattern to add.

Since:

2.2

See Also:

• ViewHandler.addProtectedView(java.lang.String)

removeProtectedView

public boolean removeProtectedView(String urlPattern)

The default behavior of this method is to call ViewHandler.removeProtectedView(java.lang.String) on the wrapped ViewHandler object.

Overrides:

removeProtectedView in class ViewHandler

Parameters:

urlPattern - the url-pattern to remove.

Returns:

true if in the Set, false otherwise.

Since:

2.2

See Also:

• ViewHandler.removeProtectedView(java.lang.String)

getRedirectURL

public String getRedirectURL(FacesContext context,
 String viewId,
 Map<String,List<String>> parameters,
 boolean includeViewParams)

The default behavior of this method is to call ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object.

Overrides:

getRedirectURL in class ViewHandler

Parameters:

context - The FacesContext processing this request

viewId - The view identifier of the target page

parameters - A mapping of parameter names to one or more values

includeViewParams - A flag indicating whether view parameters should be encoded into this URL

Returns:

the redirect URL.

Since:

2.0

See Also:

• ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)

getBookmarkableURL

public String getBookmarkableURL(FacesContext context,
 String viewId,
 Map<String,List<String>> parameters,
 boolean includeViewParams)

The default behavior of this method is to call ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object.

Overrides:

getBookmarkableURL in class ViewHandler

Parameters:

context - The FacesContext processing this request

viewId - The view identifier of the target page

parameters - A mapping of parameter names to one or more values

includeViewParams - A flag indicating whether view parameters should be encoded into this URL

Returns:

the bookmarkable URL.

Since:

2.0

See Also:

• ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)

getResourceURL

public String getResourceURL(FacesContext context,
 String path)

The default behavior of this method is to call ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object.

Specified by:

getResourceURL in class ViewHandler

Parameters:

context - FacesContext for the current request

path - Resource path to convert to a URL

Returns:

the resource URL.

Since:

1.2

See Also:

• ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)

getWebsocketURL

public String getWebsocketURL(FacesContext context,
 String channel)

The default behavior of this method is to call ViewHandler.getWebsocketURL(FacesContext, String) on the wrapped ViewHandler object.

Specified by:

getWebsocketURL in class ViewHandler

Parameters:

context - FacesContext for the current request.

channel - The channel name of the websocket.

Returns:

the websocket URL.

Since:

2.3

See Also:

• ViewHandler.getWebsocketURL(FacesContext, String)

getViewDeclarationLanguage

public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context,
 String viewId)

The default behavior of this method is to call ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String) on the wrapped ViewHandler object.

Overrides:

getViewDeclarationLanguage in class ViewHandler

Parameters:

context - the FacesContext for this request.

viewId - the logical view id, as returned from ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, java.lang.String) for which the ViewDeclarationLanguage should be returned.

Returns:

the ViewDeclarationLanguage, or null.

Since:

2.0

getViews

public Stream<String> getViews(FacesContext context,
 String path,
 ViewVisitOption... options)

The default behavior of this method is to call ViewHandler.getViews(FacesContext, String, ViewVisitOption...) on the wrapped ViewHandler object.

Overrides:

getViews in class ViewHandler

Parameters:

context - The FacesContext for this request.

path - The initial path from which to start looking for view ids.

options - The options to influence the traversal. See ViewVisitOption for details on those.

Returns:

the Stream of view ids

Since:

2.3

getViews

public Stream<String> getViews(FacesContext context,
 String path,
 int maxDepth,
 ViewVisitOption... options)

The default behavior of this method is to call ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...) on the wrapped ViewHandler object.

Overrides:

getViews in class ViewHandler

Parameters:

context - The FacesContext for this request.

path - The initial path from which to start looking for view ids.

maxDepth - The absolute maximum depth of nested directories to visit counted from the root (/).

options - The options to influence the traversal. See ViewVisitOption for details on those.

Returns:

the Stream of view ids

Since:

2.3

writeState

public void writeState(FacesContext context)
                throws IOException

The default behavior of this method is to call ViewHandler.writeState(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object.

Specified by:

writeState in class ViewHandler

Parameters:

context - FacesContext for the current request

Throws:

IOException - if an input/output error occurs

Since:

1.2

See Also:

• ViewHandler.writeState(jakarta.faces.context.FacesContext)