Class NavigationHandler

  • Direct Known Subclasses:
    ConfigurableNavigationHandler, NavigationHandlerWrapper

    public abstract class NavigationHandler
    extends Object

    A NavigationHandler is passed the outcome string returned by an application action invoked for this application, and will use this (along with related state information) to choose the view to be displayed next.

    A default implementation of NavigationHandler must be provided by the Jakarta Faces implementation, which will be utilized unless setNavigationHandler() is called to establish a different one. An implementation of this class must be thread-safe. This default instance will compare the view identifier of the current view, the specified action binding, and the specified outcome against any navigation rules provided in faces-config.xml file(s). If a navigation case matches, the current view will be changed by a call to FacesContext.setViewRoot(). Note that a null outcome value will never match any navigation rule, so it can be used as an indicator that the current view should be redisplayed.