org.josef.web.jsf.util

Class JsfUtil

java.lang.Object

org.josef.web.jsf.util.JsfUtil

public final class JsfUtil
extends Object

Java Server Faces Utility class.

Version:

1.0 $Revision: 5221 $

Author:

Kees Schotanus, Rens van Leeuwen

Method Summary

Modifier and Type	Method and Description
static javax.faces.application.Application	getApplication() Convenience method to get the application.
static Map<String,Object>	getApplicationMap() Convenience method to get the application map.
static String	getContextParameter(String name) Convenience method to get a context parameter.
static javax.el.ELContext	getELContext() Convenience method to get the expression language context.
static javax.faces.context.ExternalContext	getExternalContext() Convenience method to get the external context.
static javax.faces.context.FacesContext	getFacesContext() Convenience method to get the faces context.
static Object	getObjectFromApplication(String key) Gets an Object from the current application.
static Long	getObjectIdFromActionEvent(javax.faces.event.ActionEvent actionEvent) Gets the Object ID from the supplied actionEvent.
static javax.faces.component.UIViewRoot	getViewRoot() Convenience method to get the ui view root.
static boolean	isUserInRole(String role) Determines if the currently logged in user (if any) is in the supplied role.
static boolean	isUserLoggedIn() Determines if there is a currently logged in user.
static String	toString(javax.faces.event.PhaseEvent phaseEvent) Creates a String representation of the supplied phaseEvent.

Methods inherited from class java.lang.Object

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

Method Detail

getFacesContext

public static javax.faces.context.FacesContext getFacesContext()

Convenience method to get the faces context.

Returns:

The faces context.

getViewRoot

public static javax.faces.component.UIViewRoot getViewRoot()

Convenience method to get the ui view root.

Returns:

The ui view root.

getELContext

public static javax.el.ELContext getELContext()

Convenience method to get the expression language context.

Returns:

The expression language context.

getExternalContext

public static javax.faces.context.ExternalContext getExternalContext()

Convenience method to get the external context.

Returns:

The external context.

getApplicationMap

public static Map<String,Object> getApplicationMap()

Convenience method to get the application map.

Returns:

The application map.

getContextParameter

public static String getContextParameter(String name)

Convenience method to get a context parameter.

Parameters:

name - The name of the context parameter.

Returns:

The value of the context parameter with the supplied name or null when no such context parameter exists.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When the supplied name is null.

getObjectIdFromActionEvent

public static Long getObjectIdFromActionEvent(javax.faces.event.ActionEvent actionEvent)

Gets the Object ID from the supplied actionEvent.
Actually the Object ID is an attribute of the component that in turn is retrieved from the supplied actionEvent.
Postcondition: When the objectID attribute could not be retrieved, a JSF Message is automatically added.

Parameters:

actionEvent - The event from which the Object ID must be retrieved.

Returns:

The Object ID from the supplied actionEvent or null when the Object ID does not exist.

Throws:

NullPointerException - When the supplied ectionEvent is null.

getApplication

public static javax.faces.application.Application getApplication()

Convenience method to get the application.

Returns:

The application.

getObjectFromApplication

public static Object getObjectFromApplication(String key)

Gets an Object from the current application.

Parameters:

key - The key of the object to get.

Returns:

An Object from the current application or null when the application does not contain the requested object with the supplied key.

isUserInRole

public static boolean isUserInRole(String role)

Determines if the currently logged in user (if any) is in the supplied role.

Parameters:

role - The role to check.

Returns:

True when the currently logged in user is in the supplied role, otherwise false is returned.

isUserLoggedIn

public static boolean isUserLoggedIn()

Determines if there is a currently logged in user.

Returns:

True when a user is logged in, otherwise false is returned.

toString

public static String toString(javax.faces.event.PhaseEvent phaseEvent)

Creates a String representation of the supplied phaseEvent.

Parameters:

phaseEvent - The phaseEvent to create a String representation of.

Returns:

A String representation of the supplied phaseEvent.