com.helger.photon.basic.security.user

Interface IUserManager

All Known Subinterfaces:

IAccessManager

All Known Implementing Classes:

AccessManager, UserManager

public interface IUserManager

Interface for a user manager

Author:

Philip Helger

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.
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.
Collection<? extends IUser>	getAllActiveUsers()
Collection<? extends IUser>	getAllDeletedUsers()
Collection<? extends IUser>	getAllDisabledUsers()
Collection<? extends IUser>	getAllNotDeletedUsers()
Collection<? extends IUser>	getAllUsers()
com.helger.commons.callback.CallbackList<IUserModificationCallback>	getUserModificationCallbacks()
IUser	getUserOfEmailAddress(String sEmailAddress) Get the user with the specified email address
IUser	getUserOfID(String sUserID) Get the user with the specified ID.
IUser	getUserOfLoginName(String sLoginName) Get the user with the specified login name
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.

Method Detail

getUserModificationCallbacks

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

Returns:

The user callback list. Never null.

createNewUser

@Nullable
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)

Create a new user.

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

Create a predefined user.

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.

setUserData

@Nonnull
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)

Change the modifiable data of a user

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
com.helger.commons.state.EChange setUserPassword(@Nullable
                                                       String sUserID,
                                                       @Nonnull
                                                       String sNewPlainTextPassword)

Change the modifiable data of a user

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

deleteUser

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

Delete the user with the specified ID.

Parameters:

sUserID - The ID of the user to delete

Returns:

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

undeleteUser

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

Undelete the user with the specified ID.

Parameters:

sUserID - The ID of the user to undelete

Returns:

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

disableUser

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

disable the user with the specified ID.

Parameters:

sUserID - The ID of the user to disable

Returns:

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

enableUser

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

Enable the user with the specified ID.

Parameters:

sUserID - The ID of the user to enable

Returns:

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

areUserIDAndPasswordValid

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

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

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.

containsUserWithID

boolean containsUserWithID(@Nullable
                         String sUserID)

Check if a user with the specified ID is present.

Parameters:

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

Returns:

true if such user exists, false otherwise.

getUserOfID

@Nullable
IUser getUserOfID(@Nullable
                         String sUserID)

Get the user with the specified ID.

Parameters:

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

Returns:

null if no such user exists

getUserOfLoginName

@Nullable
IUser getUserOfLoginName(@Nullable
                                String sLoginName)

Get the user with the specified login name

Parameters:

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

Returns:

null if no such user exists

getUserOfEmailAddress

@Nullable
IUser getUserOfEmailAddress(@Nullable
                                   String sEmailAddress)

Get the user with the specified email address

Parameters:

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

Returns:

null if no such user exists

getAllUsers

@Nonnull
@ReturnsMutableCopy
Collection<? extends IUser> getAllUsers()

Returns:

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

getAllActiveUsers

@Nonnull
@ReturnsMutableCopy
Collection<? extends IUser> getAllActiveUsers()

Returns:

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

getAllDisabledUsers

@Nonnull
@ReturnsMutableCopy
Collection<? extends IUser> getAllDisabledUsers()

Returns:

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

getAllNotDeletedUsers

@Nonnull
@ReturnsMutableCopy
Collection<? extends IUser> getAllNotDeletedUsers()

Returns:

A non-null collection of all contained not deleted users

getAllDeletedUsers

@Nonnull
@ReturnsMutableCopy
Collection<? extends IUser> getAllDeletedUsers()

Returns:

A non-null collection of all contained deleted users