net.sf.mmm.util.session.base

Class UserSessionProviderDefaultImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.session.api.UserSessionAccess.AbstractUserSessionProvider

net.sf.mmm.util.session.base.UserSessionProviderDefaultImpl

All Implemented Interfaces:

MutableUserSession, UserSession, UserSessionProvider

public class UserSessionProviderDefaultImpl
extends UserSessionAccess.AbstractUserSessionProvider
implements MutableUserSession

This is the default implementation of UserSessionProvider. It simply delegates to according classes provided by the springframework.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
UserSessionProviderDefaultImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
UserSession	getCurrentSession() Gets the current UserSession according to the current environment and client or server context.
Locale	getLocale()
String	getLogin()
org.springframework.security.core.Authentication	getUser()
boolean	isFallback() This method determines if this UserSession was received or is currently called outside the scope of a current user session.
void	setLocale(Locale locale)
void	setUser(Principal user) Sets the current user.

Methods inherited from class net.sf.mmm.util.session.api.UserSessionAccess.AbstractUserSessionProvider

doInitialized

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSessionProviderDefaultImpl

public UserSessionProviderDefaultImpl()

The constructor.

Method Detail

getCurrentSession

public UserSession getCurrentSession()

Description copied from interface: UserSessionProvider

Gets the current UserSession according to the current environment and client or server context.

Specified by:

getCurrentSession in interface UserSessionProvider

Returns:

the current UserSession.

getUser

public org.springframework.security.core.Authentication getUser()

Specified by:

getUser in interface UserSession

Returns:

the current user logged in or null as fallback.

setUser

public void setUser(Principal user)

Description copied from interface: MutableUserSession

Sets the current user.
ATTENTION:
This method is not intended for end-users to avoid getting used to strange design. This is just a back-door required for specific limited (client) environments where the user has to be set explicitly. Typically you will just use a security solution such as spring-security and UserSession will give you abstracted access on it throughout the application. Setting the user after successful login is to be done in a single place of the application and should directly happen via the underlying technology.

Specified by:

setUser in interface MutableUserSession

Parameters:

user - is the new value of UserSession.getUser()

getLogin

public String getLogin()

Specified by:

getLogin in interface UserSession

Returns:

the login of the current user or null as fallback.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface UserSession

Returns:

the Locale of the current user, or the system default locale as fallback.

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface MutableUserSession

Parameters:

locale - is the new value of UserSession.getLocale().

isFallback

public boolean isFallback()

Description copied from interface: UserSession

This method determines if this UserSession was received or is currently called outside the scope of a current user session. On the server side a UserSession typically exists in the context of a servlet container or JEE application server. If the context is not available this method will return true. This may be because the user is currently not logged in (anonymous access) or the context is not available for technical reasons (e.g. misconfiguration).

Specified by:

isFallback in interface UserSession

Returns:

true if received or called outside the scope of a current user session, false otherwise.