com.helger.photon.basic.security.login

Class LoggedInUserManager

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.GlobalSingleton

com.helger.photon.basic.security.login.LoggedInUserManager

All Implemented Interfaces:

com.helger.commons.scopes.IScopeDestructionAware, ICurrentUserIDProvider

@ThreadSafe
public final class LoggedInUserManager
extends com.helger.commons.scopes.singleton.GlobalSingleton
implements ICurrentUserIDProvider

This class manages all logged-in users.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggedInUserManager.SessionUserHolder This class manages the user ID of the current session.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LOGOUT_ALREADY_LOGGED_IN_USER

Constructor Summary

Constructors

Constructor and Description
LoggedInUserManager() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAllLoggedInUserIDs()
Collection<LoginInfo>	getAllLoginInfos()
IUser	getCurrentUser()
String	getCurrentUserID()
static LoggedInUserManager	getInstance()
int	getLoggedInUserCount()
LoginInfo	getLoginInfo(String sUserID) Get the login details of the specified user.
com.helger.commons.callback.CallbackList<IUserLoginCallback>	getUserLoginCallbacks()
com.helger.commons.callback.CallbackList<IUserLogoutCallback>	getUserLogoutCallbacks()
boolean	isCurrentUserAdministrator()
boolean	isLogoutAlreadyLoggedInUser()
boolean	isNoUserLoggedInInCurrentSession()
boolean	isUserLoggedIn(String sUserID) Check if the specified user is logged in or not
boolean	isUserLoggedInInCurrentSession()
ELoginResult	loginUser(IUser aUser, String sPlainTextPassword, Collection<String> aRequiredRoleIDs) Login the passed user and require a set of certain roles, the used needs to have to login here.
ELoginResult	loginUser(String sLoginName, String sPlainTextPassword) Login the passed user without much ado.
ELoginResult	loginUser(String sLoginName, String sPlainTextPassword, Collection<String> aRequiredRoleIDs) Login the passed user and require a set of certain roles, the used needs to have to login here.
com.helger.commons.state.EChange	logoutCurrentUser() Manually log out the current user
com.helger.commons.state.EChange	logoutUser(String sUserID) Manually log out the specified user
void	setLogoutAlreadyLoggedInUser(boolean bLogoutAlreadyLoggedInUser)
String	toString()

Methods inherited from class com.helger.commons.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOGOUT_ALREADY_LOGGED_IN_USER

public static final boolean DEFAULT_LOGOUT_ALREADY_LOGGED_IN_USER

See Also:

Constant Field Values

Constructor Detail

LoggedInUserManager

@Deprecated
@UsedViaReflection
public LoggedInUserManager()

Deprecated.

Method Detail

getInstance

@Nonnull
public static LoggedInUserManager getInstance()

Returns:

The global instance of this class. Never null.

getUserLoginCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public com.helger.commons.callback.CallbackList<IUserLoginCallback> getUserLoginCallbacks()

Returns:

The user login callback list. Never null.

getUserLogoutCallbacks

@Nonnull
@ReturnsMutableObject(reason="design")
public com.helger.commons.callback.CallbackList<IUserLogoutCallback> getUserLogoutCallbacks()

Returns:

The user logout callback list. Never null.

isLogoutAlreadyLoggedInUser

public boolean isLogoutAlreadyLoggedInUser()

Returns:

true if a new login of a user, destroys any previously present session, false if a login should fail, if that user is already logged in.

setLogoutAlreadyLoggedInUser

public void setLogoutAlreadyLoggedInUser(boolean bLogoutAlreadyLoggedInUser)

loginUser

@Nonnull
public ELoginResult loginUser(@Nullable
                             String sLoginName,
                             @Nullable
                             String sPlainTextPassword)

Login the passed user without much ado.

Parameters:

sLoginName - Login name of the user to log-in. May be null.

sPlainTextPassword - Plain text password to use. May be null.

Returns:

Never null login status.

loginUser

@Nonnull
public ELoginResult loginUser(@Nullable
                             String sLoginName,
                             @Nullable
                             String sPlainTextPassword,
                             @Nullable
                             Collection<String> aRequiredRoleIDs)

Login the passed user and require a set of certain roles, the used needs to have to login here.

Parameters:

sLoginName - Login name of the user to log-in. May be null.

sPlainTextPassword - Plain text password to use. May be null.

aRequiredRoleIDs - A set of required role IDs, the user needs to have. May be null.

Returns:

Never null login status.

loginUser

@Nonnull
public ELoginResult loginUser(@Nullable
                             IUser aUser,
                             @Nullable
                             String sPlainTextPassword,
                             @Nullable
                             Collection<String> aRequiredRoleIDs)

Login the passed user and require a set of certain roles, the used needs to have to login here.

Parameters:

aUser - The user to log-in. May be null. When the user is null the login must fail.

sPlainTextPassword - Plain text password to use. May be null.

aRequiredRoleIDs - A set of required role IDs, the user needs to have. May be null.

Returns:

Never null login status.

logoutUser

@Nonnull
public com.helger.commons.state.EChange logoutUser(@Nullable
                                                  String sUserID)

Manually log out the specified user

Parameters:

sUserID - The user ID to log out

Returns:

EChange if something changed

logoutCurrentUser

@Nonnull
public com.helger.commons.state.EChange logoutCurrentUser()

Manually log out the current user

Returns:

EChange if something changed

isUserLoggedIn

public boolean isUserLoggedIn(@Nullable
                     String sUserID)

Check if the specified user is logged in or not

Parameters:

sUserID - The user ID to check. May be null.

Returns:

true if the user is logged in, false otherwise.

getAllLoggedInUserIDs

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllLoggedInUserIDs()

Returns:

A non-null but maybe empty set with all currently logged in user IDs.

getLoginInfo

@Nullable
public LoginInfo getLoginInfo(@Nullable
                              String sUserID)

Get the login details of the specified user.

Parameters:

sUserID - The user ID to check. May be null.

Returns:

null if the passed user is not logged in.

getAllLoginInfos

@Nonnull
@ReturnsMutableCopy
public Collection<LoginInfo> getAllLoginInfos()

Returns:

A non-null but maybe empty collection with the details of all currently logged in users.

getLoggedInUserCount

@Nonnegative
public int getLoggedInUserCount()

Returns:

The number of currently logged in users. Always ≥ 0.

getCurrentUserID

@Nullable
public String getCurrentUserID()

Specified by:

getCurrentUserID in interface ICurrentUserIDProvider

Returns:

The ID of the user logged in this session or null if no user is logged in.

isUserLoggedInInCurrentSession

public boolean isUserLoggedInInCurrentSession()

Returns:

true if a user is currently logged into this session, false otherwise. This is the inverse of isNoUserLoggedInInCurrentSession().

isNoUserLoggedInInCurrentSession

public boolean isNoUserLoggedInInCurrentSession()

Returns:

true if not user is currently logged into this session, false if it is. This is the inverse of isUserLoggedInInCurrentSession().

getCurrentUser

@Nullable
public IUser getCurrentUser()

Returns:

The user currently logged in this session or null if no user is logged in.

isCurrentUserAdministrator

public boolean isCurrentUserAdministrator()

Returns:

true if a user is logged in and is administrator

toString

public String toString()

Overrides:

toString in class com.helger.commons.scopes.AbstractSingleton