org.gatein.wsrp.admin.ui

Class BeanContext

java.lang.Object

org.gatein.wsrp.admin.ui.BeanContext

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JSFBeanContext

public abstract class BeanContext
extends Object
implements Serializable

Provides a context that UI beans can query to retrieve information from the environment in which they run. This helps isolate UI-framework functionality from the core functionality, though, in practice, some of the actual implementation (JSF) leaked through. Also helps with unit testing.

Since:

2.6

Version:

$Revision: 13374 $

Author:

Chris Laprun

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
static String	STATUS

Constructor Summary

Constructors

Constructor and Description
BeanContext()

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> T	checkObject(Object toCheck, Class<T> expectedClass, String errorMessage) Checks whether the specified object is an instance of the specified expected class or throws an IllegalArgumentException with the specified error message.
void	createErrorMessage(String localizedMessageId, Object... params)
void	createErrorMessageFrom(Exception e)
void	createErrorMessageFrom(String target, Exception e) Creates a localized error message targeting the specified object in the context and using the specified error information.
void	createInfoMessage(String localizedMessageId)
protected void	createInfoMessage(String target, String localizedMessageId)
protected void	createLocalizedMessage(String target, String localizedMessageId, Object severity, Object... params) Adds a localized message using the appropriate severity to the identified target in the context.
protected abstract void	createMessage(String target, String message, Object severity, Object... additionalParams) Creates the specified message targeting the specified UI element with the specified severity (semantically left open) with the specified additional parameters.
void	createTargetedErrorMessage(String target, String localizedMessageId, Object... params)
abstract <T> T	findBean(String name, Class<T> type) Finds and retrieves the bean associated with the specified name if it is an instance of the specified type.
protected abstract Object	getErrorSeverity() Lets subclasses specify the object denoting the error severity
abstract <T> T	getFromFlash(String name, Class<T> type)
<T> T	getFromSession(String name, Class<T> expectedClass) Retrieves the session object associated with the specified name and the expected type.
protected abstract Object	getInfoSeverity() Lets subclasses specify the object denoting the information severity
protected abstract Locale	getLocale() Retrieves the current locale for the UI.
static String	getLocalizedMessage(String localizationKey, Locale locale, Object... params)
static String	getLocalizedMessage(String localizationKey, Locale locale, String resourceName, Object... params)
String	getMessageFromBundle(String localizedMessageId, Object... params)
abstract String	getParameter(String key) Retrieves the value of the parameter which name is given from the request.
String	getResourceName()
abstract String	getServerAddress() Retrieves the IP address of the server on which the UI is running.
abstract Map<String,Object>	getSessionMap() Retrieves the session map where "session" is a concept left up to implementations (for JSF, the session corresponds quite logically to the HTTP session)
abstract void	putInFlash(String name, Object value) Puts the given value in a flash scope that survives across a single request to be retrieved later via the specified name.
void	removeFromSession(String name, String... otherNames) Removes the object identified by the specified name(s) from the session.
<T> T	replaceInSession(String name, T newValue) Replaces the session object identified by the given name by the specified new one.
void	setResourceName(String resourceName)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

STATUS

public static final String STATUS

See Also:

Constant Field Values

Constructor Detail

BeanContext

public BeanContext()

Method Detail

setResourceName

public void setResourceName(String resourceName)

getResourceName

public String getResourceName()

getParameter

public abstract String getParameter(String key)

Retrieves the value of the parameter which name is given from the request.

Parameters:

key - name of the parameter which value we want to retrieve

Returns:

createMessage

protected abstract void createMessage(String target,
                 String message,
                 Object severity,
                 Object... additionalParams)

Creates the specified message targeting the specified UI element with the specified severity (semantically left open) with the specified additional parameters.

Parameters:

target - the identifier of the target UI element

message - the message to created

severity - the severity of the message

additionalParams - potentially null additional parameters

getErrorSeverity

protected abstract Object getErrorSeverity()

Lets subclasses specify the object denoting the error severity

Returns:

getInfoSeverity

protected abstract Object getInfoSeverity()

Lets subclasses specify the object denoting the information severity

Returns:

getLocale

protected abstract Locale getLocale()

Retrieves the current locale for the UI.

Returns:

getServerAddress

public abstract String getServerAddress()

Retrieves the IP address of the server on which the UI is running.

Returns:

createErrorMessage

public void createErrorMessage(String localizedMessageId,
                      Object... params)

createTargetedErrorMessage

public void createTargetedErrorMessage(String target,
                              String localizedMessageId,
                              Object... params)

createLocalizedMessage

protected void createLocalizedMessage(String target,
                          String localizedMessageId,
                          Object severity,
                          Object... params)

Adds a localized message using the appropriate severity to the identified target in the context. This method accepts an arbitrary number of arguments to be passed as parameters of localized strings.

Parameters:

target - the target in this context that will receive the new message

localizedMessageId - a resource bundle identifier identifying which the localized string to use as a message

severity - an object representing the severity of the message (typically FacesMessage.Severity)

params - additional parameters to be passed to replace tokens in localized strings

getMessageFromBundle

public String getMessageFromBundle(String localizedMessageId,
                          Object... params)

getLocalizedMessage

public static String getLocalizedMessage(String localizationKey,
                         Locale locale,
                         Object... params)

getLocalizedMessage

public static String getLocalizedMessage(String localizationKey,
                         Locale locale,
                         String resourceName,
                         Object... params)

createErrorMessageFrom

public void createErrorMessageFrom(Exception e)

createErrorMessageFrom

public void createErrorMessageFrom(String target,
                          Exception e)

Creates a localized error message targeting the specified object in the context and using the specified error information. This method looks for two specific resource bundle entries to localize the message, UNEXPECTED_ERROR and CAUSE, using the following format for the message: result of getLocalizedMessageOrExceptionName(Throwable) for the exception\n[localized value associated with CAUSEresult of getLocalizedMessageOrExceptionName(Throwable) for the exception's cause if the cause exists]

Parameters:

target - the contextual object target by the message to be created

e - the exception that we want to display as an error message

createInfoMessage

protected void createInfoMessage(String target,
                     String localizedMessageId)

createInfoMessage

public void createInfoMessage(String localizedMessageId)

removeFromSession

public void removeFromSession(String name,
                     String... otherNames)

Removes the object identified by the specified name(s) from the session. For a JSF backed implementation, this will allow for the object/bean (defined as session-scoped in faces-config.xml) to be recreated by JSF when needed.

Parameters:

name - name of the object to be removed

otherNames - additional names of objects to be removed

getSessionMap

public abstract Map<String,Object> getSessionMap()

Retrieves the session map where "session" is a concept left up to implementations (for JSF, the session corresponds quite logically to the HTTP session)

Returns:

the session map

replaceInSession

public <T> T replaceInSession(String name,
                     T newValue)

Replaces the session object identified by the given name by the specified new one. Passing null for the new value will remove the object reference from the session. If an object was previously assigned to this name, then only an object of the same type (as defined by Class.isAssignableFrom(Class)) can be assigned to this name.

Type Parameters:

T - the type of the object to be replaced

Parameters:

name - the name identifying the object to be replaced

newValue - the new value for the object to be replaced or null if the object is to be removed

Returns:

the new value for the object or null if the remove semantics is used

Throws:

IllegalArgumentException - if the new value for the identified object is not compatible with the currently stored value

getFromSession

public <T> T getFromSession(String name,
                   Class<T> expectedClass)

Retrieves the session object associated with the specified name and the expected type.

Type Parameters:

T - type of the object to be retrieved

Parameters:

name - name of the session object to be retrieved

expectedClass - expected class of the object

Returns:

the session object associated with the specified name

Throws:

IllegalArgumentException - if the value associated with the specified name is not null and does not match the specified expected class

checkObject

protected <T> T checkObject(Object toCheck,
                Class<T> expectedClass,
                String errorMessage)

Checks whether the specified object is an instance of the specified expected class or throws an IllegalArgumentException with the specified error message.

Type Parameters:

T - the type of the expected class

Parameters:

toCheck - the object to check

expectedClass - the class we expect the object to be an instance of

errorMessage - the error message if the object is not an instance of the expected class

Returns:

the specified object to check cast to the specified class

findBean

public abstract <T> T findBean(String name,
             Class<T> type)

Finds and retrieves the bean associated with the specified name if it is an instance of the specified type.

Type Parameters:

T - the expected type of the bean

Parameters:

name - the name of the bean to retrieve

type - the expected type of the bean

Returns:

the bean if we found it cast to the expected type

putInFlash

public abstract void putInFlash(String name,
              Object value)

Puts the given value in a flash scope that survives across a single request to be retrieved later via the specified name. Using a null value switches to a "remove" semantics where the value (if any) associated with the specified name is removed from the scope.

Parameters:

name - the name with which the value can be later retrieved

value - the value to put in the scope. Using null removes any existing association between the specified name and value in the scope.

getFromFlash

public abstract <T> T getFromFlash(String name,
                 Class<T> type)