com.communote.server.core.common.session

Class SessionHandler

java.lang.Object

com.communote.server.core.common.session.SessionHandler

public final class SessionHandler
extends Object

The session handler provides access to common used session attributes

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_USER_LOCALE Attribute for the current user locale.

Method Summary

Modifier and Type	Method and Description
void	currentUserLocaleChanged(javax.servlet.http.HttpServletRequest request) Method to be called to notify the session handler that the user changed his profile language.
Locale	getCurrentLocale(javax.servlet.http.HttpServletRequest request) Get the current locale.
static SessionHandler	instance() The one and only instance
void	overrideCurrentUserLocale(javax.servlet.http.HttpServletRequest request, Locale locale) Stores the locale in the session to override the locale of the current user.
boolean	overrideCurrentUserLocaleIfNotOverridden(javax.servlet.http.HttpServletRequest request, Locale locale) Stores the locale in the session to override the locale of the current user.
void	resetOverriddenCurrentUserLocale(javax.servlet.http.HttpServletRequest request) Remove the locale from the session if it was set with a call to overrideCurrentUserLocale(HttpServletRequest, Locale)

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_USER_LOCALE

public static final String CURRENT_USER_LOCALE

Attribute for the current user locale.

See Also:

Constant Field Values

Method Detail

instance

public static SessionHandler instance()

The one and only instance

Returns:

the instance

currentUserLocaleChanged

public void currentUserLocaleChanged(javax.servlet.http.HttpServletRequest request)

Method to be called to notify the session handler that the user changed his profile language.

Parameters:

request - the current request

getCurrentLocale

public Locale getCurrentLocale(javax.servlet.http.HttpServletRequest request)

Get the current locale. If the locale has been overridden in the current session this locale will be returned. Otherwise the locale of the authenticated user is returned. In case there is no authenticated user the locale of the current request is returned. If this locale isn't set either, the configured locale of the current client is returned. In case the application is not yet initialized this method falls back to English.

Parameters:

request - the current request to use

Returns:

a locale, never null

overrideCurrentUserLocale

public void overrideCurrentUserLocale(javax.servlet.http.HttpServletRequest request,
                                      Locale locale)

Stores the locale in the session to override the locale of the current user. If the current user has the same locale this call is ignored.

Parameters:

request - the current request

locale - the locale to set, if null resetOverriddenCurrentUserLocale(HttpServletRequest) will be called

overrideCurrentUserLocaleIfNotOverridden

public boolean overrideCurrentUserLocaleIfNotOverridden(javax.servlet.http.HttpServletRequest request,
                                                        Locale locale)

Stores the locale in the session to override the locale of the current user. If the current user has the same locale, the provided locale is null or locale has already been overridden this call is ignored and false is returned.

Parameters:

request - the current request

locale - the locale to set

Returns:

whether the locale was set

resetOverriddenCurrentUserLocale

public void resetOverriddenCurrentUserLocale(javax.servlet.http.HttpServletRequest request)

Remove the locale from the session if it was set with a call to overrideCurrentUserLocale(HttpServletRequest, Locale)

Parameters:

request - The current request