net.sf.mmm.util.session.api

Interface UserSession

All Known Subinterfaces:

MutableUserSession

All Known Implementing Classes:

UserSessionProviderDefaultImpl

public interface UserSession

This is the interface for a simple user session.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
Locale	getLocale()
String	getLogin()
Principal	getUser()
boolean	isFallback() This method determines if this UserSession was received or is currently called outside the scope of a current user session.

Method Detail

getUser

Principal getUser()

Returns:

the current user logged in or null as fallback.

getLogin

String getLogin()

Returns:

the login of the current user or null as fallback.

getLocale

Locale getLocale()

Returns:

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

isFallback

boolean isFallback()

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).

Returns:

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