org.apache.catalina

Interface UserDatabase

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) $

Author: Craig R. McClanahan

Method Summary
voidclose()
Finalize access to this user database.
GroupcreateGroup(String groupname, String description)
Create and return a new Group defined in this user database.
RolecreateRole(String rolename, String description)
Create and return a new Role defined in this user database.
UsercreateUser(String username, String password, String fullName)
Create and return a new User defined in this user database.
GroupfindGroup(String groupname)
Return the Group with the specified group name, if any; otherwise return null.
RolefindRole(String rolename)
Return the Role with the specified role name, if any; otherwise return null.
UserfindUser(String username)
Return the User with the specified user name, if any; otherwise return null.
IteratorgetGroups()
Return the set of Groups defined in this user database.
StringgetId()
Return the unique global identifier of this user database.
IteratorgetRoles()
Return the set of Roles defined in this user database.
IteratorgetUsers()
Return the set of Users defined in this user database.
voidopen()
Initialize access to this user database.
voidremoveGroup(Group group)
Remove the specified Group from this user database.
voidremoveRole(Role role)
Remove the specified Role from this user database.
voidremoveUser(User user)
Remove the specified User from this user database.
voidsave()
Save any updated information to the persistent storage location for this user database.

Method Detail

close

public void close()
Finalize access to this user database.

Throws: Exception if any exception is thrown during closing

createGroup

public Group createGroup(String groupname, String description)
Create and return a new Group defined in this user database.

Parameters: groupname The group name of the new group (must be unique) description The description of this group

createRole

public Role createRole(String rolename, String description)
Create and return a new Role defined in this user database.

Parameters: rolename The role name of the new role (must be unique) description The description of this role

createUser

public User createUser(String username, String password, String fullName)
Create and return a new User defined in this user database.

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

findGroup

public Group findGroup(String groupname)
Return the Group with the specified group name, if any; otherwise return null.

Parameters: groupname Name of the group to return

findRole

public Role findRole(String rolename)
Return the Role with the specified role name, if any; otherwise return null.

Parameters: rolename Name of the role to return

findUser

public User findUser(String username)
Return the User with the specified user name, if any; otherwise return null.

Parameters: username Name of the user to return

getGroups

public Iterator getGroups()
Return the set of Groups defined in this user database.

getId

public String getId()
Return the unique global identifier of this user database.

getRoles

public Iterator getRoles()
Return the set of Roles defined in this user database.

getUsers

public Iterator getUsers()
Return the set of Users defined in this user database.

open

public void open()
Initialize access to this user database.

Throws: Exception if any exception is thrown during opening

removeGroup

public void removeGroup(Group group)
Remove the specified Group from this user database.

Parameters: group The group to be removed

removeRole

public void removeRole(Role role)
Remove the specified Role from this user database.

Parameters: role The role to be removed

removeUser

public void removeUser(User user)
Remove the specified User from this user database.

Parameters: user The user to be removed

save

public void save()
Save any updated information to the persistent storage location for this user database.

Throws: Exception if any exception is thrown during saving

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.