org.apache.james.userrepository
Class UsersFileRepository

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLogEnabled
        |
        +--org.apache.james.userrepository.UsersFileRepository

All Implemented Interfaces:

Component, Composable, Configurable, Initializable, LogEnabled, UsersRepository

public class UsersFileRepository

extends AbstractLogEnabled

implements UsersRepository, Component, Configurable, Composable, Initializable

Implementation of a Repository to store users on the File System. Requires a configuration element in the .conf.xml file of the form: Requires a logger called UsersRepository.

Version:

CVS $Revision: 1.9 $

Author:

Federico Barbieri , Charles Benett

Field Summary

protected static boolean

DEEP_DEBUG Whether 'deep debugging' is turned on.

Fields inherited from interface org.apache.james.services.UsersRepository

ROLE, USER

Constructor Summary

UsersFileRepository()

Method Summary

void	addUser(String name, Object attributes) Adds a user to the repository with the specified attributes.
boolean	addUser(User user) Update the repository with the specified user object.
void	compose(ComponentManager componentManager)
void	configure(Configuration configuration)
boolean	contains(String name) Returns whether or not this user is in the repository
boolean	containsCaseInsensitive(String name) Returns whether or not this user is in the repository.
int	countUsers() Returns a count of the users in the repository.
Object	getAttributes(String name) Gets the attribute for a user.
String	getRealName(String name) Returns the user name of the user matching name on an equalsIgnoreCase basis.
User	getUserByName(String name) Get the user object with the specified user name.
User	getUserByNameCaseInsensitive(String name) Get the user object with the specified user name.
void	initialize()
Iterator	list() List users in repository.
void	removeUser(String name) Removes a user from the repository
boolean	test(String name, Object attributes) Tests a user with the appropriate attributes.
boolean	test(String name, String password) Test if user with name 'name' has password 'password'.
boolean	updateUser(User user) Update the repository with the specified user object.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

DEEP_DEBUG

protected static boolean DEEP_DEBUG

Whether 'deep debugging' is turned on.

Constructor Detail

UsersFileRepository

public UsersFileRepository()

Method Detail

compose

public void compose(ComponentManager componentManager)
             throws ComponentException

Specified by:

compose in interface Composable

ComponentException

See Also:

Composable.compose(ComponentManager)

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

ConfigurationException

See Also:

Configurable.configure(Configuration)

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Exception

See Also:

Initializable.initialize()

list

public Iterator list()

List users in repository.

Specified by:

list in interface UsersRepository

Returns:

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

addUser

public boolean addUser(User user)

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

Specified by:

addUser in interface UsersRepository

Parameters:

user - the user to be added.

Returns:

true if successful.

addUser

public void addUser(String name,
                    Object attributes)

Description copied from interface: UsersRepository

Adds a user to the repository with the specified attributes. In current implementations, the Object attributes is generally a String password.

Specified by:

addUser in interface UsersRepository

Parameters:

name - the name of the user to be added

attributes - see decription

getUserByName

public User getUserByName(String name)

Description copied from interface: UsersRepository

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

Specified by:

getUserByName in interface UsersRepository

Parameters:

name - the name of the user to retrieve

Returns:

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

getUserByNameCaseInsensitive

public User getUserByNameCaseInsensitive(String name)

Description copied from interface: UsersRepository

Get the user object with the specified user name. Match user naems on a case insensitive basis. Return null if no such user.

Specified by:

getUserByNameCaseInsensitive in interface UsersRepository

Parameters:

name - the name of the user to retrieve

Returns:

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

getRealName

public String getRealName(String name)

Description copied from interface: UsersRepository

Returns the user name of the user matching name on an equalsIgnoreCase basis. Returns null if no match.

Specified by:

getRealName in interface UsersRepository

Parameters:

name - the name to case-correct

Returns:

the case-correct name of the user, null if the user doesn't exist

getAttributes

public Object getAttributes(String name)

Description copied from interface: UsersRepository

Gets the attribute for a user. Not clear on behavior.

Specified by:

getAttributes in interface UsersRepository

updateUser

public boolean updateUser(User user)

Description copied from interface: UsersRepository

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

Specified by:

updateUser in interface UsersRepository

Returns:

true if successful.

removeUser

public void removeUser(String name)

Description copied from interface: UsersRepository

Removes a user from the repository

Specified by:

removeUser in interface UsersRepository

Parameters:

name - the user to remove from the repository

contains

public boolean contains(String name)

Description copied from interface: UsersRepository

Returns whether or not this user is in the repository

Specified by:

contains in interface UsersRepository

Parameters:

name - the name to check in the repository

Returns:

whether the user is in the repository

containsCaseInsensitive

public boolean containsCaseInsensitive(String name)

Description copied from interface: UsersRepository

Returns whether or not this user is in the repository. Names are matched on a case insensitive basis.

Specified by:

containsCaseInsensitive in interface UsersRepository

Parameters:

name - the name to check in the repository

Returns:

whether the user is in the repository

test

public boolean test(String name,
                    Object attributes)

Description copied from interface: UsersRepository

Tests a user with the appropriate attributes. In current implementations, this typically means "check the password" where a String password is passed as the Object attributes.

Specified by:

test in interface UsersRepository

test

public boolean test(String name,
                    String password)

Description copied from interface: UsersRepository

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

Specified by:

test in interface UsersRepository

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

countUsers

public int countUsers()

Description copied from interface: UsersRepository

Returns a count of the users in the repository.

Specified by:

countUsers in interface UsersRepository

Returns:

the number of users in the repository