Interface UserManager

All Superinterfaces:
Serializable
All Known Subinterfaces:
TurbineUserManager
All Known Implementing Classes:
AbstractUserManager

public interface UserManager
extends Serializable
An UserManager performs User objects related tasks on behalf of the BaseSecurityService. The responsibilities of this class include loading data of an user from the storage and putting them into the User objects, saving those data to the permanent storage, and authenticating users.
Version:
$Id: UserManager.java 1884710 2020-12-22 16:16:40Z gk $
Author:
Eric Pugh, Rafal Krzewski
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static String ROLE
    Avalon role - used to id the component within the manager
  • Method Summary

    Modifier and Type Method Description
    <T extends User>
    T
    addUser​(T user, String password)
    Creates new user account with specified attributes.
    void authenticate​(User user, String password)
    Authenticate an User with the specified password.
    void changePassword​(User user, String oldPassword, String newPassword)
    Change the password for an User.
    boolean checkExists​(String userName)
    Check whether a specified user's account exists.
    boolean checkExists​(User user)
    Determines if the User exists in the security system.
    void forcePassword​(User user, String password)
    Forcibly sets new password for an User.
    <T extends AccessControlList>
    T
    getACL​(User user)
    Return a Class object representing the system's chosen implementation of of ACL interface.
    <T extends User>
    UserSet<T>
    getAllUsers()
    Retrieves all users defined in the system.
    <T extends User>
    T
    getUser​(String username)
    Retrieve a user from persistent storage using username as the key.
    <T extends User>
    T
    getUser​(String username, String password)
    Retrieve a user from persistent storage using username as the key, and authenticate the user.
    <T extends User>
    T
    getUserById​(Object id)
    Retrieve a user from persistent storage using the id as the key.
    <T extends User>
    T
    getUserInstance()
    Construct a blank User object.
    <T extends User>
    T
    getUserInstance​(String userName)
    Construct a blank User object.
    void removeUser​(User user)
    Removes an user account from the system.
    void saveUser​(User user)
    Saves User's data in the permanent storage.