org.josef.web.jsf.util

Class JsfNavigationUtil

java.lang.Object

org.josef.web.jsf.util.JsfNavigationUtil

public final class JsfNavigationUtil
extends Object

Java Server Faces Utility class related to navigation.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static void	forward(String path) Forwards (dispatches) to the supplied path.
static javax.faces.application.NavigationHandler	getNavigationHandler() Convenience method to get the navigation handler.
static void	handleNavigation(String fromAction, String outcome) Handles navigation by delegating to NavigationHandler.handleNavigation(FacesContext, String, String) except for the fact that this method adds "?faces-redirect=true")" to the supplied outcome to perform an actual redirect.
static void	handleNavigation(String fromAction, String outcome, boolean redirect) Handles navigation by delegating to NavigationHandler.handleNavigation(FacesContext, String, String) and optionally performs a redirect instead of a forward.
static void	redirect(String url) Redirects to the supplied url.
static void	refresh() Refreshes the current page by redirecting to it.

Methods inherited from class java.lang.Object

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

Method Detail

forward

public static void forward(String path)

Forwards (dispatches) to the supplied path.
Postcondition: A forward as been performed or a warning message is logged.

Parameters:

path - Context relative path to the specified resource, which must start with a slash ("/") character.

Throws:

IllegalArgumentException - When the supplied path is empty.

NullPointerException - When the supplied path is null.

refresh

public static void refresh()

Refreshes the current page by redirecting to it.
Postcondition: A refresh has been performed or a warning message is logged.

redirect

public static void redirect(String url)

Redirects to the supplied url.
Postcondition: A redirect has been performed or a warning message is logged.

Parameters:

url - The url to redirect to.

Throws:

IllegalArgumentException - When the supplied url is empty.

NullPointerException - When the supplied url is null.

getNavigationHandler

public static javax.faces.application.NavigationHandler getNavigationHandler()

Convenience method to get the navigation handler.

Returns:

The navigation handler.

handleNavigation

public static void handleNavigation(String fromAction,
                                    String outcome)

Handles navigation by delegating to NavigationHandler.handleNavigation(FacesContext, String, String) except for the fact that this method adds "?faces-redirect=true")" to the supplied outcome to perform an actual redirect.

Parameters:

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 static void handleNavigation(String fromAction,
                                    String outcome,
                                    boolean redirect)

Handles navigation by delegating to NavigationHandler.handleNavigation(FacesContext, String, String) and optionally performs a redirect instead of a forward.

Parameters:

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).

redirect - True to perform an actual redirect, false to forward.