org.apache.james.user.api

Interface UsersRepository

All Known Subinterfaces:

JamesUsersRepository

All Known Implementing Classes:

AbstractJamesUsersRepository, AbstractJdbcUsersRepository, AbstractUsersRepository, DefaultUsersJdbcRepository, HBaseUsersRepository, JamesUsersJdbcRepository, JCRUsersRepository, JPAUsersRepository, ReadOnlyUsersLDAPRepository, UsersFileRepository

public interface UsersRepository

Interface for a repository of users. A repository represents a logical grouping of users, typically by common purpose. E.g. the users served by an email server or the members of a mailing list.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUser(String username, String password) Adds a user to the repository with the specified password
boolean	contains(String name) Returns whether or not this user is in the repository
int	countUsers() Returns a count of the users in the repository.
User	getUserByName(String name) Get the user object with the specified user name.
Iterator<String>	list() List users in repository.
void	removeUser(String name) Removes a user from the repository
boolean	supportVirtualHosting() Return true if virtualHosting support is enabled, otherwise false
boolean	test(String name, String password) Test if user with name 'name' has password 'password'.
void	updateUser(User user) Update the repository with the specified user object.

Method Detail

addUser

void addUser(String username,
           String password)
             throws UsersRepositoryException

Adds a user to the repository with the specified password

Parameters:

username - the username of the user to be added

password - the password of the user to add

Throws:

UsersRepositoryException - if error

getUserByName

User getUserByName(String name)
                   throws UsersRepositoryException

Get the user object with the specified user name. Return null if no such user.

Parameters:

name - the name of the user to retrieve

Returns:

the user being retrieved, null if the user doesn't exist

Throws:

UsersRepositoryException - if error

updateUser

void updateUser(User user)
                throws UsersRepositoryException

Update the repository with the specified user object. A user object with this username must already exist.

Throws:

UsersRepositoryException - if error

removeUser

void removeUser(String name)
                throws UsersRepositoryException

Removes a user from the repository

Parameters:

name - the user to remove from the repository

Throws:

UsersRepositoryException - if error

contains

boolean contains(String name)
                 throws UsersRepositoryException

Returns whether or not this user is in the repository

Parameters:

name - the name to check in the repository

Returns:

whether the user is in the repository

Throws:

UsersRepositoryException - if error

test

boolean test(String name,
           String password)
             throws UsersRepositoryException

Test if user with name 'name' has password 'password'.

Parameters:

name - the name of the user to be tested

password - the password to be tested

Returns:

true if the test is successful, false if the user doesn't exist or if the password is incorrect

Throws:

UsersRepositoryException - if error

countUsers

int countUsers()
               throws UsersRepositoryException

Returns a count of the users in the repository.

Returns:

the number of users in the repository

Throws:

UsersRepositoryException - if error

list

Iterator<String> list()
                      throws UsersRepositoryException

List users in repository.

Returns:

Iterator over a collection of Strings, each being one user in the repository.

Throws:

UsersRepositoryException - if error

supportVirtualHosting

boolean supportVirtualHosting()
                              throws UsersRepositoryException

Return true if virtualHosting support is enabled, otherwise false

Returns:

true or false

Throws:

UsersRepositoryException