com.communote.server.web.commons

Class MessageHelper

java.lang.Object

com.communote.server.web.commons.MessageHelper

public class MessageHelper
extends Object

The MessageHelper provides functions to access messages resources and to save messages in the request as either error or success messages.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ID_REQUEST_ATTRIBUTE Request attribute name for storing the current client ID.
static String	ERROR_MESSAGES_KEY The request key to be used for error messages.
static String	INFO_MESSAGES_KEY The request key to be used for info messages.
static String	MESSAGES_KEY The request key to be used for messages
static String	MESSAGES_TARGET the request key to be sued for the message target.
static String	WARNING_MESSAGES_KEY The request key to be used for warnings.

Method Summary

Modifier and Type	Method and Description
static String	getText(javax.servlet.http.HttpServletRequest request, LocalizedMessage localizedMessage, Object... arguments) Get the localized value of the LocalizedMessage
static String	getText(javax.servlet.http.HttpServletRequest request, String msgKey) Convenience method for getting a i18n key's value.
static String	getText(javax.servlet.http.HttpServletRequest request, String msgKey, Object[] args) Method for getting a i18n key's value.
static boolean	hasText(javax.servlet.http.HttpServletRequest request, String msgKey, Object[] arguments)
static void	saveErrorMessage(javax.servlet.http.HttpServletRequest request, LocalizedMessage message) Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message
static void	saveErrorMessage(javax.servlet.http.HttpServletRequest request, String message) Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message
static void	saveErrorMessageFromKey(javax.servlet.http.HttpServletRequest request, String messageKey) Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message
static void	saveErrorMessageFromKey(javax.servlet.http.HttpServletRequest request, String messageKey, Object... arguments) Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message
static void	saveMessage(javax.servlet.http.HttpServletRequest request, LocalizedMessage message) Saves a new message in the request under the key MESSAGES_KEY as success message
static void	saveMessage(javax.servlet.http.HttpServletRequest request, String message) Saves a new message in the request under the key MESSAGES_KEY as success message
static void	saveMessage(javax.servlet.http.HttpServletRequest request, String message, String type) Saves a message with the specified key.
static void	saveMessageFromKey(javax.servlet.http.HttpServletRequest request, String messageKey) Saves a new message in the request under the key MESSAGES_KEY as success message
static void	saveMessageFromKey(javax.servlet.http.HttpServletRequest request, String messageKey, String type) Saves a new message in the request under the key MESSAGES_KEY as success message
static void	saveMessageFromKey(javax.servlet.http.HttpServletRequest request, String messageKey, String type, Object... arguments) Saves a new message in the request under the key MESSAGES_KEY as success message
static void	setMessageTarget(javax.servlet.http.HttpServletRequest request, String url) Sets the message view target.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGES_KEY

public static final String MESSAGES_KEY

The request key to be used for messages

See Also:

Constant Field Values

INFO_MESSAGES_KEY

public static final String INFO_MESSAGES_KEY

The request key to be used for info messages.

See Also:

Constant Field Values

ERROR_MESSAGES_KEY

public static final String ERROR_MESSAGES_KEY

The request key to be used for error messages.

See Also:

Constant Field Values

WARNING_MESSAGES_KEY

public static final String WARNING_MESSAGES_KEY

The request key to be used for warnings.

See Also:

Constant Field Values

MESSAGES_TARGET

public static final String MESSAGES_TARGET

the request key to be sued for the message target.

See Also:

Constant Field Values

CLIENT_ID_REQUEST_ATTRIBUTE

public static final String CLIENT_ID_REQUEST_ATTRIBUTE

Request attribute name for storing the current client ID. This attribute should be set if the ThreadLocal that holds the client is not available anymore or cannot be set (e.g. if the client is not active).

See Also:

Constant Field Values

Method Detail

getText

public static String getText(javax.servlet.http.HttpServletRequest request,
                             LocalizedMessage localizedMessage,
                             Object... arguments)

Get the localized value of the LocalizedMessage

Parameters:

request - the request to determine the locale

localizedMessage - the message providing the transaltion

arguments - if provided overrides the arguments the LocalizedMessage was created with

Returns:

the translated message

getText

public static String getText(javax.servlet.http.HttpServletRequest request,
                             String msgKey)

Convenience method for getting a i18n key's value.

Parameters:

request - the request to determine the locale

msgKey - The message key

Returns:

The localized text

getText

public static String getText(javax.servlet.http.HttpServletRequest request,
                             String msgKey,
                             Object[] args)

Method for getting a i18n key's value.

Parameters:

request - the request to determine the locale

msgKey - The message key

args - message arguments

Returns:

The localized text

hasText

public static boolean hasText(javax.servlet.http.HttpServletRequest request,
                              String msgKey,
                              Object[] arguments)

Parameters:

request - The request.

msgKey - The message key.

arguments - Possible arguments.

Returns:

True, if there is such a message key, else false.

saveErrorMessage

public static void saveErrorMessage(javax.servlet.http.HttpServletRequest request,
                                    LocalizedMessage message)

Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message

Parameters:

request - The request to save the messages to

message - the LocalizedMessage containing the translated message

saveErrorMessage

public static void saveErrorMessage(javax.servlet.http.HttpServletRequest request,
                                    String message)

Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message

Parameters:

request - The request to save the messages to

message - the message text to save

saveErrorMessageFromKey

public static void saveErrorMessageFromKey(javax.servlet.http.HttpServletRequest request,
                                           String messageKey)

Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message

Parameters:

request - The request to save the messages to

messageKey - The key of the message.

saveErrorMessageFromKey

public static void saveErrorMessageFromKey(javax.servlet.http.HttpServletRequest request,
                                           String messageKey,
                                           Object... arguments)

Saves a new message in the request under the key ERROR_MESSAGES_KEY as error message

Parameters:

request - The request to save the messages to

messageKey - The key of the message.

arguments - Message arguments.

saveMessage

public static void saveMessage(javax.servlet.http.HttpServletRequest request,
                               LocalizedMessage message)

Saves a new message in the request under the key MESSAGES_KEY as success message

Parameters:

request - The request to save the messages to

message - the message text to save

saveMessage

public static void saveMessage(javax.servlet.http.HttpServletRequest request,
                               String message)

Saves a new message in the request under the key MESSAGES_KEY as success message

Parameters:

request - The request to save the messages to

message - the message text to save

saveMessage

public static void saveMessage(javax.servlet.http.HttpServletRequest request,
                               String message,
                               String type)

Saves a message with the specified key.

Parameters:

request - The request.

message - The message.

type - The message type (Error, Success, ...).

saveMessageFromKey

public static void saveMessageFromKey(javax.servlet.http.HttpServletRequest request,
                                      String messageKey)

Saves a new message in the request under the key MESSAGES_KEY as success message

Parameters:

request - The request to save the messages to

messageKey - The key of the message.

saveMessageFromKey

public static void saveMessageFromKey(javax.servlet.http.HttpServletRequest request,
                                      String messageKey,
                                      String type)

Saves a new message in the request under the key MESSAGES_KEY as success message

Parameters:

request - The request to save the messages to

messageKey - The key of the message.

type - The messages type.

saveMessageFromKey

public static void saveMessageFromKey(javax.servlet.http.HttpServletRequest request,
                                      String messageKey,
                                      String type,
                                      Object... arguments)

Saves a new message in the request under the key MESSAGES_KEY as success message

Parameters:

request - The request to save the messages to

messageKey - The key of the message.

type - The messages type.

arguments - Arguments.

setMessageTarget

public static void setMessageTarget(javax.servlet.http.HttpServletRequest request,
                                    String url)

Sets the message view target.

Parameters:

request - the request

url - the url