org.apache.catalina
public interface UserDatabase
Abstract representation of a database of Users and Groups that can be maintained by an application, along with definitions of corresponding Roles, and referenced by a Realm for authentication and access control.
Since: 4.1
Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Method Summary | |
---|---|
void | close()
Finalize access to this user database.
|
Group | createGroup(String groupname, String description)
Create and return a new Group defined in this user database.
|
Role | createRole(String rolename, String description)
Create and return a new Role defined in this user database.
|
User | createUser(String username, String password, String fullName)
Create and return a new User defined in this user database.
|
Group | findGroup(String groupname)
Return the Group with the specified group name, if any;
otherwise return null .
|
Role | findRole(String rolename)
Return the Role with the specified role name, if any;
otherwise return null .
|
User | findUser(String username)
Return the User with the specified user name, if any;
otherwise return null .
|
Iterator | getGroups()
Return the set of Groups defined in this user database. |
String | getId()
Return the unique global identifier of this user database. |
Iterator | getRoles()
Return the set of Roles defined in this user database. |
Iterator | getUsers()
Return the set of Users defined in this user database. |
void | open()
Initialize access to this user database.
|
void | removeGroup(Group group)
Remove the specified Group from this user database.
|
void | removeRole(Role role)
Remove the specified Role from this user database.
|
void | removeUser(User user)
Remove the specified User from this user database.
|
void | save()
Save any updated information to the persistent storage location for
this user database.
|
Throws: Exception if any exception is thrown during closing
Parameters: groupname The group name of the new group (must be unique) description The description of this group
Parameters: rolename The role name of the new role (must be unique) description The description of this role
Parameters: username The logon username of the new user (must be unique) password The logon password of the new user fullName The full name of the new user
null
.
Parameters: groupname Name of the group to return
null
.
Parameters: rolename Name of the role to return
null
.
Parameters: username Name of the user to return
Throws: Exception if any exception is thrown during opening
Parameters: group The group to be removed
Parameters: role The role to be removed
Parameters: user The user to be removed
Throws: Exception if any exception is thrown during saving