Jakarta EE 11.0.0 · com.sun.faces.application.view.MultiViewHandler

Modifier and Type	Field and Description
private final List<String>	configuredExtensions
private static final Logger	LOGGER
private final Set<String>	protectedViews
private final ViewDeclarationLanguageFactory	vdlFactory

Access	Constructor and Description
public	MultiViewHandler()

Method Summary

Modifier and Type	Method and Description
public void	addProtectedView(String the url-pattern to add. urlPattern) Overrides jakarta.faces.application.ViewHandler.addProtectedView. Add the argument `urlPattern` to the thread safe `Set` of protected views for this application.
protected void	addViewParameters(FacesContext ctx, String viewId, Map<String, List<String>> existingParameters)
private void	appendOrReplaceExtension(String viewId, String extension, int length, int extensionIndex, StringBuilder buffer)
public Locale	calculateLocale(FacesContext `FacesContext` for the current request context) Implements abstract jakarta.faces.application.ViewHandler.calculateLocale. This code is currently common to all `ViewHandlingStrategy` instances.
public String	calculateRenderKitId(FacesContext `FacesContext` for the current request context) Implements abstract jakarta.faces.application.ViewHandler.calculateRenderKitId. This code is currently common to all `ViewHandlingStrategy` instances.
protected String	Returns: the view ID with an altered suffix mapping (if necessary) convertViewId(FacesContext current `jakarta.faces.context.FacesContext` context, String incoming view ID viewId) Adjust the viewID per the requirements of `renderView`.
public UIViewRoot	createView(FacesContext the Faces context. context, String the view id. viewId) Implements abstract jakarta.faces.application.ViewHandler.createView. Derive the physical view ID (i.e. the physical resource) and call call `ViewDeclarationLanguage#createView(jakarta.faces.context.FacesContext, String)`.
public String	deriveLogicalViewId(FacesContext the `FacesContext` for this request context, String the `viewId` to derive, requestViewId) Overrides jakarta.faces.application.ViewHandler.deriveLogicalViewId. Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.
protected String	derivePhysicalViewId(FacesContext ctx, String requestViewId, boolean checkPhysical)
public String	deriveViewId(FacesContext the `FacesContext` for this request context, String the `viewId` to derive, requestViewId) Overrides jakarta.faces.application.ViewHandler.deriveViewId. Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.
protected Locale	Returns: the Locale based on pref and the matching alogritm specified in JSTL 8.3.2 findMatch(FacesContext the `FacesContext` for the current request context, Locale the preferred locale pref) Attempts to find a matching locale based on `pref` and list of supported locales, using the matching algorithm as described in JSTL 8.3.2.
public String	getActionURL(FacesContext `FacesContext` for this request context, String View identifier of the desired view viewId) Implements abstract jakarta.faces.application.ViewHandler.getActionURL. This code is currently common to all `ViewHandlingStrategy` instances.
private String	getActionURLWithoutViewProtection(FacesContext context, String viewId)
public String	getBookmarkableURL(FacesContext The FacesContext processing this request context, String The view identifier of the target page viewId, Map<String, List<String>> A mapping of parameter names to one or more values parameters, boolean A flag indicating whether view parameters should be encoded into this URL includeViewParams) Overrides jakarta.faces.application.ViewHandler.getBookmarkableURL. Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Faces response.
protected Map<String, List<String>>	getFullParameterList(FacesContext ctx, String viewId, Map<String, List<String>> existingParameters)
public Set<String>	getProtectedViewsUnmodifiable() Overrides jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable. Return an unmodifiable `Set` of the protected views currently known to this `ViewHandler` instance.
public String	getRedirectURL(FacesContext The FacesContext processing this request context, String The view identifier of the target page viewId, Map<String, List<String>> A mapping of parameter names to one or more values parameters, boolean A flag indicating whether view parameters should be encoded into this URL includeViewParams) Overrides jakarta.faces.application.ViewHandler.getRedirectURL. Return a Jakarta Faces action URL derived from the `viewId` argument that is suitable to be used by the `NavigationHandler` to issue a redirect request to the URL using a NonFaces request.
public String	getResourceURL(FacesContext `FacesContext` for the current request context, String Resource path to convert to a URL path) Implements abstract jakarta.faces.application.ViewHandler.getResourceURL. This code is currently common to all `ViewHandlingStrategy` instances.
private static String	getStringValueToTransfer(FacesContext context, UIViewParameter param, Collection<UIViewParameter> viewParams)
public ViewDeclarationLanguage	getViewDeclarationLanguage(FacesContext the `FacesContext` for this request. context, String the logical view id, as returned from `deriveLogicalViewId` for which the `ViewDeclarationLanguage` should be returned. viewId) Overrides jakarta.faces.application.ViewHandler.getViewDeclarationLanguage. Return the `ViewDeclarationLanguage` instance used for this `ViewHandler` instance.
public Stream<String>	getViews(FacesContext The `FacesContext` for this request. context, String The initial path from which to start looking for view ids. path, ViewVisitOption... The options to influence the traversal. See `ViewVisitOption` for details on those. options) Overrides jakarta.faces.application.ViewHandler.getViews. Return a `Stream` possibly lazily populated by walking the view trees of every active `ViewDeclarationLanguage` rooted at a given initial path.
public Stream<String>	getViews(FacesContext The `FacesContext` for this request. context, String The initial path from which to start looking for view ids. path, int The absolute maximum depth of nested directories to visit counted from the root (`/`). maxDepth, ViewVisitOption... The options to influence the traversal. See `ViewVisitOption` for details on those. options) Overrides jakarta.faces.application.ViewHandler.getViews. Return a `Stream` possibly lazily populated by walking the view trees of every active `ViewDeclarationLanguage` rooted at a given initial path.
public String	getWebsocketURL(FacesContext `FacesContext` for the current request. context, String The channel name of the websocket. channel) Implements abstract jakarta.faces.application.ViewHandler.getWebsocketURL. If the value returned from this method is used as the `file` argument to the four-argument constructor for `java.net.URL` (assuming appropriate values are used for the first three arguments), then a client making a push handshake request to the `toExternalForm()` of that `URL` will select the argument `channel` for connecting the websocket push channel in the current view.
public void	initView(FacesContext the Faces context. context) Overrides jakarta.faces.application.ViewHandler.initView. Call the default implementation of `jakarta.faces.application.ViewHandler#initView(jakarta.faces.context.FacesContext)`
protected String	Returns: the viewId without additional prefix FacesServlet mappings normalizeRequestURI(String something resembling a view id, can come from the request or from the navigation handler. viewId, String the FacesServlet mapping used for this request with the "/" removed, e.g. /faces instead of /faces/ mapping) If the specified mapping is a prefix mapping, and the provided request URI (sometimes the value from `ExternalContext.getRequestServletPath()`) starts with `mapping`, prune the mapping from the URI and return it, otherwise, return the original URI.
private static boolean	paramHasValueExpression(UIViewParameter param)
public boolean	removeProtectedView(String the url-pattern to remove. urlPattern) Overrides jakarta.faces.application.ViewHandler.removeProtectedView. Remove the argument `urlPattern` from the thread safe `Set` of protected views for this application, if present in the `Set`.
public void	renderView(FacesContext `FacesContext` for the current request context, UIViewRoot the view to render viewToRender) Implements abstract jakarta.faces.application.ViewHandler.renderView. Call `ViewDeclarationLanguage#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)` if the view can be rendered.
public UIViewRoot	restoreView(FacesContext `FacesContext` for the current request context, String the view identifier for the current request viewId) Implements abstract jakarta.faces.application.ViewHandler.restoreView. Call `ViewDeclarationLanguage#restoreView(jakarta.faces.context.FacesContext, String)`.
protected void	send404Error(FacesContext the `FacesContext` for the current request context) Send `HttpServletResponse#SC_NOT_FOUND` (404) to the client.
public void	writeState(FacesContext `FacesContext` for the current request context) Implements abstract jakarta.faces.application.ViewHandler.writeState. This code is currently common to all `ViewHandlingStrategy` instances.

Inherited from jakarta.faces.application.ViewHandler:: calculateCharacterEncoding

configuredExtensions	back to summary
private final List<String> configuredExtensions

LOGGER	back to summary
private static final Logger LOGGER

protectedViews	back to summary
private final Set<String> protectedViews

vdlFactory	back to summary
private final ViewDeclarationLanguageFactory vdlFactory

MultiViewHandler	back to summary
public MultiViewHandler()

Method Detail

addProtectedView back to summary

addProtectedView	back to summary
public void addProtectedView(String urlPattern) Overrides jakarta.faces.application.ViewHandler.addProtectedView. Doc from jakarta.faces.application.ViewHandler.addProtectedView. Add the argument `urlPattern` to the thread safe `Set` of protected views for this application. Compliant implementations make it so a subsequent call to `getProtectedViewsUnmodifiable` contains the argument. The runtime must support calling this method at any time after application startup. The default implementation takes no action. Parameters urlPattern:String the url-pattern to add. Annotations @Override

public void addProtectedView(String urlPattern)

Overrides jakarta.faces.application.ViewHandler.addProtectedView.

Doc from jakarta.faces.application.ViewHandler.addProtectedView.

Add the argument urlPattern to the thread safe Set of protected views for this application. Compliant implementations make it so a subsequent call to getProtectedViewsUnmodifiable contains the argument. The runtime must support calling this method at any time after application startup. The default implementation takes no action.

Parameters

urlPattern:String: the url-pattern to add.

Annotations

@Override

addViewParameters	back to summary
protected void addViewParameters(FacesContext ctx, String viewId, Map<String, List<String>> existingParameters)

appendOrReplaceExtension	back to summary
private void appendOrReplaceExtension(String viewId, String extension, int length, int extensionIndex, StringBuilder buffer)

calculateLocale back to summary

calculateLocale	back to summary
public Locale calculateLocale(FacesContext context) Implements abstract jakarta.faces.application.ViewHandler.calculateLocale. This code is currently common to all `ViewHandlingStrategy` instances. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.calculateLocale. `FacesContext` for the current request Returns:Locale Doc from jakarta.faces.application.ViewHandler.calculateLocale. the locale. Annotations @Override See Also `ViewHandler#calculateLocale(jakarta.faces.context.FacesContext)`

public Locale calculateLocale(FacesContext context)

Implements abstract jakarta.faces.application.ViewHandler.calculateLocale.

This code is currently common to all ViewHandlingStrategy instances.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.calculateLocale.

FacesContext for the current request

Returns:Locale

Doc from jakarta.faces.application.ViewHandler.calculateLocale.

the locale.

Annotations

@Override

calculateRenderKitId back to summary

calculateRenderKitId	back to summary
public String calculateRenderKitId(FacesContext context) Implements abstract jakarta.faces.application.ViewHandler.calculateRenderKitId. This code is currently common to all `ViewHandlingStrategy` instances. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.calculateRenderKitId. `FacesContext` for the current request Returns:String Doc from jakarta.faces.application.ViewHandler.calculateRenderKitId. the render kit id. Annotations @Override See Also `ViewHandler#calculateRenderKitId(jakarta.faces.context.FacesContext)`

public String calculateRenderKitId(FacesContext context)

Implements abstract jakarta.faces.application.ViewHandler.calculateRenderKitId.

This code is currently common to all ViewHandlingStrategy instances.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.calculateRenderKitId.

FacesContext for the current request

Returns:String

Doc from jakarta.faces.application.ViewHandler.calculateRenderKitId.

the render kit id.

Annotations

@Override

convertViewId back to summary

convertViewId	back to summary
protected String convertViewId(FacesContext context, String viewId) Adjust the viewID per the requirements of `renderView`. Parameters context:FacesContext current `jakarta.faces.context.FacesContext` viewId:String incoming view ID Returns:String the view ID with an altered suffix mapping (if necessary)

protected String convertViewId(FacesContext context, String viewId)

Adjust the viewID per the requirements of renderView.

Parameters

context:FacesContext: current jakarta.faces.context.FacesContext
viewId:String: incoming view ID

Returns:String

the view ID with an altered suffix mapping (if necessary)

createView back to summary

createView	back to summary
public UIViewRoot createView(FacesContext context, String viewId) Implements abstract jakarta.faces.application.ViewHandler.createView. Derive the physical view ID (i.e. the physical resource) and call call `ViewDeclarationLanguage#createView(jakarta.faces.context.FacesContext, String)`. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.createView. the Faces context. viewId:String Doc from jakarta.faces.application.ViewHandler.createView. the view id. Returns:UIViewRoot Doc from jakarta.faces.application.ViewHandler.createView. the viewroot. Annotations @Override See Also `ViewHandler#restoreView(jakarta.faces.context.FacesContext, String)`

public UIViewRoot createView(FacesContext context, String viewId)

Implements abstract jakarta.faces.application.ViewHandler.createView.

Derive the physical view ID (i.e. the physical resource) and call call ViewDeclarationLanguage#createView(jakarta.faces.context.FacesContext, String).

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.createView.

the Faces context.

viewId:String

Doc from jakarta.faces.application.ViewHandler.createView.

the view id.

Returns:UIViewRoot

Doc from jakarta.faces.application.ViewHandler.createView.

the viewroot.

Annotations

@Override

deriveLogicalViewId back to summary

deriveLogicalViewId	back to summary
public String deriveLogicalViewId(FacesContext context, String requestViewId) Overrides jakarta.faces.application.ViewHandler.deriveLogicalViewId. Doc from jakarta.faces.application.ViewHandler.deriveLogicalViewId. Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. Note that unlike `deriveViewId()`, this method does not require that a physical view be present. This method should work correctly when the FacesServlet is invoked via either a `path mapping`, `extension mapping` or an `exact match` (mapping) as defined by Servlet.12.2. Note that `path mapping` is also commonly known as prefix mapping (e.g. "/faces/") and `extension mapping` as suffix mapping (e.g. ".xhtml"). An `exact match` is possible where there's a servlet mapping with an exact URL pattern such as "/foo". The default implementation of this method simply returns requestViewId unchanged. Parameters context:FacesContext the `FacesContext` for this request requestViewId:String the `viewId` to derive, Returns:String the derived logical view id. Annotations @Override

public String deriveLogicalViewId(FacesContext context, String requestViewId)

Overrides jakarta.faces.application.ViewHandler.deriveLogicalViewId.

Doc from jakarta.faces.application.ViewHandler.deriveLogicalViewId.

Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. Note that unlike deriveViewId(), this method does not require that a physical view be present.

This method should work correctly when the FacesServlet is invoked via either a path mapping, extension mapping or an exact match (mapping) as defined by Servlet.12.2. Note that path mapping is also commonly known as prefix mapping (e.g. "/faces/*") and extension mapping as suffix mapping (e.g. "*.xhtml"). An exact match is possible where there's a servlet mapping with an exact URL pattern such as "/foo".

The default implementation of this method simply returns requestViewId unchanged.

Parameters

context:FacesContext: the FacesContext for this request
requestViewId:String: the viewId to derive,

Returns:String

the derived logical view id.

Annotations

@Override

derivePhysicalViewId	back to summary
protected String derivePhysicalViewId(FacesContext ctx, String requestViewId, boolean checkPhysical)

deriveViewId back to summary

deriveViewId	back to summary
public String deriveViewId(FacesContext context, String requestViewId) Overrides jakarta.faces.application.ViewHandler.deriveViewId. Doc from jakarta.faces.application.ViewHandler.deriveViewId. Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. This method should work correctly when the FacesServlet is invoked via either a `path mapping`, `extension mapping` or an `exact match` (mapping) as defined by Servlet.12.2. Note that `path mapping` is also commonly known as prefix mapping (e.g. "/faces/") and `extension mapping` as suffix mapping (e.g. ".xhtml"). An `exact match` is possible where there's a servlet mapping with an exact URL pattern such as "/foo". The default implementation of this method simply returns requestViewId unchanged. Parameters context:FacesContext the `FacesContext` for this request requestViewId:String the `viewId` to derive, Returns:String the derived view id. Annotations @Override

public String deriveViewId(FacesContext context, String requestViewId)

Overrides jakarta.faces.application.ViewHandler.deriveViewId.

Doc from jakarta.faces.application.ViewHandler.deriveViewId.

The default implementation of this method simply returns requestViewId unchanged.

Parameters

context:FacesContext: the FacesContext for this request
requestViewId:String: the viewId to derive,

Returns:String

the derived view id.

Annotations

@Override

findMatch back to summary

findMatch	back to summary
protected Locale findMatch(FacesContext context, Locale pref) Attempts to find a matching locale based on `pref` and list of supported locales, using the matching algorithm as described in JSTL 8.3.2. Parameters context:FacesContext the `FacesContext` for the current request pref:Locale the preferred locale Returns:Locale the Locale based on pref and the matching alogritm specified in JSTL 8.3.2

protected Locale findMatch(FacesContext context, Locale pref)

Attempts to find a matching locale based on pref and list of supported locales, using the matching algorithm as described in JSTL 8.3.2.

Parameters

context:FacesContext: the FacesContext for the current request
pref:Locale: the preferred locale

Returns:Locale

the Locale based on pref and the matching alogritm specified in JSTL 8.3.2

getActionURL back to summary

getActionURL	back to summary
public String getActionURL(FacesContext context, String viewId) Implements abstract jakarta.faces.application.ViewHandler.getActionURL. This code is currently common to all `ViewHandlingStrategy` instances. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.getActionURL. `FacesContext` for this request viewId:String Doc from jakarta.faces.application.ViewHandler.getActionURL. View identifier of the desired view Returns:String Doc from jakarta.faces.application.ViewHandler.getActionURL. the action url. Annotations @Override See Also `ViewHandler#getActionURL(jakarta.faces.context.FacesContext, String)`

public String getActionURL(FacesContext context, String viewId)

Implements abstract jakarta.faces.application.ViewHandler.getActionURL.

This code is currently common to all ViewHandlingStrategy instances.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.getActionURL.

FacesContext for this request

viewId:String

Doc from jakarta.faces.application.ViewHandler.getActionURL.

View identifier of the desired view

Returns:String

Doc from jakarta.faces.application.ViewHandler.getActionURL.

the action url.

Annotations

@Override

getActionURLWithoutViewProtection	back to summary
private String getActionURLWithoutViewProtection(FacesContext context, String viewId)

getBookmarkableURL back to summary

getBookmarkableURL	back to summary
public String getBookmarkableURL(FacesContext context, String viewId, Map<String, List<String>> parameters, boolean includeViewParams) Overrides jakarta.faces.application.ViewHandler.getBookmarkableURL. Doc from jakarta.faces.application.ViewHandler.getBookmarkableURL. Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Faces response. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to `getActionURL`, passing the arguments `context` and `viewId`. Parameters context:FacesContext The FacesContext processing this request viewId:String The view identifier of the target page parameters:Map<String, List<String>> A mapping of parameter names to one or more values includeViewParams:boolean A flag indicating whether view parameters should be encoded into this URL Returns:String the bookmarkable URL. Annotations @Override

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

Overrides jakarta.faces.application.ViewHandler.getBookmarkableURL.

Doc from jakarta.faces.application.ViewHandler.getBookmarkableURL.

Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Faces response. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to getActionURL, passing the arguments context and viewId.

Parameters

context:FacesContext: The FacesContext processing this request
viewId:String: The view identifier of the target page
parameters:Map<String, List<String>>: A mapping of parameter names to one or more values
includeViewParams:boolean: A flag indicating whether view parameters should be encoded into this URL

Returns:String

the bookmarkable URL.

Annotations

@Override

getFullParameterList	back to summary
protected Map<String, List<String>> getFullParameterList(FacesContext ctx, String viewId, Map<String, List<String>> existingParameters)

getProtectedViewsUnmodifiable back to summary

getProtectedViewsUnmodifiable	back to summary
public Set<String> getProtectedViewsUnmodifiable() Overrides jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable. Doc from jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable. Return an unmodifiable `Set` of the protected views currently known to this `ViewHandler` instance. Compliant implementations must return a `Set` that is the concatenation of the contents of all the `<url-pattern>` elements within all the `<protected-views>` in all of the application configuration resources in the current application. The runtime must support calling this method at any time after application startup. The default implementation returns an unmodifiable empty `Set`. Returns:Set<String> the unmodifiable set of protected views. Annotations @Override

public Set<String> getProtectedViewsUnmodifiable()

Overrides jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable.

Doc from jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable.

Return an unmodifiable Set of the protected views currently known to this ViewHandler instance. Compliant implementations must return a Set that is the concatenation of the contents of all the <url-pattern> elements within all the <protected-views> in all of the application configuration resources in the current application. The runtime must support calling this method at any time after application startup. The default implementation returns an unmodifiable empty Set.

Returns:Set<String>

the unmodifiable set of protected views.

Annotations

@Override

getRedirectURL back to summary

getRedirectURL	back to summary
public String getRedirectURL(FacesContext context, String viewId, Map<String, List<String>> parameters, boolean includeViewParams) Overrides jakarta.faces.application.ViewHandler.getRedirectURL. Doc from jakarta.faces.application.ViewHandler.getRedirectURL. Return a Jakarta Faces action URL derived from the `viewId` argument that is suitable to be used by the `NavigationHandler` to issue a redirect request to the URL using a NonFaces request. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to `getActionURL`, passing the arguments `context` and `viewId`. Parameters context:FacesContext The FacesContext processing this request viewId:String The view identifier of the target page parameters:Map<String, List<String>> A mapping of parameter names to one or more values includeViewParams:boolean A flag indicating whether view parameters should be encoded into this URL Returns:String the redirect URL. Annotations @Override See Also `ViewHandler#getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)`

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

Overrides jakarta.faces.application.ViewHandler.getRedirectURL.

Doc from jakarta.faces.application.ViewHandler.getRedirectURL.

Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used by the NavigationHandler to issue a redirect request to the URL using a NonFaces request. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to getActionURL, passing the arguments context and viewId.

Parameters

context:FacesContext: The FacesContext processing this request
viewId:String: The view identifier of the target page
parameters:Map<String, List<String>>: A mapping of parameter names to one or more values
includeViewParams:boolean: A flag indicating whether view parameters should be encoded into this URL

Returns:String

the redirect URL.

Annotations

@Override

getResourceURL back to summary

getResourceURL	back to summary
public String getResourceURL(FacesContext context, String path) Implements abstract jakarta.faces.application.ViewHandler.getResourceURL. This code is currently common to all `ViewHandlingStrategy` instances. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.getResourceURL. `FacesContext` for the current request path:String Doc from jakarta.faces.application.ViewHandler.getResourceURL. Resource path to convert to a URL Returns:String Doc from jakarta.faces.application.ViewHandler.getResourceURL. the resource URL. Annotations @Override See Also `ViewHandler#getResourceURL(jakarta.faces.context.FacesContext, String)`

public String getResourceURL(FacesContext context, String path)

Implements abstract jakarta.faces.application.ViewHandler.getResourceURL.

This code is currently common to all ViewHandlingStrategy instances.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.getResourceURL.

FacesContext for the current request

path:String

Doc from jakarta.faces.application.ViewHandler.getResourceURL.

Resource path to convert to a URL

Returns:String

Doc from jakarta.faces.application.ViewHandler.getResourceURL.

the resource URL.

Annotations

@Override

getStringValueToTransfer	back to summary
private static String getStringValueToTransfer(FacesContext context, UIViewParameter param, Collection<UIViewParameter> viewParams)

getViewDeclarationLanguage back to summary

getViewDeclarationLanguage	back to summary
public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context, String viewId) Overrides jakarta.faces.application.ViewHandler.getViewDeclarationLanguage. Doc from jakarta.faces.application.ViewHandler.getViewDeclarationLanguage. Return the `ViewDeclarationLanguage` instance used for this `ViewHandler` instance. The default implementation must use `jakarta.faces.view.ViewDeclarationLanguageFactory#getViewDeclarationLanguage` to obtain the appropriate `ViewDeclarationLanguage` implementation for the argument `viewId`. Any exceptions thrown as a result of invoking that method must not be swallowed. The default implementation of this method returns null. Parameters context:FacesContext the `FacesContext` for this request. viewId:String the logical view id, as returned from `deriveLogicalViewId` for which the `ViewDeclarationLanguage` should be returned. Returns:ViewDeclarationLanguage the ViewDeclarationLanguage, or null. Annotations @Override See Also `ViewHandler#getViewDeclarationLanguage(jakarta.faces.context.FacesContext, String)`

public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context, String viewId)

Overrides jakarta.faces.application.ViewHandler.getViewDeclarationLanguage.

Doc from jakarta.faces.application.ViewHandler.getViewDeclarationLanguage.

Return the ViewDeclarationLanguage instance used for this ViewHandler instance.

The default implementation must use jakarta.faces.view.ViewDeclarationLanguageFactory#getViewDeclarationLanguage to obtain the appropriate ViewDeclarationLanguage implementation for the argument viewId. Any exceptions thrown as a result of invoking that method must not be swallowed.

The default implementation of this method returns null.

Parameters

context:FacesContext: the FacesContext for this request.
viewId:String: the logical view id, as returned from deriveLogicalViewId for which the ViewDeclarationLanguage should be returned.

Returns:ViewDeclarationLanguage

the ViewDeclarationLanguage, or null.

Annotations

@Override

getViews back to summary

getViews	back to summary
public Stream<String> getViews(FacesContext context, String path, ViewVisitOption... options) Overrides jakarta.faces.application.ViewHandler.getViews. Doc from jakarta.faces.application.ViewHandler.getViews. Return a `Stream` possibly lazily populated by walking the view trees of every active `ViewDeclarationLanguage` rooted at a given initial path. The view tree of every `ViewDeclarationLanguage` is individually traversed breadth-first as per the contract of `ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...)`. The elements in the stream are logical view ids. This method works as if invoking it were equivalent to evaluating the expression: getViews(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the view tree. In case more than one active `ViewDeclarationLanguage` is present, the order in which view ids from each `ViewDeclarationLanguage` appear in the stream is undetermined, except for the guarantee that every individual `ViewDeclarationLanguage` is traversed breadth-first. Parameters context:FacesContext The `FacesContext` for this request. path:String The initial path from which to start looking for view ids. options:ViewVisitOption[] The options to influence the traversal. See `ViewVisitOption` for details on those. Returns:Stream<String> the `Stream` of view ids Annotations @Override

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

Overrides jakarta.faces.application.ViewHandler.getViews.

Doc from jakarta.faces.application.ViewHandler.getViews.

Return a Stream possibly lazily populated by walking the view trees of every active ViewDeclarationLanguage rooted at a given initial path. The view tree of every ViewDeclarationLanguage is individually traversed breadth-first as per the contract of ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...). The elements in the stream are logical view ids.

This method works as if invoking it were equivalent to evaluating the expression:

getViews(facesContext, start, Integer.MAX_VALUE, options)

Put differently, it visits all levels of the view tree.

In case more than one active ViewDeclarationLanguage is present, the order in which view ids from each ViewDeclarationLanguage appear in the stream is undetermined, except for the guarantee that every individual ViewDeclarationLanguage is traversed breadth-first.

Parameters

context:FacesContext: The FacesContext for this request.
path:String: The initial path from which to start looking for view ids.
options:ViewVisitOption[]: The options to influence the traversal. See ViewVisitOption for details on those.

Returns:Stream<String>

the Stream of view ids

Annotations

@Override

getViews back to summary

getViews	back to summary
public Stream<String> getViews(FacesContext context, String path, int maxDepth, ViewVisitOption... options) Overrides jakarta.faces.application.ViewHandler.getViews. Doc from jakarta.faces.application.ViewHandler.getViews. Return a `Stream` possibly lazily populated by walking the view trees of every active `ViewDeclarationLanguage` rooted at a given initial path. The view tree of every `ViewDeclarationLanguage` is individually traversed breadth-first as per the contract of `ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...)`. The elements in the stream are logical view ids. The `maxDepth` parameter is the maximum depth of directory levels to visit for each `ViewDeclarationLanguage` beyond the initial path, which is always visited. The value is relative to the root (`/`), not to the given initial path. E.g. given `maxDepth` = `3` and initial path `/foo/`, visiting will proceed up to `/foo/bar/`, where `/` counts as depth `1`, `/foo/` as depth `2` and `/foo/bar/` as depth `3`. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of `MAX_VALUE` may be used to indicate that all levels should be visited. In case more than one active `ViewDeclarationLanguage` is present, the order in which view ids from each `ViewDeclarationLanguage` appear in the stream is undetermined, except for the guarantee that every individual `ViewDeclarationLanguage` is traversed breadth-first. Parameters context:FacesContext The `FacesContext` for this request. path:String The initial path from which to start looking for view ids. maxDepth:int The absolute maximum depth of nested directories to visit counted from the root (`/`). options:ViewVisitOption[] The options to influence the traversal. See `ViewVisitOption` for details on those. Returns:Stream<String> the `Stream` of view ids Annotations @Override

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

Overrides jakarta.faces.application.ViewHandler.getViews.

Doc from jakarta.faces.application.ViewHandler.getViews.

The maxDepth parameter is the maximum depth of directory levels to visit for each ViewDeclarationLanguage beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of MAX_VALUE may be used to indicate that all levels should be visited.

Parameters

context:FacesContext: The FacesContext for this request.
path:String: The initial path from which to start looking for view ids.
maxDepth:int: The absolute maximum depth of nested directories to visit counted from the root (/).
options:ViewVisitOption[]: The options to influence the traversal. See ViewVisitOption for details on those.

Returns:Stream<String>

the Stream of view ids

Annotations

@Override

getWebsocketURL back to summary

getWebsocketURL	back to summary
public String getWebsocketURL(FacesContext context, String channel) Implements abstract jakarta.faces.application.ViewHandler.getWebsocketURL. Doc from jakarta.faces.application.ViewHandler.getWebsocketURL. If the value returned from this method is used as the `file` argument to the four-argument constructor for `java.net.URL` (assuming appropriate values are used for the first three arguments), then a client making a push handshake request to the `toExternalForm()` of that `URL` will select the argument `channel` for connecting the websocket push channel in the current view. It must match the `PushContext#URI_PREFIX` of the endpoint. Parameters context:FacesContext `FacesContext` for the current request. channel:String The channel name of the websocket. Returns:String the websocket URL. Annotations @Override

public String getWebsocketURL(FacesContext context, String channel)

Implements abstract jakarta.faces.application.ViewHandler.getWebsocketURL.

Doc from jakarta.faces.application.ViewHandler.getWebsocketURL.

If the value returned from this method is used as the file argument to the four-argument constructor for java.net.URL (assuming appropriate values are used for the first three arguments), then a client making a push handshake request to the toExternalForm() of that URL will select the argument channel for connecting the websocket push channel in the current view. It must match the PushContext#URI_PREFIX of the endpoint.

Parameters

context:FacesContext: FacesContext for the current request.
channel:String: The channel name of the websocket.

Returns:String

the websocket URL.

Annotations

@Override

initView back to summary

initView	back to summary
public void initView(FacesContext context) throws FacesException Overrides jakarta.faces.application.ViewHandler.initView. Call the default implementation of `jakarta.faces.application.ViewHandler#initView(jakarta.faces.context.FacesContext)` Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.initView. the Faces context. Annotations @Override Exceptions FacesException: Doc from jakarta.faces.application.ViewHandler.initView. 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. See Also `jakarta.faces.application.ViewHandler#initView(jakarta.faces.context.FacesContext)`

public void initView(FacesContext context) throws FacesException

Overrides jakarta.faces.application.ViewHandler.initView.

Call the default implementation of jakarta.faces.application.ViewHandler#initView(jakarta.faces.context.FacesContext)

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.initView.

the Faces context.

Annotations

@Override

Exceptions

FacesException:

Doc from jakarta.faces.application.ViewHandler.initView.

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.

normalizeRequestURI back to summary

normalizeRequestURI	back to summary
protected String normalizeRequestURI(String viewId, String mapping) If the specified mapping is a prefix mapping, and the provided request URI (sometimes the value from `ExternalContext.getRequestServletPath()`) starts with `mapping`, prune the mapping from the URI and return it, otherwise, return the original URI. Parameters viewId:String something resembling a view id, can come from the request or from the navigation handler. mapping:String the FacesServlet mapping used for this request with the "/" removed, e.g. /faces instead of /faces/ Returns:String the viewId without additional prefix FacesServlet mappings Since 1.2

protected String normalizeRequestURI(String viewId, String mapping)

If the specified mapping is a prefix mapping, and the provided request URI (sometimes the value from ExternalContext.getRequestServletPath()) starts with mapping, prune the mapping from the URI and return it, otherwise, return the original URI.

Parameters

viewId:String: something resembling a view id, can come from the request or from the navigation handler.
mapping:String: the FacesServlet mapping used for this request with the "/*" removed, e.g. /faces instead of /faces/*

Returns:String

the viewId without additional prefix FacesServlet mappings

Since

1.2

paramHasValueExpression	back to summary
private static boolean paramHasValueExpression(UIViewParameter param)

removeProtectedView back to summary

removeProtectedView	back to summary
public boolean removeProtectedView(String urlPattern) Overrides jakarta.faces.application.ViewHandler.removeProtectedView. Doc from jakarta.faces.application.ViewHandler.removeProtectedView. Remove the argument `urlPattern` from the thread safe `Set` of protected views for this application, if present in the `Set`. If the argument `urlPattern` is not present in the `Set`, this method has no effect. Compliant implementations must make it so a subsequent call to `getProtectedViewsUnmodifiable` does not contain the argument. The runtime must support calling this method at any time after application startup. Returns `true` if this `Set` contained the argument. The default implementation takes no action and returns `false`. Parameters urlPattern:String the url-pattern to remove. Returns:boolean `true` if in the `Set`, `false` otherwise. Annotations @Override

public boolean removeProtectedView(String urlPattern)

Overrides jakarta.faces.application.ViewHandler.removeProtectedView.

Doc from jakarta.faces.application.ViewHandler.removeProtectedView.

Remove the argument urlPattern from the thread safe Set of protected views for this application, if present in the Set. If the argument urlPattern is not present in the Set, this method has no effect. Compliant implementations must make it so a subsequent call to getProtectedViewsUnmodifiable does not contain the argument. The runtime must support calling this method at any time after application startup. Returns true if this Set contained the argument. The default implementation takes no action and returns false.

Parameters

urlPattern:String: the url-pattern to remove.

Returns:boolean

true if in the Set, false otherwise.

Annotations

@Override

renderView back to summary

renderView	back to summary
public void renderView(FacesContext context, UIViewRoot viewToRender) throws IOException, FacesException Implements abstract jakarta.faces.application.ViewHandler.renderView. Call `ViewDeclarationLanguage#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)` if the view can be rendered. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.renderView. `FacesContext` for the current request viewToRender:UIViewRoot Doc from jakarta.faces.application.ViewHandler.renderView. the view to render Annotations @Override Exceptions IOException: Doc from jakarta.faces.application.ViewHandler.renderView. if an input/output error occurs FacesException: Doc from jakarta.faces.application.ViewHandler.renderView. if a Jakarta Servlet error occurs See Also `ViewHandler#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)`

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

Implements abstract jakarta.faces.application.ViewHandler.renderView.

Call ViewDeclarationLanguage#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) if the view can be rendered.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.renderView.

FacesContext for the current request

viewToRender:UIViewRoot

Doc from jakarta.faces.application.ViewHandler.renderView.

the view to render

Annotations

@Override

Exceptions

IOException:

Doc from jakarta.faces.application.ViewHandler.renderView.

if an input/output error occurs

FacesException:

Doc from jakarta.faces.application.ViewHandler.renderView.

if a Jakarta Servlet error occurs

restoreView back to summary

restoreView	back to summary
public UIViewRoot restoreView(FacesContext context, String viewId) Implements abstract jakarta.faces.application.ViewHandler.restoreView. Call `ViewDeclarationLanguage#restoreView(jakarta.faces.context.FacesContext, String)`. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.restoreView. `FacesContext` for the current request viewId:String Doc from jakarta.faces.application.ViewHandler.restoreView. the view identifier for the current request Returns:UIViewRoot Doc from jakarta.faces.application.ViewHandler.restoreView. the restored view root, or null. Annotations @Override See Also `ViewHandler#restoreView(jakarta.faces.context.FacesContext, String)`

public UIViewRoot restoreView(FacesContext context, String viewId)

Implements abstract jakarta.faces.application.ViewHandler.restoreView.

Call ViewDeclarationLanguage#restoreView(jakarta.faces.context.FacesContext, String).

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.restoreView.

FacesContext for the current request

viewId:String

Doc from jakarta.faces.application.ViewHandler.restoreView.

the view identifier for the current request

Returns:UIViewRoot

Doc from jakarta.faces.application.ViewHandler.restoreView.

the restored view root, or null.

Annotations

@Override

send404Error back to summary

send404Error	back to summary
protected void send404Error(FacesContext context) Send `HttpServletResponse#SC_NOT_FOUND` (404) to the client. Parameters context:FacesContext the `FacesContext` for the current request

protected void send404Error(FacesContext context)

Send HttpServletResponse#SC_NOT_FOUND (404) to the client.

Parameters

context:FacesContext: the FacesContext for the current request

writeState back to summary

writeState	back to summary
public void writeState(FacesContext context) throws IOException Implements abstract jakarta.faces.application.ViewHandler.writeState. This code is currently common to all `ViewHandlingStrategy` instances. Parameters context:FacesContext Doc from jakarta.faces.application.ViewHandler.writeState. `FacesContext` for the current request Annotations @Override Exceptions IOException: Doc from jakarta.faces.application.ViewHandler.writeState. if an input/output error occurs See Also `ViewHandler#writeState(jakarta.faces.context.FacesContext)`

public void writeState(FacesContext context) throws IOException

Implements abstract jakarta.faces.application.ViewHandler.writeState.

This code is currently common to all ViewHandlingStrategy instances.

Parameters

context:FacesContext

Doc from jakarta.faces.application.ViewHandler.writeState.

FacesContext for the current request

Annotations