| java.lang.Object
 org.apache.turbine.services.security.db.DBUserManager
| Method Summary | |
| public boolean | accountExists(User user)
Check whether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
user - The user to be checked. | | public boolean | accountExists(String userName)
Check whether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
userName - The name of the user to be checked. | | public void | authenticate(User user, String password)
Authenticate an User with the specified password. | | public void | changePassword(User user, String oldPassword, String newPassword)
Change the password for an User. | | public void | createAccount(User user, String initialPassword)
Creates new user account with specified attributes. | | public void | forcePassword(User user, String password)
Forcibly sets new password for an User.
This is supposed by the administrator to change the forgotten or
compromised passwords. | | public void | init(Configuration conf)
| | public void | removeAccount(User user)
Removes an user account from the system. | | public User | retrieve(String userName)
Retrieve a user from persistent storage using username as the
key.
Parameters:
userName - the name of the user. | | public User[] | retrieve(Criteria criteria)
Retrieve a set of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. | | public User | retrieve(String userName, String password)
Retrieve a user from persistent storage using username as the
key, and authenticate the user. | | public User | retrieveById(Object key)
| | public List | retrieveList(Criteria criteria)
Retrieve a list of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. | | public void | saveOnSessionUnbind(User user)
Saves User data when the session is unbound. | | public void | store(User user)
Save an User object to persistent storage. |
| accountExists | | public boolean accountExists(User user) throws DataBackendException(Code) | | Check whether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
user - The user to be checked. true if the specified account exists
throws:
DataBackendException - if there was an error accessingthe data backend. |
| accountExists | | public boolean accountExists(String userName) throws DataBackendException(Code) | | Check whether a specified user's account exists.
The login name is used for looking up the account.
Parameters:
userName - The name of the user to be checked. true if the specified account exists
throws:
DataBackendException - if there was an error accessingthe data backend. |
| forcePassword | | public void forcePassword(User user, String password) throws UnknownEntityException, DataBackendException(Code) | | Forcibly sets new password for an User.
This is supposed by the administrator to change the forgotten or
compromised passwords. Certain implementatations of this feature
would require administrative level access to the authenticating
server / program.
Parameters:
user - an User to change password for.
Parameters:
password - the new password.
exception:
UnknownEntityException - if the user's record does notexist in the database.
exception:
DataBackendException - if there is a problem accessing thestorage. |
| init | | public void init(Configuration conf)(Code) | | Initializes the UserManager
Parameters:
conf - A Configuration object to init this Manager |
| retrieve | | public User[] retrieve(Criteria criteria) throws DataBackendException(Code) | | Retrieve a set of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. Use verbatim names of the attributes -
without table name prefix in case of DB implementation.
Parameters:
criteria - The criteria of selection. a List of users meeting the criteria.
throws:
DataBackendException - if there is a problem accessing thestorage. |
| retrieveList | | public List retrieveList(Criteria criteria) throws DataBackendException(Code) | | Retrieve a list of users that meet the specified criteria.
As the keys for the criteria, you should use the constants that
are defined in
User interface, plus the names
of the custom attributes you added to your user representation
in the data storage. Use verbatim names of the attributes -
without table name prefix in case of Torque implementation.
Parameters:
criteria - The criteria of selection. a List of users meeting the criteria.
throws:
DataBackendException - if there is a problem accessing thestorage. |
| saveOnSessionUnbind | | public void saveOnSessionUnbind(User user) throws UnknownEntityException, DataBackendException(Code) | | Saves User data when the session is unbound. The user account is required
to exist in the storage.
LastLogin, AccessCounter, persistent pull tools, and any data stored
in the permData hashtable that is not mapped to a column will be saved.
exception:
UnknownEntityException - if the user's account does notexist in the database.
exception:
DataBackendException - if there is a problem accessing thestorage. |
|
|