| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.
| Method Summary | |
|---|---|
|  void | close()Finalize access to this user database. | 
|  Group | createGroup(java.lang.String groupname,
            java.lang.String description)Create and return a new Groupdefined in this user database. | 
|  Role | createRole(java.lang.String rolename,
           java.lang.String description)Create and return a new Roledefined in this user database. | 
|  User | createUser(java.lang.String username,
           java.lang.String password,
           java.lang.String fullName)Create and return a new Userdefined in this user database. | 
|  Group | findGroup(java.lang.String groupname)Return the Groupwith the specified group name, if any;
 otherwise returnnull. | 
|  Role | findRole(java.lang.String rolename)Return the Rolewith the specified role name, if any;
 otherwise returnnull. | 
|  User | findUser(java.lang.String username)Return the Userwith the specified user name, if any;
 otherwise returnnull. | 
|  java.util.Iterator | getGroups()Return the set of Groups defined in this user database. | 
|  java.lang.String | getId()Return the unique global identifier of this user database. | 
|  java.util.Iterator | getRoles()Return the set of Roles defined in this user database. | 
|  java.util.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 Groupfrom this user database. | 
|  void | removeRole(Role role)Remove the specified Rolefrom this user database. | 
|  void | removeUser(User user)Remove the specified Userfrom this user database. | 
|  void | save()Save any updated information to the persistent storage location for this user database. | 
| Method Detail | 
|---|
java.util.Iterator getGroups()
Groups defined in this user database.
java.lang.String getId()
java.util.Iterator getRoles()
Roles defined in this user database.
java.util.Iterator getUsers()
Users defined in this user database.
void close()
           throws java.lang.Exception
java.lang.Exception - if any exception is thrown during closing
Group createGroup(java.lang.String groupname,
                  java.lang.String description)
Group defined in this user database.
groupname - The group name of the new group (must be unique)description - The description of this group
Role createRole(java.lang.String rolename,
                java.lang.String description)
Role defined in this user database.
rolename - The role name of the new role (must be unique)description - The description of this role
User createUser(java.lang.String username,
                java.lang.String password,
                java.lang.String fullName)
User defined in this user database.
username - The logon username of the new user (must be unique)password - The logon password of the new userfullName - The full name of the new userGroup findGroup(java.lang.String groupname)
Group with the specified group name, if any;
 otherwise return null.
groupname - Name of the group to returnRole findRole(java.lang.String rolename)
Role with the specified role name, if any;
 otherwise return null.
rolename - Name of the role to returnUser findUser(java.lang.String username)
User with the specified user name, if any;
 otherwise return null.
username - Name of the user to return
void open()
          throws java.lang.Exception
java.lang.Exception - if any exception is thrown during openingvoid removeGroup(Group group)
Group from this user database.
group - The group to be removedvoid removeRole(Role role)
Role from this user database.
role - The role to be removedvoid removeUser(User user)
User from this user database.
user - The user to be removed
void save()
          throws java.lang.Exception
java.lang.Exception - if any exception is thrown during saving| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||