org.apache.james.user.hbase

Class HBaseUsersRepository

java.lang.Object

org.apache.james.user.lib.AbstractUsersRepository

org.apache.james.user.hbase.HBaseUsersRepository

All Implemented Interfaces:

Configurable, LogEnabled, UsersRepository

public class HBaseUsersRepository
extends AbstractUsersRepository

Implementation of the UserRepository for a HBase persistence.

Constructor Summary

Constructors

Constructor and Description
HBaseUsersRepository()

Method Summary

Methods

Modifier and Type	Method and Description
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.
protected void	doAddUser(String username, String password) Add the user with the given username and password
void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
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	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.

Methods inherited from class org.apache.james.user.lib.AbstractUsersRepository

addUser, configure, getLogger, isValidUsername, setDomainList, setEnableVirtualHosting, setLog, supportVirtualHosting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HBaseUsersRepository

public HBaseUsersRepository()

Method Detail

doConfigure

public void doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
                 throws org.apache.commons.configuration.ConfigurationException

Overrides:

doConfigure in class AbstractUsersRepository

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

AbstractUsersRepository.doConfigure(HierarchicalConfiguration)

getUserByName

public User getUserByName(String name)
                   throws UsersRepositoryException

Description copied from interface: UsersRepository

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

See Also:

UsersRepository.getUserByName(String)

updateUser

public void updateUser(User user)
                throws UsersRepositoryException

Description copied from interface: UsersRepository

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

Throws:

UsersRepositoryException - if error

See Also:

UsersRepository.updateUser(User)

removeUser

public void removeUser(String name)
                throws UsersRepositoryException

Description copied from interface: UsersRepository

Removes a user from the repository

Parameters:

name - the user to remove from the repository

Throws:

UsersRepositoryException - if error

See Also:

UsersRepository.removeUser(String)

contains

public boolean contains(String name)
                 throws UsersRepositoryException

Description copied from interface: UsersRepository

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

See Also:

UsersRepository.contains(String)

test

public boolean test(String name,
           String password)
             throws UsersRepositoryException

Description copied from interface: UsersRepository

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

See Also:

UsersRepository.test(String, String)

countUsers

public int countUsers()
               throws UsersRepositoryException

Description copied from interface: UsersRepository

Returns a count of the users in the repository.

Returns:

the number of users in the repository

Throws:

UsersRepositoryException - if error

See Also:

UsersRepository.countUsers()

list

public Iterator<String> list()
                      throws UsersRepositoryException

Description copied from interface: UsersRepository

List users in repository.

Returns:

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

Throws:

UsersRepositoryException - if error

See Also:

UsersRepository.list()

doAddUser

protected void doAddUser(String username,
             String password)
                  throws UsersRepositoryException

Description copied from class: AbstractUsersRepository

Add the user with the given username and password

Specified by:

doAddUser in class AbstractUsersRepository

Throws:

UsersRepositoryException - If an error occurred

See Also:

AbstractUsersRepository.doAddUser(String, String)