org.apache.james.user.file

Class UsersFileRepository

java.lang.Object

org.apache.james.user.lib.AbstractUsersRepository

org.apache.james.user.lib.AbstractJamesUsersRepository

org.apache.james.user.file.UsersFileRepository

All Implemented Interfaces:

Configurable, LogEnabled, RecipientRewriteTable, JamesUsersRepository, UsersRepository

Deprecated.

@Deprecated
public class UsersFileRepository
extends AbstractJamesUsersRepository

Implementation of a Repository to store users on the File System.

Requires a configuration element in the .conf.xml file of the form:

  <repository destinationURL="file://path-to-root-dir-for-repository"
              type="USERS"
              model="SYNCHRONOUS"/>
 

Requires a logger called UsersRepository.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.rrt.api.RecipientRewriteTable

RecipientRewriteTable.ErrorMappingException

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEEP_DEBUG Deprecated. Whether 'deep debugging' is turned on.

Fields inherited from class org.apache.james.user.lib.AbstractJamesUsersRepository

enableAliases, enableForwarding, ignoreCase

Fields inherited from interface org.apache.james.rrt.api.RecipientRewriteTable

ALIASDOMAIN_PREFIX, ERROR_PREFIX, REGEX_PREFIX, WILDCARD

Constructor Summary

Constructors

Constructor and Description
UsersFileRepository() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String name) Deprecated. Returns whether or not this user is in the repository
int	countUsers() Deprecated. Returns a count of the users in the repository.
protected void	doAddUser(User user) Deprecated. Adds a user to the underlying Repository.
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Deprecated.
protected void	doUpdateUser(User user) Deprecated. Updates a user record to match the supplied User.
User	getUserByName(String name) Deprecated. Get the user object with the specified user name.
void	init() Deprecated.
Iterator<String>	list() Deprecated. List users in repository.
void	removeUser(String name) Deprecated. Removes a user from the repository
void	setFileSystem(FileSystem fs) Deprecated.
boolean	test(String name, String password) Deprecated. Test if user with name 'name' has password 'password'.

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

addAddressMapping, addAliasDomainMapping, addErrorMapping, addMapping, addRegexMapping, configure, doAddUser, getAllMappings, getMappings, getUserDomainMappings, removeAddressMapping, removeAliasDomainMapping, removeErrorMapping, removeMapping, removeRegexMapping, setEnableAliases, setEnableForwarding, setIgnoreCase, updateUser

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.user.api.UsersRepository

addUser, supportVirtualHosting

Field Detail

DEEP_DEBUG

protected static boolean DEEP_DEBUG

Deprecated.

Whether 'deep debugging' is turned on.

Constructor Detail

UsersFileRepository

public UsersFileRepository()

Deprecated.

Method Detail

setFileSystem

public void setFileSystem(FileSystem fs)

Deprecated.

doConfigure

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

Deprecated.

Overrides:

doConfigure in class AbstractUsersRepository

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

AbstractUsersRepository.doConfigure(org.apache.commons.configuration.HierarchicalConfiguration)

init

@PostConstruct
public void init()
          throws Exception

Deprecated.

Throws:

Exception

list

public Iterator<String> list()

Deprecated.

Description copied from interface: UsersRepository

List users in repository.

Returns:

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

See Also:

UsersRepository.list()

doAddUser

protected void doAddUser(User user)
                  throws UsersRepositoryException

Deprecated.

Description copied from class: AbstractJamesUsersRepository

Adds a user to the underlying Repository. The user name must not clash with an existing user.

Specified by:

doAddUser in class AbstractJamesUsersRepository

Parameters:

user - the user to add

Throws:

UsersRepositoryException

See Also:

AbstractJamesUsersRepository.doAddUser(org.apache.james.user.api.model.User)

getUserByName

public User getUserByName(String name)
                   throws UsersRepositoryException

Deprecated.

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

See Also:

UsersRepository.getUserByName(java.lang.String)

doUpdateUser

protected void doUpdateUser(User user)
                     throws UsersRepositoryException

Deprecated.

Description copied from class: AbstractJamesUsersRepository

Updates a user record to match the supplied User.

Specified by:

doUpdateUser in class AbstractJamesUsersRepository

Parameters:

user - the user to update

Throws:

UsersRepositoryException

See Also:

AbstractJamesUsersRepository.doUpdateUser(org.apache.james.user.api.model.User)

removeUser

public void removeUser(String name)
                throws UsersRepositoryException

Deprecated.

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(java.lang.String)

contains

public boolean contains(String name)
                 throws UsersRepositoryException

Deprecated.

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(java.lang.String)

test

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

Deprecated.

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(java.lang.String, java.lang.String)

countUsers

public int countUsers()
               throws UsersRepositoryException

Deprecated.

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