com.cafesoft.cams.auth.login.userrepository
Interface UserRepository

All Superinterfaces:

Debuggable, LoggerClient

public interface UserRepository

extends LoggerClient, Debuggable

An interface that describes an object that stores a collection of RepositoryUsers. The RepositoryUser object contains information such as name, password, and roles of users. This information is later used to authorize users for access to protected resources.

Since:

11/28/01

Method Summary

void	addUser(RepositoryUser user) Adds the specified RepositoryUser to this UserRepository.
RepositoryUser	getUser(String name) Returns a RepositoryUser from the UserRepository.
boolean	isModified() Determines if the UserRepository datasource has been modified.
void	removeUser(RepositoryUser user) Removes the specified RepositoryUser from this UserRepository.

Methods inherited from interface com.cafesoft.core.log.LoggerClient

setLogger

Methods inherited from interface com.cafesoft.core.util.Debuggable

setDebug

Method Detail

addUser

public void addUser(RepositoryUser user)
             throws UserRepositoryException

Adds the specified RepositoryUser to this UserRepository.

Parameters:

user - the RepositoryUser to add

Throws:

UserRepositoryException - thrown if the RepositoryUser already exists in the UserRepository

removeUser

public void removeUser(RepositoryUser user)
                throws UserRepositoryException

Removes the specified RepositoryUser from this UserRepository.

Parameters:

user - the RepositoryUser to remove

Throws:

UserRepositoryException - thrown if the RepositoryUser does not exist in the UserRepository

getUser

public RepositoryUser getUser(String name)
                       throws UserRepositoryException

Returns a RepositoryUser from the UserRepository.

Parameters:

name - the name of the user in the UserRepository

Returns:

a RepositoryUser corresponding to the name provided

Throws:

UserRepositoryException - thrown if the RepositoryUser does not exist in the UserRepository

isModified

public boolean isModified()

Determines if the UserRepository datasource has been modified.

Returns:

true if the repository has been modified, false otherwise.