org.gatein.wsrp.admin.ui

Class JSFBeanContext

java.lang.Object

org.gatein.wsrp.admin.ui.BeanContext

org.gatein.wsrp.admin.ui.JSFBeanContext

All Implemented Interfaces:

Serializable

public class JSFBeanContext
extends BeanContext
implements Serializable

Provides a JSF-backed BeanContext implementation. This is the main implementation since the UI is currently based on JSF.

Since:

2.6

Version:

$Revision: 13413 $

Author:

Chris Laprun

See Also:

Serialized Form

Field Summary

Fields inherited from class org.gatein.wsrp.admin.ui.BeanContext

log, STATUS

Constructor Summary

Constructors

Constructor and Description
JSFBeanContext()

Method Summary

Methods

Modifier and Type	Method and Description
protected 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.
<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 Object	getErrorSeverity() Lets subclasses specify the object denoting the error severity
<T> T	getFromFlash(String name, Class<T> type)
protected Object	getInfoSeverity() Lets subclasses specify the object denoting the information severity
protected Locale	getLocale() Retrieves the current locale for the UI.
String	getParameter(String key) Retrieves the value of the parameter which name is given from the request.
static String	getParameter(String key, javax.faces.context.FacesContext facesContext)
static Locale	getRequestLocale()
String	getServerAddress() Retrieves the IP address of the server on which the UI is running.
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)
static Map<String,Object>	getSessionMap(javax.faces.context.FacesContext facesContext)
static void	outputLocalizedMessage(String target, String localizationKey, Object severity, String resourceName, Object... params)
static void	outputMessage(String target, String message, Object severity, Object... additionalParams)
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.

Methods inherited from class org.gatein.wsrp.admin.ui.BeanContext

checkObject, createErrorMessage, createErrorMessageFrom, createErrorMessageFrom, createInfoMessage, createInfoMessage, createLocalizedMessage, createTargetedErrorMessage, getFromSession, getLocalizedMessage, getLocalizedMessage, getMessageFromBundle, getResourceName, removeFromSession, replaceInSession, setResourceName

Methods inherited from class java.lang.Object

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

Constructor Detail

JSFBeanContext

public JSFBeanContext()

Method Detail

getParameter

public String getParameter(String key)

Description copied from class: BeanContext

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

Specified by:

getParameter in class BeanContext

Parameters:

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

Returns:

getParameter

public static String getParameter(String key,
                  javax.faces.context.FacesContext facesContext)

getSessionMap

public Map<String,Object> getSessionMap()

Description copied from class: BeanContext

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

Specified by:

getSessionMap in class BeanContext

Returns:

the session map

findBean

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

Description copied from class: BeanContext

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

Specified by:

findBean in class BeanContext

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 void putInFlash(String name,
              Object value)

Description copied from class: BeanContext

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.

Specified by:

putInFlash in class BeanContext

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 <T> T getFromFlash(String name,
                 Class<T> type)

Specified by:

getFromFlash in class BeanContext

getSessionMap

public static Map<String,Object> getSessionMap(javax.faces.context.FacesContext facesContext)

createMessage

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

Description copied from class: BeanContext

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

Specified by:

createMessage in class BeanContext

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

outputMessage

public static void outputMessage(String target,
                 String message,
                 Object severity,
                 Object... additionalParams)

outputLocalizedMessage

public static void outputLocalizedMessage(String target,
                          String localizationKey,
                          Object severity,
                          String resourceName,
                          Object... params)

getErrorSeverity

protected Object getErrorSeverity()

Description copied from class: BeanContext

Lets subclasses specify the object denoting the error severity

Specified by:

getErrorSeverity in class BeanContext

Returns:

getInfoSeverity

protected Object getInfoSeverity()

Description copied from class: BeanContext

Lets subclasses specify the object denoting the information severity

Specified by:

getInfoSeverity in class BeanContext

Returns:

getLocale

protected Locale getLocale()

Description copied from class: BeanContext

Retrieves the current locale for the UI.

Specified by:

getLocale in class BeanContext

Returns:

getServerAddress

public String getServerAddress()

Description copied from class: BeanContext

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

Specified by:

getServerAddress in class BeanContext

Returns:

getRequestLocale

public static Locale getRequestLocale()