Package com.sun.faces.application

Class NavigationHandlerImpl

java.lang.Object

jakarta.faces.application.NavigationHandler

jakarta.faces.application.ConfigurableNavigationHandler

com.sun.faces.application.NavigationHandlerImpl

public class NavigationHandlerImpl
extends ConfigurableNavigationHandler

NavigationHandlerImpl is the class that implements default navigation handling. Refer to section 7.4.2 of the specification for more details. PENDING: Make independent of ApplicationAssociate.

Constructor Summary

Constructors

Constructor	Description
NavigationHandlerImpl()	This constructor uses the current ApplicationAssociate instance to obtain the navigation mappings used to make navigational decisions.

Method Summary

Modifier and Type	Method	Description
NavigationCase	getNavigationCase(FacesContext context, String fromAction, String outcome)	Return the NavigationCase representing the navigation that would be taken had NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no such case.
NavigationCase	getNavigationCase(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)	Return the NavigationCase representing the navigation that would be taken had NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no such case.
Map<String,Set<NavigationCase>>	getNavigationCases()	Return a Map<String, Set<NavigationCase>> where the keys are <from-view-id> values and the values are Set<NavigationCase> where each element in the Set is a NavigationCase that applies to that <from-view-id>.
void	handleNavigation(FacesContext context, String fromAction, String outcome)	Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action.
void	handleNavigation(FacesContext context, String fromAction, String outcome, String toFlowDocumentId)	Overloaded variant of NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a flow to be entered by this navigation.
void	inspectFlow(FacesContext context, Flow flow)	Called by the flow system to cause the flow to be inspected for navigation rules.
static boolean	isResetFlowHandlerState(FacesContext facesContext)
static void	setResetFlowHandlerStateIfUnset(FacesContext facesContext, boolean resetFlowHandlerState)
static void	unsetResetFlowHandlerState(FacesContext facesContext)

Methods inherited from class jakarta.faces.application.ConfigurableNavigationHandler

performNavigation

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationHandlerImpl

public NavigationHandlerImpl()

This constructor uses the current ApplicationAssociate instance to obtain the navigation mappings used to make navigational decisions.

Method Detail

isResetFlowHandlerState

public static boolean isResetFlowHandlerState(FacesContext facesContext)

setResetFlowHandlerStateIfUnset

public static void setResetFlowHandlerStateIfUnset(FacesContext facesContext,
                                                   boolean resetFlowHandlerState)

unsetResetFlowHandlerState

public static void unsetResetFlowHandlerState(FacesContext facesContext)

getNavigationCase

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

Description copied from class: ConfigurableNavigationHandler

Return the NavigationCase representing the navigation that would be taken had NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no such case.

Specified by:

getNavigationCase in class ConfigurableNavigationHandler

Parameters:

context - The FacesContext for the current request

fromAction - The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome - The logical outcome returned by a previous invoked application action (which may be null)

Returns:

the navigation case, or null.

See Also:

ConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, String, String)

getNavigationCase

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

Description copied from class: ConfigurableNavigationHandler

Return the NavigationCase representing the navigation that would be taken had NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) been called with the same arguments or null if there is no such case. Implementations that comply the version of the specification in which this method was introduced must override this method. For compatibility with decorated implementations that comply with an earlier version of the specification, an implementation is provided that simply calls through to ConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter.

Overrides:

getNavigationCase in class ConfigurableNavigationHandler

Parameters:

context - The FacesContext for the current request

fromAction - The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome - The logical outcome returned by a previous invoked application action (which may be null)

toFlowDocumentId - The value of the toFlowDocumentId property for the navigation case (which may be null)

Returns:

the navigation case, or null.

getNavigationCases

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

Description copied from class: ConfigurableNavigationHandler

Return a Map<String, Set<NavigationCase>> where the keys are <from-view-id> values and the values are Set<NavigationCase> where each element in the Set is a NavigationCase that applies to that <from-view-id>. The implementation must support live modifications to this Map.

Specified by:

getNavigationCases in class ConfigurableNavigationHandler

Returns:

a map with navigation cases.

See Also:

ConfigurableNavigationHandler.getNavigationCases()

inspectFlow

public void inspectFlow(FacesContext context,
                        Flow flow)

Description copied from class: ConfigurableNavigationHandler

Called by the flow system to cause the flow to be inspected for navigation rules. For backward compatibility with earlier implementations, an empty method is provided.

Overrides:

inspectFlow in class ConfigurableNavigationHandler

Parameters:

context - the Faces context.

flow - the flow.

handleNavigation

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

Description copied from class: NavigationHandler

Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action.

If the implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee that the logic used in a call to ConfigurableNavigationHandler.getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) is used in this method to determine the correct navigation.

This method must set the render targets (used in partial rendering) to render all invoking PartialViewContext.setRenderAll(boolean)) if the view identifier has changed as the result of an application action (to take into account Ajax requests).

Specified by:

handleNavigation in class NavigationHandler

Parameters:

context - The FacesContext for the current request

fromAction - The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome - The logical outcome returned by a previous invoked application action (which may be null)

handleNavigation

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

Description copied from class: NavigationHandler

Overloaded variant of NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a flow to be entered by this navigation. For backward compatibility with decorated NavigationHandler implementations that conform to an earlier version of the specification, an implementation is provided that calls through to NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter.

Overrides:

handleNavigation in class NavigationHandler

Parameters:

context - The FacesContext for the current request

fromAction - The action binding expression that was evaluated to retrieve the specified outcome, or null if the outcome was acquired by some other means

outcome - The logical outcome returned by a previous invoked application action (which may be null)

toFlowDocumentId - The defining document id of the flow into which this navigation will cause entry.