Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: UserDatabase [javadoc | source]

All Known Implementing Classes:
    MemoryUserDatabase

Abstract representation of a database of User s and Group s that can be maintained by an application, along with definitions of corresponding Role s, and referenced by a Realm for authentication and access control.

Method from org.apache.catalina.UserDatabase Summary:
close,   createGroup,   createRole,   createUser,   findGroup,   findRole,   findUser,   getGroups,   getId,   getRoles,   getUsers,   open,   removeGroup,   removeRole,   removeUser,   save
Method from org.apache.catalina.UserDatabase Detail:
 public  void close() throws Exception
    Finalize access to this user database.
 public Group createGroup(String groupname,
    String description)
    Create and return a new Group defined in this user database.
 public Role createRole(String rolename,
    String description)
    Create and return a new Role defined in this user database.
 public User createUser(String username,
    String password,
    String fullName)
    Create and return a new User defined in this user database.
 public Group findGroup(String groupname)
    Return the Group with the specified group name, if any; otherwise return null.
 public Role findRole(String rolename)
    Return the Role with the specified role name, if any; otherwise return null.
 public User findUser(String username)
    Return the User with the specified user name, if any; otherwise return null.
 public Iterator getGroups()
    Return the set of Group s defined in this user database.
 public String getId()
    Return the unique global identifier of this user database.
 public Iterator getRoles()
    Return the set of Role s defined in this user database.
 public Iterator getUsers()
    Return the set of User s defined in this user database.
 public  void open() throws Exception
    Initialize access to this user database.
 public  void removeGroup(Group group)
    Remove the specified Group from this user database.
 public  void removeRole(Role role)
    Remove the specified Role from this user database.
 public  void removeUser(User user)
    Remove the specified User from this user database.
 public  void save() throws Exception
    Save any updated information to the persistent storage location for this user database.