com.helger.photon.basic.security.user

Class UserManager

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

com.helger.photon.basic.security.user.UserManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IReloadableDAO, IUserManager

@ThreadSafe
public class UserManager
extends AbstractSimpleDAO
implements IUserManager, IReloadableDAO

This class manages the available users.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CREATE_DEFAULTS

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
UserManager(String sFilename)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areUserIDAndPasswordValid(String sUserID, String sPlainTextPassword) Check if the passed combination of user ID and password matches.
boolean	containsUserWithID(String sUserID) Check if a user with the specified ID is present.
IUser	createNewUser(String sLoginName, String sEmailAddress, String sPlainTextPassword, String sFirstName, String sLastName, String sDescription, Locale aDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Create a new user.
IUser	createPredefinedUser(String sID, String sLoginName, String sEmailAddress, String sPlainTextPassword, String sFirstName, String sLastName, String sDescription, Locale aDesiredLocale, Map<String,?> aCustomAttrs, boolean bDisabled) Create a predefined user.
protected com.helger.commons.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
com.helger.commons.state.EChange	deleteUser(String sUserID) Delete the user with the specified ID.
com.helger.commons.state.EChange	disableUser(String sUserID) disable the user with the specified ID.
com.helger.commons.state.EChange	enableUser(String sUserID) Enable the user with the specified ID.
List<User>	getAllActiveUsers()
List<User>	getAllDeletedUsers()
List<User>	getAllDisabledUsers()
List<User>	getAllNotDeletedUsers()
List<User>	getAllUsers()
com.helger.commons.callback.CallbackList<IUserModificationCallback>	getUserModificationCallbacks()
IUser	getUserOfEmailAddress(String sEmailAddress) Get the user with the specified email address
User	getUserOfID(String sUserID) Get the user with the specified ID.
IUser	getUserOfLoginName(String sLoginName) Get the user with the specified login name
static boolean	isCreateDefaults()
protected com.helger.commons.state.EChange	onInit() Custom initialization routine.
protected com.helger.commons.state.EChange	onRead(com.helger.commons.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
void	reload() Call this method to reload the content from the original source.
static void	setCreateDefaults(boolean bCreateDefaults)
com.helger.commons.state.EChange	setUserData(String sUserID, String sNewLoginName, String sNewEmailAddress, String sNewFirstName, String sNewLastName, String sNewDescription, Locale aNewDesiredLocale, Map<String,?> aNewCustomAttrs, boolean bNewDisabled) Change the modifiable data of a user
com.helger.commons.state.EChange	setUserPassword(String sUserID, String sNewPlainTextPassword) Change the modifiable data of a user
com.helger.commons.state.EChange	undeleteUser(String sUserID) Undelete the user with the specified ID.
com.helger.commons.state.EChange	updateUserLastFailedLogin(String sUserID)
com.helger.commons.state.EChange	updateUserLastLogin(String sUserID)

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractSimpleDAO

beforeWriteToFile, getDAOIO, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onFilenameChange, toString, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSave

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.app.dao.IDAO

getInitCount, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getWriteCount, writeToFileOnPendingChanges

Methods inherited from interface com.helger.photon.basic.app.dao.IChangeable

hasPendingChanges

Methods inherited from interface com.helger.photon.basic.app.dao.IAutoSaveAware

beginWithoutAutoSave, endWithoutAutoSave, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave

Field Detail

DEFAULT_CREATE_DEFAULTS

public static final boolean DEFAULT_CREATE_DEFAULTS

See Also:

Constant Field Values

Constructor Detail

UserManager

public UserManager(@Nonnull@Nonempty
           String sFilename)
            throws DAOException

Throws:

DAOException

Method Detail

isCreateDefaults

public static boolean isCreateDefaults()

setCreateDefaults

public static void setCreateDefaults(boolean bCreateDefaults)

reload

public void reload()
            throws DAOException

Description copied from interface: IReloadableDAO

Call this method to reload the content from the original source.

Specified by:

reload in interface IReloadableDAO

Throws:

DAOException - in case reloading fails

onInit

@Nonnull
protected com.helger.commons.state.EChange onInit()

Description copied from class: AbstractSimpleDAO

Custom initialization routine. Called only if the underlying file does not exist yet. This method is only called within a write lock!

Overrides:

onInit in class AbstractSimpleDAO

Returns:

EChange.CHANGED if something was modified inside this method

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                              com.helger.commons.microdom.IMicroDocument aDoc)

Description copied from class: AbstractSimpleDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractSimpleDAO

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

createWriteData

@Nonnull
protected com.helger.commons.microdom.IMicroDocument createWriteData()

Description copied from class: AbstractSimpleDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractSimpleDAO

Returns:

The non-null document to write to the file.

getUserModificationCallbacks

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

Specified by:

getUserModificationCallbacks in interface IUserManager

Returns:

The user callback list. Never null.

createNewUser

@Nullable
public IUser createNewUser(@Nonnull@Nonempty
                           String sLoginName,
                           @Nullable
                           String sEmailAddress,
                           @Nonnull
                           String sPlainTextPassword,
                           @Nullable
                           String sFirstName,
                           @Nullable
                           String sLastName,
                           @Nullable
                           String sDescription,
                           @Nullable
                           Locale aDesiredLocale,
                           @Nullable
                           Map<String,?> aCustomAttrs,
                           boolean bDisabled)

Description copied from interface: IUserManager

Create a new user.

Specified by:

createNewUser in interface IUserManager

Parameters:

sLoginName - Login name of the user. May neither be null nor empty.This login name must be unique over all existing users.

sEmailAddress - The email address. May be null.

sPlainTextPassword - The plain text password to be used. May neither be null nor empty.

sFirstName - The users first name. May be null.

sLastName - The users last name. May be null.

sDescription - Optional description for the user. May be null.

aDesiredLocale - The users default locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Returns:

The created user or null if another user with the same email address is already present.

createPredefinedUser

@Nullable
public IUser createPredefinedUser(@Nonnull@Nonempty
                                  String sID,
                                  @Nonnull@Nonempty
                                  String sLoginName,
                                  @Nullable
                                  String sEmailAddress,
                                  @Nonnull
                                  String sPlainTextPassword,
                                  @Nullable
                                  String sFirstName,
                                  @Nullable
                                  String sLastName,
                                  @Nullable
                                  String sDescription,
                                  @Nullable
                                  Locale aDesiredLocale,
                                  @Nullable
                                  Map<String,?> aCustomAttrs,
                                  boolean bDisabled)

Description copied from interface: IUserManager

Create a predefined user.

Specified by:

createPredefinedUser in interface IUserManager

Parameters:

sID - The ID to use

sLoginName - Login name of the user. May neither be null nor empty. This login name must be unique over all existing users.

sEmailAddress - The email address. May be null.

sPlainTextPassword - The plain text password to be used. May neither be null nor empty.

sFirstName - The users first name. May be null.

sLastName - The users last name. May be null.

sDescription - Optional description for the user. May be null.

aDesiredLocale - The users default locale. May be null.

aCustomAttrs - Custom attributes. May be null.

bDisabled - true if the user is disabled

Returns:

The created user or null if another user with the same email address is already present.

containsUserWithID

public boolean containsUserWithID(@Nullable
                         String sUserID)

Description copied from interface: IUserManager

Check if a user with the specified ID is present.

Specified by:

containsUserWithID in interface IUserManager

Parameters:

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

Returns:

true if such user exists, false otherwise.

getUserOfID

@Nullable
public User getUserOfID(@Nullable
                        String sUserID)

Description copied from interface: IUserManager

Get the user with the specified ID.

Specified by:

getUserOfID in interface IUserManager

Parameters:

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

Returns:

null if no such user exists

getUserOfLoginName

@Nullable
public IUser getUserOfLoginName(@Nullable
                                String sLoginName)

Description copied from interface: IUserManager

Get the user with the specified login name

Specified by:

getUserOfLoginName in interface IUserManager

Parameters:

sLoginName - The login name to be checked. May be null.

Returns:

null if no such user exists

getUserOfEmailAddress

@Nullable
public IUser getUserOfEmailAddress(@Nullable
                                   String sEmailAddress)

Description copied from interface: IUserManager

Get the user with the specified email address

Specified by:

getUserOfEmailAddress in interface IUserManager

Parameters:

sEmailAddress - The email address to be checked. May be null.

Returns:

null if no such user exists

getAllUsers

@Nonnull
@ReturnsMutableCopy
public List<User> getAllUsers()

Specified by:

getAllUsers in interface IUserManager

Returns:

A non-null collection of all contained users (enabled+disabled and deleted+not-deleted)

getAllActiveUsers

@Nonnull
@ReturnsMutableCopy
public List<User> getAllActiveUsers()

Specified by:

getAllActiveUsers in interface IUserManager

Returns:

A non-null collection of all contained enabled and not-deleted users

getAllDisabledUsers

@Nonnull
@ReturnsMutableCopy
public List<User> getAllDisabledUsers()

Specified by:

getAllDisabledUsers in interface IUserManager

Returns:

A non-null collection of all contained disabled and not-deleted users

getAllNotDeletedUsers

@Nonnull
@ReturnsMutableCopy
public List<User> getAllNotDeletedUsers()

Specified by:

getAllNotDeletedUsers in interface IUserManager

Returns:

A non-null collection of all contained not deleted users

getAllDeletedUsers

@Nonnull
@ReturnsMutableCopy
public List<User> getAllDeletedUsers()

Specified by:

getAllDeletedUsers in interface IUserManager

Returns:

A non-null collection of all contained deleted users

setUserData

@Nonnull
public com.helger.commons.state.EChange setUserData(@Nullable
                                                   String sUserID,
                                                   @Nonnull@Nonempty
                                                   String sNewLoginName,
                                                   @Nullable
                                                   String sNewEmailAddress,
                                                   @Nullable
                                                   String sNewFirstName,
                                                   @Nullable
                                                   String sNewLastName,
                                                   @Nullable
                                                   String sNewDescription,
                                                   @Nullable
                                                   Locale aNewDesiredLocale,
                                                   @Nullable
                                                   Map<String,?> aNewCustomAttrs,
                                                   boolean bNewDisabled)

Description copied from interface: IUserManager

Change the modifiable data of a user

Specified by:

setUserData in interface IUserManager

Parameters:

sUserID - The ID of the user to be modified. May be null.

sNewLoginName - The new login name. May not be null.

sNewEmailAddress - The new email address. May be null.

sNewFirstName - The new first name. May be null.

sNewLastName - The new last name. May be null.

sNewDescription - Optional new description for the user. May be null.

aNewDesiredLocale - The new desired locale. May be null.

aNewCustomAttrs - Custom attributes. May be null.

bNewDisabled - true if the user is disabled

Returns:

EChange

setUserPassword

@Nonnull
public com.helger.commons.state.EChange setUserPassword(@Nullable
                                                       String sUserID,
                                                       @Nonnull
                                                       String sNewPlainTextPassword)

Description copied from interface: IUserManager

Change the modifiable data of a user

Specified by:

setUserPassword in interface IUserManager

Parameters:

sUserID - The ID of the user to be modified. May be null.

sNewPlainTextPassword - The new password in plain text. May not be null.

Returns:

EChange

updateUserLastLogin

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

updateUserLastFailedLogin

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

deleteUser

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

Description copied from interface: IUserManager

Delete the user with the specified ID.

Specified by:

deleteUser in interface IUserManager

Parameters:

sUserID - The ID of the user to delete

Returns:

EChange.CHANGED if the user was deleted, EChange.UNCHANGED otherwise.

undeleteUser

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

Description copied from interface: IUserManager

Undelete the user with the specified ID.

Specified by:

undeleteUser in interface IUserManager

Parameters:

sUserID - The ID of the user to undelete

Returns:

EChange.CHANGED if the user was undeleted, EChange.UNCHANGED otherwise.

disableUser

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

Description copied from interface: IUserManager

disable the user with the specified ID.

Specified by:

disableUser in interface IUserManager

Parameters:

sUserID - The ID of the user to disable

Returns:

EChange.CHANGED if the user was disabled, EChange.UNCHANGED otherwise.

enableUser

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

Description copied from interface: IUserManager

Enable the user with the specified ID.

Specified by:

enableUser in interface IUserManager

Parameters:

sUserID - The ID of the user to enable

Returns:

EChange.CHANGED if the user was enabled, EChange.UNCHANGED otherwise.

areUserIDAndPasswordValid

public boolean areUserIDAndPasswordValid(@Nullable
                                String sUserID,
                                @Nullable
                                String sPlainTextPassword)

Description copied from interface: IUserManager

Check if the passed combination of user ID and password matches.

Specified by:

areUserIDAndPasswordValid in interface IUserManager

Parameters:

sUserID - The ID of the user

sPlainTextPassword - The plan text password to validate.

Returns:

true if the password hash matches the stored hash for the specified user, false otherwise.