org.josef.web.jsf.util

Class JsfMessageUtil

java.lang.Object

org.josef.web.jsf.util.JsfMessageUtil

public final class JsfMessageUtil
extends Object

JSF Message Utility class.
Aids in getting JSF messages (with summary and detail) from Resource Bundles configured in faces-config.xml.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUNDLE Name of the application's resource bundle as defined as a var in faces-Config.xml.
static String	DETAIL_SUFFIX The suffix that is added to the bundle key to get the detail message.

Method Summary

Modifier and Type	Method and Description
static void	addMessage(javax.faces.application.FacesMessage message) Adds the supplied message as a generic (not for a particular component) message.
static void	addMessage(javax.faces.application.FacesMessage message, javax.faces.application.FacesMessage.Severity severity) Adds the supplied message with the supplied severity, as a generic (not for a particular component) message.
static void	addMessage(String clientId, javax.faces.application.FacesMessage message) Adds the supplied message, as a specific message, for a component with the supplied clientId.
static void	addMessage(String clientId, javax.faces.application.FacesMessage message, javax.faces.application.FacesMessage.Severity severity) Adds the supplied message with the supplied severity, as a specific message, for a component with the supplied clientId.
static javax.faces.application.FacesMessage	createErrorMessageFromLocalizedException(AbstractLocalizedException localizedException) Creates a faces error message from the supplied localizedException.
static javax.faces.application.FacesMessage	createErrorMessageFromLocalizedRuntimeException(AbstractLocalizedRuntimeException localizedRuntimeException) Creates a faces error message from the supplied localizedRuntimeException.
static String	createJavaScriptAlert(javax.faces.application.FacesMessage message) Creates JavaScript code to create an alert (dialog box) that contains the supplied message.
static String	getCssClassForSeverity(javax.faces.application.FacesMessage.Severity severity) Gets the css class that corresponds to the supplied severity.
static javax.faces.application.FacesMessage	getErrorMessage(String bundleVarName, String bundleKey, Object... messageArguments) Gets an error message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.
static String	getImageForSeverity(javax.faces.application.FacesMessage.Severity severity) Gets the image that belongs to a message of the supplied severity.
static javax.faces.application.FacesMessage	getJosefErrorMessage(String bundleKey, Object... messageArguments) Gets an error message from the standard Josef ResourceBundle.
static javax.faces.application.FacesMessage	getJosefMessage(String bundleKey, Object... messageArguments) Gets a message from the standard Josef ResourceBundle.
static String	getJosefStringMessage(String bundleKey, Object... messageArguments) Gets a String message from Josef's Resource bundle with the supplied bundleKey.
static String	getJsfStandardStringMessage(String bundleKey, Object... messageArguments) Gets a String message from the standard JSF Resource bundle, with the supplied bundleKey.
static javax.faces.application.FacesMessage	getMessage(String bundleVarName, String bundleKey, Object... messageArguments) Gets a message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.
static javax.faces.application.FacesMessage	getMessage(Throwable throwable) Gets a message from the supplied throwable.
static javax.faces.application.FacesMessage	getMostSevereMessage(Collection<javax.faces.application.FacesMessage> messages) Gets the most severe message from the supplied collection of messages.
static String	getOptionalStringMessage(String bundleVarName, String bundleKey, String defaultValue, Object... messageArguments) Gets an optional String message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.
static String	getRequiredStringMessage(String bundleVarName, String bundleKey, Object... messageArguments) Gets a String message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey which must be present.
static ResourceBundle	getResourceBundle(String bundleVarName) Gets the ResourceBundle with the supplied bundleVarName.
static String	getStringMessage(String bundleVarName, String bundleKey, Object... messageArguments) Gets a String message from the Resource bundle with the supplied bundleVarName and the supplied bundleKey.
static boolean	hasErrorOccurred() Determines whether an error has occurred.

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE

public static final String BUNDLE

Name of the application's resource bundle as defined as a var in faces-Config.xml.

See Also:

Constant Field Values

DETAIL_SUFFIX

public static final String DETAIL_SUFFIX

The suffix that is added to the bundle key to get the detail message.

See Also:

Constant Field Values

Method Detail

addMessage

public static void addMessage(javax.faces.application.FacesMessage message,
                              javax.faces.application.FacesMessage.Severity severity)

Adds the supplied message with the supplied severity, as a generic (not for a particular component) message.

Parameters:

message - The message to add.

severity - The severity of the messages.

Throws:

NullPointerException - When the supplied message is null.

addMessage

public static void addMessage(javax.faces.application.FacesMessage message)

Adds the supplied message as a generic (not for a particular component) message.

Parameters:

message - The message to add.

Throws:

NullPointerException - When the supplied message is null.

addMessage

public static void addMessage(String clientId,
                              javax.faces.application.FacesMessage message,
                              javax.faces.application.FacesMessage.Severity severity)

Adds the supplied message with the supplied severity, as a specific message, for a component with the supplied clientId.

Parameters:

clientId - Client ID of the component for which the message should be added.

message - The message to add.

severity - The severity of the messages.

Throws:

IllegalArgumentException - When the supplied clientId is empty.

NullPointerException - When either the supplied clientId or message is null.

addMessage

public static void addMessage(String clientId,
                              javax.faces.application.FacesMessage message)

Adds the supplied message, as a specific message, for a component with the supplied clientId.

Parameters:

clientId - Client ID of the component for which the message should be added.

message - The message to add.

Throws:

IllegalArgumentException - When the supplied clientId is empty.

NullPointerException - When either the supplied clientId or message is null.

getResourceBundle

public static ResourceBundle getResourceBundle(String bundleVarName)

Gets the ResourceBundle with the supplied bundleVarName.

Parameters:

bundleVarName - Name of the ResourceBundle as configured in faces-config.xml.

Returns:

The ResourceBundle with the supplied bundleVarName.

Throws:

javax.faces.FacesException - When the ResourceBundle has been configured but is not resolvable.

MissingResourceException - When no ResourceBundle with the supplied bundleVarName exists.
A message of type Level.SEVERE is logged.

NullPointerException - When the supplied bundleVarName is null.

IllegalArgumentException - When the supplied bundleVarName is empty.

getJosefMessage

public static javax.faces.application.FacesMessage getJosefMessage(String bundleKey,
                                                                   Object... messageArguments)

Gets a message from the standard Josef ResourceBundle.
The Standard Josef ResourceBundle must be configured with a var name of "josefBundle".

Parameters:

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

A message from the standard Josef ResourceBundle.
When the supplied bundleKey is not present in the ResourceBundle, a message containing the supplied bundleKey is returned, hence no MissingResourceException is thrown! This event is logged as a Level.WARNING

Throws:

javax.faces.FacesException - When the josefBundle has been configured but is not resolvable.

NullPointerException - When the supplied bundleKey is null.

IllegalArgumentException - When the supplied bundleKey is empty or when the message could not be formatted.

See Also:

getMessage(String, String, Object...)

getJosefErrorMessage

public static javax.faces.application.FacesMessage getJosefErrorMessage(String bundleKey,
                                                                        Object... messageArguments)

Gets an error message from the standard Josef ResourceBundle.
The Standard Josef ResourceBundle must be configured with a var name of "josefBundle".

Parameters:

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

An error message from the standard Josef ResourceBundle.
When the supplied bundleKey is not present in the ResourceBundle, a message containing the supplied bundleKey is returned, hence no MissingResourceException is thrown! This event is logged as a Level.WARNING.

Throws:

javax.faces.FacesException - When the josefBundle has been configured but is not resolvable.

NullPointerException - When the supplied bundleKey is null.

IllegalArgumentException - When the supplied bundleKey is empty or when the message could not be formatted.

See Also:

getMessage(String, String, Object...)

getJsfStandardStringMessage

public static String getJsfStandardStringMessage(String bundleKey,
                                                 Object... messageArguments)

Gets a String message from the standard JSF Resource bundle, with the supplied bundleKey.

Parameters:

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

A message from the ResourceBundle with the corresponding, supplied bundleVarName.

Throws:

MissingResourceException - When the supplied bundleKey does not exist.

NullPointerException - When the supplied bundleKey is null.

IllegalArgumentException - When either the supplied bundleKey is empty or when the message could not be formatted.

getMessage

public static javax.faces.application.FacesMessage getMessage(String bundleVarName,
                                                              String bundleKey,
                                                              Object... messageArguments)

Gets a message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.
The severity of the returned message will be INFO.

Parameters:

bundleVarName - The variable name of the ResourceBundle as configured in faces-config.xml.

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.
Note: The same message arguments are passed to both the summary and the detail message!

Returns:

A message from the ResourceBundle with the corresponding, supplied bundleVarName.
When the supplied bundleKey is not present in the ResourceBundle, a message containing the supplied bundleKey is returned, hence no MissingResourceException is thrown! This event is logged as a Level.WARNING

Throws:

javax.faces.FacesException - When a ResourceBundle with the supplied bundleVarName has been configured but is not resolvable.

NullPointerException - When either the supplied bundleVarName or bundleKey is null.

IllegalArgumentException - When either the supplied bundleVarName or bundleKey is empty or when the message could not be formatted.

getErrorMessage

public static javax.faces.application.FacesMessage getErrorMessage(String bundleVarName,
                                                                   String bundleKey,
                                                                   Object... messageArguments)

Gets an error message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.
The severity of the returned message will be ERROR.

Parameters:

bundleVarName - The variable name of the ResourceBundle as configured in faces-config.xml.

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.
Note: The same message arguments are passed to both the summary and the detail message!

Returns:

An error message from the ResourceBundle with the corresponding, supplied bundleVarName.
When the supplied bundleKey is not present in the ResourceBundle, a message containing the supplied bundleKey is returned, hence no MissingResourceException is thrown! This event is logged as a Level.WARNING

Throws:

javax.faces.FacesException - When a ResourceBundle with the supplied bundleVarName has been configured but is not resolvable.

NullPointerException - When either the supplied bundleVarName or bundleKey is null.

IllegalArgumentException - When either the supplied bundleVarName or bundleKey is empty or when the message could not be formatted.

See Also:

getMessage(String, String, Object...)

getRequiredStringMessage

public static String getRequiredStringMessage(String bundleVarName,
                                              String bundleKey,
                                              Object... messageArguments)

Gets a String message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey which must be present.
When the supplied bundleKey is not present in the ResourceBundle, a message containing the supplied bundleKey is returned, hence no MissingResourceException is thrown! This event is logged as a Level.WARNING

Parameters:

bundleVarName - The variable name of the ResourceBundle as configured in faces-config.xml.

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

A message with the supplied bundleKey or bundleKey itself when not present in the ResourceBundle with the corresponding, supplied bundleVarName.

Throws:

javax.faces.FacesException - When a ResourceBundle with the supplied bundleVarName has been configured but is not resolvable.

NullPointerException - When either the supplied bundleVarName or bundleKey is null.

IllegalArgumentException - When either the supplied bundleVarName or bundleKey is empty or when the message could not be formatted.

getOptionalStringMessage

public static String getOptionalStringMessage(String bundleVarName,
                                              String bundleKey,
                                              String defaultValue,
                                              Object... messageArguments)

Gets an optional String message from the ResourceBundle with the supplied bundleVarName and the supplied bundleKey.

Parameters:

bundleVarName - The variable name of the ResourceBundle as configured in faces-config.xml.

bundleKey - The key to the ResourceBundle.

defaultValue - The value to return when the supplied bundleKey is not present.

messageArguments - The optional message arguments.

Returns:

A message from the ResourceBundle with the corresponding, supplied bundleVarName or the supplied defaultValue when the supplied bundleKey is not present in the ResourceBundle.

Throws:

javax.faces.FacesException - When a ResourceBundle with the supplied bundleVarName has been configured but is not resolvable.

NullPointerException - When either the supplied bundleVarName or bundleKey is null.

IllegalArgumentException - When either the supplied bundleVarName or bundleKey is empty or when the message could not be formatted.

getJosefStringMessage

public static String getJosefStringMessage(String bundleKey,
                                           Object... messageArguments)

Gets a String message from Josef's Resource bundle with the supplied bundleKey.

Parameters:

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

A message from Josef's ResourceBundle.

Throws:

javax.faces.FacesException - When Josef's ResourceBundle has been configured but is not resolvable.

MissingResourceException - When Josef's resource bundle is missing or when the supplied bundleKey does not exist.

NullPointerException - When the supplied bundleKey is null.

IllegalArgumentException - When either the supplied bundleKey is empty or when the message could not be formatted.

getStringMessage

public static String getStringMessage(String bundleVarName,
                                      String bundleKey,
                                      Object... messageArguments)

Gets a String message from the Resource bundle with the supplied bundleVarName and the supplied bundleKey.

Parameters:

bundleVarName - The variable name of the ResourceBundle as configured in faces-config.xml.

bundleKey - The key to the ResourceBundle.

messageArguments - The optional message arguments.

Returns:

A message from the ResourceBundle with the corresponding, supplied bundleVarName.

Throws:

javax.faces.FacesException - When a ResourceBundle with the supplied bundleVarName has been configured but is not resolvable.

MissingResourceException - When either the supplied bundleVarName does not correspond with an existing ResourceBundle or when the supplied bundleKey does not exist.

NullPointerException - When either the supplied bundleVarName or bundleKey is null.

IllegalArgumentException - When either the supplied bundleVarName or bundleKey is empty or when the message could not be formatted.

getMessage

public static javax.faces.application.FacesMessage getMessage(Throwable throwable)

Gets a message from the supplied throwable.
The message summary contains the message of the supplied throwable. When the supplied throwable has a cause then the message detail will contain this message.

Parameters:

throwable - The throwable to get the message from.

Returns:

A message from the supplied throwable.

Throws:

NullPointerException - When the supplied throwable is null.

createErrorMessageFromLocalizedException

public static javax.faces.application.FacesMessage createErrorMessageFromLocalizedException(AbstractLocalizedException localizedException)

Creates a faces error message from the supplied localizedException.
As a summary the localized message from the supplied localizedException is used. Furthermore this method tries to fetch the corresponding detail message and add it to the created FacesMessage.

Parameters:

localizedException - The localized exception to get the message from.

Returns:

A faces error message, created from the supplied localizedException.

Throws:

NullPointerException - When the supplied localizedException is null.

createErrorMessageFromLocalizedRuntimeException

public static javax.faces.application.FacesMessage createErrorMessageFromLocalizedRuntimeException(AbstractLocalizedRuntimeException localizedRuntimeException)

Creates a faces error message from the supplied localizedRuntimeException.
As a summary the localized message from the supplied localizedRuntimeException is used. Furthermore this method tries to fetch the corresponding detail message and add it to the created FacesMessage.

Parameters:

localizedRuntimeException - The localized runtime exception to get the message from.

Returns:

A faces error message, created from the supplied localizedRuntimeException.

Throws:

NullPointerException - When the supplied localizedRuntimeException is null.

getMostSevereMessage

public static javax.faces.application.FacesMessage getMostSevereMessage(Collection<javax.faces.application.FacesMessage> messages)

Gets the most severe message from the supplied collection of messages.
When multiple messages with the same severity exist, the first one is returned.

Parameters:

messages - A possibly null or empty messages collection.

Returns:

The most severe message from the supplied collection of messages or null when the supplied collection of messages does not contain any messages.

hasErrorOccurred

public static boolean hasErrorOccurred()

Determines whether an error has occurred.
An error has occurred when a JSF Message of type FacesMessage.SEVERITY_ERROR or FacesMessage.SEVERITY_FATAL exists.

Returns:

True when an error (or fatal error) has occurred, false otherwise.

createJavaScriptAlert

public static String createJavaScriptAlert(javax.faces.application.FacesMessage message)

Creates JavaScript code to create an alert (dialog box) that contains the supplied message.

Parameters:

message - The message to show as an alert in JavaScript.

Returns:

JavaScript code to create an alert (dialog box) that contains the supplied message.
When the supplied message is null or the contained detail and summary messages are null (or empty), an empty string is returned.

getImageForSeverity

public static String getImageForSeverity(javax.faces.application.FacesMessage.Severity severity)

Gets the image that belongs to a message of the supplied severity.

Parameters:

severity - The severity for which the corresponding image needs to be returned.
When null, the default info image is returned.

Returns:

The image that belongs to a message of the supplied severity.
The returned image can be used as the src attribute of an html img.

getCssClassForSeverity

public static String getCssClassForSeverity(javax.faces.application.FacesMessage.Severity severity)

Gets the css class that corresponds to the supplied severity.

Parameters:

severity - The severity for which the corresponding css class needs to be returned.
When null, a null String is returned.

Returns:

The css class that corresponds to the supplied severity.