Module org.omnifaces

Package org.omnifaces.facesviews

Class DynamicRoutesNavigationHandler

java.lang.Object

jakarta.faces.application.NavigationHandler

jakarta.faces.application.ConfigurableNavigationHandler

org.omnifaces.facesviews.DynamicRoutesNavigationHandler

public class DynamicRoutesNavigationHandler
extends ConfigurableNavigationHandler

Resolves an outcome which spells out a dynamic route with its segment values already filled in, such as <h:link outcome="/organizations/123/members" />, so that the concrete URL can be used as the outcome instead of the bracketed template plus a <o:pathParam name> for every segment.

Such an outcome resolves to no view of its own, as the only view on disk is the bracketed one, so the standard navigation handler finds no navigation case for it and the outcome target component renders without a target at all. This wrapper walks the scanned dynamic routes instead and, on a match, produces a navigation case which points at the physical bracketed view and carries the resolved segment values as parameters named after "org.omnifaces.pathparam.". Both implementations merge the parameters of a navigation case into the ones handed to ViewHandler.getBookmarkableURL(FacesContext, String, Map, boolean), which is where FacesViewsViewHandler substitutes them back into the URL.

Only the named segments come from the outcome. An outcome whose trailing segments would be swallowed as the path info of a MultiViews view resolves to no navigation case, as a navigation case has no way to carry them; name the view itself in the outcome and supply those segments with a nested unnamed <o:pathParam>.

Since:

5.5

Author:

Bauke Scholtz

See Also:

• FacesViews

Constructor Summary

Constructors

Constructor	Description
DynamicRoutesNavigationHandler(NavigationHandler wrapped)	Construct the dynamic routes navigation handler.

Method Summary

Modifier and Type	Method	Description
NavigationCase	getNavigationCase(FacesContext context, String fromAction, String outcome)	An explicitly declared navigation case for an outcome which also resolves to a dynamic route takes precedence over that dynamic route.
NavigationCase	getNavigationCase(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)
Map<String,Set<NavigationCase>>	getNavigationCases()
NavigationHandler	getWrapped()	Returns the wrapped navigation handler.
void	handleNavigation(FacesContext context, String fromAction, String outcome)	The wrapped navigation handler resolves an action outcome by consulting its own navigation cases rather than this wrapper's, so a dynamic route would otherwise be invisible to it and the navigation would silently not happen at all.

Methods inherited from class jakarta.faces.application.ConfigurableNavigationHandler

inspectFlow, performNavigation

Methods inherited from class jakarta.faces.application.NavigationHandler

handleNavigation

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicRoutesNavigationHandler

public DynamicRoutesNavigationHandler(NavigationHandler wrapped)

Construct the dynamic routes navigation handler.

Parameters:

wrapped - The navigation handler to be wrapped.

Method Details

getWrapped

public NavigationHandler getWrapped()

Returns the wrapped navigation handler.

Returns:

The wrapped navigation handler.

getNavigationCases

public Map<String,Set<NavigationCase>> getNavigationCases()

Specified by:

getNavigationCases in class ConfigurableNavigationHandler

getNavigationCase

public NavigationCase getNavigationCase(FacesContext context,
 String fromAction,
 String outcome)

An explicitly declared navigation case for an outcome which also resolves to a dynamic route takes precedence over that dynamic route.

Specified by:

getNavigationCase in class ConfigurableNavigationHandler

getNavigationCase

public NavigationCase getNavigationCase(FacesContext context,
 String fromAction,
 String outcome,
 String toFlowDocumentId)

Overrides:

getNavigationCase in class ConfigurableNavigationHandler

handleNavigation

public void handleNavigation(FacesContext context,
 String fromAction,
 String outcome)

The wrapped navigation handler resolves an action outcome by consulting its own navigation cases rather than this wrapper's, so a dynamic route would otherwise be invisible to it and the navigation would silently not happen at all.

Specified by:

handleNavigation in class NavigationHandler