net.sf.mmm.util.session.api

Interface MutableUserSession

All Superinterfaces:

UserSession

All Known Implementing Classes:

UserSessionProviderDefaultImpl

public interface MutableUserSession
extends UserSession

This interface extends UserSession with write operations to modify the user settings.
ATTENTION:
It is NOT always guaranteed, that UserSessionAccess.getSession() will provide an instance that can be cast to MutableUserSession. Further, only central place(s) in the code should modify the UserSession to ensure consistency.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	setLocale(Locale locale)
void	setUser(Principal user) Sets the current user.

Methods inherited from interface net.sf.mmm.util.session.api.UserSession

getLocale, getLogin, getUser, isFallback

Method Detail

setLocale

void setLocale(Locale locale)

Parameters:

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

setUser

void setUser(Principal user)
      throws UnsupportedOperationException

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.

Parameters:

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

Throws:

UnsupportedOperationException - if not supported.