org.josef.web.jsf.bean

Class UserSettingsBean

java.lang.Object

org.josef.web.jsf.bean.UserSettingsBean

All Implemented Interfaces:

Serializable

public class UserSettingsBean
extends Object
implements Serializable

Java Server Faces User Settings class.
Note: This class is deliberately not annotated with @ManagedBean so others can use a subclass of this class, annotate it and use userSettingsBean as the name of the managed bean. If it had been annotated here, a subclass would have have to use a different managed bean name.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserSettingsBean() Public constructor to make this a bean.

Method Summary

Modifier and Type	Method and Description
String	getDefaultDatePattern() Gets the default date pattern for the current locale.
String	getDefaultDateTimePattern() Gets the default date/time pattern for the current locale.
String	getDefaultMonthYearPattern() Gets the default month/year pattern for the current locale.
String	getDefaultShortDatePattern() Gets the default short date pattern for the current locale.
String	getDefaultShortDateTimePattern() Gets the default short date/time pattern for the current locale.
String	getLanguage() Gets the current language.
Locale	getLocale() Gets the current locale.
boolean	getLoggedIn() Determines whether the current user is logged in or not.
String	getStyleSheet() Gets the current style sheet.
TimeZone	getTimeZone() Gets the current time zone.
String	getTimeZoneAsString() Gets the current time zone as a String.
String	getUserName() Gets the name of the currently logged in user.
boolean	isDebugMode() Gets the debug mode.
String	logout() Executes a logout by invalidating the session, provided the user is logged in.
void	setDebugMode(boolean debugMode) Sets the debug mode on or off.
void	setLocale(Locale locale) Sets the locale.
void	setStyleSheet(String styleSheet) Sets the style sheet.
void	setTimeZone(TimeZone timeZone) Sets the time zone.
void	timeZoneListener(javax.faces.event.ComponentSystemEvent event) Checks whether the CCookie.TIMEZONE cookie exists and if it does, sets the time zone for the current user.
void	updateLocale(javax.faces.event.ValueChangeEvent event) Updates the locale.
void	updateStyleSheet(javax.faces.event.ValueChangeEvent event) Updates the style sheet.
void	updateTimeZone(javax.faces.event.ValueChangeEvent event) Called when the time zone has been changed by the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSettingsBean

public UserSettingsBean()

Public constructor to make this a bean.

Method Detail

getLocale

public Locale getLocale()

Gets the current locale.
Upon the first call, the locale will be fetched from a cookie. When the cookie does not exist, the locale from the current view is used.

Returns:

The current locale.

setLocale

public void setLocale(Locale locale)

Sets the locale.

Parameters:

locale - The locale.
May be null to reset the locale.

Throws:

IllegalArgumentException - When the supplied locale is not one of the supported locales.

updateLocale

public void updateLocale(javax.faces.event.ValueChangeEvent event)

Updates the locale.
The updated locale is stored here, in a cookie and in the current view.

Parameters:

event - The value change event.

getStyleSheet

public String getStyleSheet()

Gets the current style sheet.
Upon the first call, the style sheet will be fetched from a cookie. When the cookie does not exist, the first style sheet from the list of supported style sheets will be returned.

Returns:

The current style sheet or the first style sheet from the list of supported style sheets.
When no style sheets have been configured "/resources/css/stylesheet.css" is returned and a message of type Level.SEVERE is logged.

See Also:

ApplicationSettingsBean.getSupportedLocales()

setStyleSheet

public void setStyleSheet(String styleSheet)

Sets the style sheet.
The style sheet should be a supported style sheet but this is not checked here.

Parameters:

styleSheet - The style sheet.

updateStyleSheet

public void updateStyleSheet(javax.faces.event.ValueChangeEvent event)

Updates the style sheet.
The updated style sheet is stored here and in a cookie.

Parameters:

event - The value change event.

getTimeZone

public TimeZone getTimeZone()

Gets the current time zone.

Returns:

The current time zone.

setTimeZone

public void setTimeZone(TimeZone timeZone)

Sets the time zone.
When null is supplied, the default time zone (of the system) is used.

Parameters:

timeZone - The time zone.

getTimeZoneAsString

public String getTimeZoneAsString()

Gets the current time zone as a String.

Returns:

The current time zone as a String.

timeZoneListener

public void timeZoneListener(javax.faces.event.ComponentSystemEvent event)

Checks whether the CCookie.TIMEZONE cookie exists and if it does, sets the time zone for the current user.

Parameters:

event - The event.

updateTimeZone

public void updateTimeZone(javax.faces.event.ValueChangeEvent event)

Called when the time zone has been changed by the user.

Parameters:

event - The ValueChangeEvent.

isDebugMode

public boolean isDebugMode()

Gets the debug mode.

Returns:

True when in debug mode, otherwise false is returned.

setDebugMode

public void setDebugMode(boolean debugMode)

Sets the debug mode on or off.

Parameters:

debugMode - True to turn debug mode on, false to turn it off.

getUserName

public String getUserName()

Gets the name of the currently logged in user.

Returns:

The name of the currently logged in user or null when the user is not logged in.

getLoggedIn

public boolean getLoggedIn()

Determines whether the current user is logged in or not.

Returns:

True when the current user is logged in, otherwise false.

logout

public String logout()

Executes a logout by invalidating the session, provided the user is logged in.

Returns:

"logout" when the user was previously logged in, otherwise null is returned.

getLanguage

public String getLanguage()

Gets the current language.

Returns:

The current language in ISO 639 format.

getDefaultDatePattern

public String getDefaultDatePattern()

Gets the default date pattern for the current locale.

Returns:

The default date pattern for the current locale.

Throws:

MissingResourceException - When the key FormatterFactory.KEY_DATE_PATTERN_UNLOCALIZED, could not be found in Formatter.properties.

getDefaultShortDatePattern

public String getDefaultShortDatePattern()

Gets the default short date pattern for the current locale.

Returns:

The default short date pattern for the current locale.

Throws:

MissingResourceException - When the key FormatterFactory.KEY_SHORT_DATE_PATTERN, could not be found in Formatter.properties.

getDefaultDateTimePattern

public String getDefaultDateTimePattern()

Gets the default date/time pattern for the current locale.

Returns:

The default date/time pattern for the current locale.

Throws:

MissingResourceException - When the key FormatterFactory.KEY_DATE_TIME_PATTERN, could not be found in Formatter.properties.

getDefaultShortDateTimePattern

public String getDefaultShortDateTimePattern()

Gets the default short date/time pattern for the current locale.

Returns:

The default short date/time pattern for the current locale.

Throws:

MissingResourceException - When the key FormatterFactory.KEY_SHORT_DATE_TIME_PATTERN, could not be found in Formatter.properties.

getDefaultMonthYearPattern

public String getDefaultMonthYearPattern()

Gets the default month/year pattern for the current locale.

Returns:

The default year/month pattern for the current locale.

Throws:

MissingResourceException - When the key FormatterFactory.KEY_MONTH_YEAR_PATTERN_UNLOCALIZED, could not be found in Formatter.properties.