org.apache.james.user.lib

Class AbstractJamesUsersRepository

java.lang.Object

org.apache.james.user.lib.AbstractUsersRepository

org.apache.james.user.lib.AbstractJamesUsersRepository

All Implemented Interfaces:

org.apache.james.lifecycle.api.Configurable, org.apache.james.lifecycle.api.LogEnabled, org.apache.james.rrt.api.RecipientRewriteTable, org.apache.james.user.api.JamesUsersRepository, org.apache.james.user.api.UsersRepository

Deprecated.

Please implement UsersRepository

@Deprecated
public abstract class AbstractJamesUsersRepository
extends AbstractUsersRepository
implements org.apache.james.user.api.JamesUsersRepository, org.apache.james.rrt.api.RecipientRewriteTable

A partial implementation of a Repository to store users.

This implements common functionality found in different UsersRespository implementations, and makes it easier to create new User repositories.

Nested Class Summary

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

org.apache.james.rrt.api.RecipientRewriteTable.ErrorMappingException

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enableAliases Deprecated. Enable Aliases frmo JamesUser
protected boolean	enableForwarding Deprecated. Wether to enable forwarding for JamesUser or not
protected boolean	ignoreCase Deprecated. Ignore case in usernames

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

ALIASDOMAIN_PREFIX, ERROR_PREFIX, REGEX_PREFIX, WILDCARD

Constructor Summary

Constructors

Constructor and Description
AbstractJamesUsersRepository() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String address) Deprecated.
void	addAliasDomainMapping(String aliasDomain, String realDomain) Deprecated.
void	addErrorMapping(String user, String domain, String error) Deprecated.
void	addMapping(String user, String domain, String mapping) Deprecated.
void	addRegexMapping(String user, String domain, String regex) Deprecated.
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Deprecated.
protected void	doAddUser(String username, String password) Deprecated. Add the user with the given username and password
protected abstract void	doAddUser(org.apache.james.user.api.model.User user) Deprecated. Adds a user to the underlying Repository.
protected abstract void	doUpdateUser(org.apache.james.user.api.model.User user) Deprecated. Updates a user record to match the supplied User.
Map<String,org.apache.james.rrt.lib.Mappings>	getAllMappings() Deprecated.
org.apache.james.rrt.lib.Mappings	getMappings(String username, String domain) Deprecated.
org.apache.james.rrt.lib.Mappings	getUserDomainMappings(String user, String domain) Deprecated.
void	removeAddressMapping(String user, String domain, String address) Deprecated.
void	removeAliasDomainMapping(String aliasDomain, String realDomain) Deprecated.
void	removeErrorMapping(String user, String domain, String error) Deprecated.
void	removeMapping(String user, String domain, String mapping) Deprecated.
void	removeRegexMapping(String user, String domain, String regex) Deprecated.
void	setEnableAliases(boolean enableAliases) Deprecated.
void	setEnableForwarding(boolean enableForwarding) Deprecated.
void	setIgnoreCase(boolean ignoreCase) Deprecated.
void	updateUser(org.apache.james.user.api.model.User user) Deprecated. Update the repository with the specified user object.

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

addUser, doConfigure, getDefaultVirtualHostingValue, getLogger, getUser, isAdministrator, 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, contains, countUsers, getUser, getUserByName, isAdministrator, list, removeUser, supportVirtualHosting, test

Field Detail

ignoreCase

protected boolean ignoreCase

Deprecated.

Ignore case in usernames

enableAliases

protected boolean enableAliases

Deprecated.

Enable Aliases frmo JamesUser

enableForwarding

protected boolean enableForwarding

Deprecated.

Wether to enable forwarding for JamesUser or not

Constructor Detail

AbstractJamesUsersRepository

public AbstractJamesUsersRepository()

Deprecated.

Method Detail

configure

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

Deprecated.

Specified by:

configure in interface org.apache.james.lifecycle.api.Configurable

Overrides:

configure in class AbstractUsersRepository

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

Configurable.configure(org.apache.commons.configuration.HierarchicalConfiguration)

doAddUser

protected abstract void doAddUser(org.apache.james.user.api.model.User user)
                           throws org.apache.james.user.api.UsersRepositoryException

Deprecated.

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

Parameters:

user - the user to add

Throws:

org.apache.james.user.api.UsersRepositoryException

doUpdateUser

protected abstract void doUpdateUser(org.apache.james.user.api.model.User user)
                              throws org.apache.james.user.api.UsersRepositoryException

Deprecated.

Updates a user record to match the supplied User.

Parameters:

user - the user to update

Throws:

org.apache.james.user.api.UsersRepositoryException

doAddUser

protected void doAddUser(String username,
                         String password)
                  throws org.apache.james.user.api.UsersRepositoryException

Deprecated.

Description copied from class: AbstractUsersRepository

Add the user with the given username and password

Specified by:

doAddUser in class AbstractUsersRepository

Throws:

org.apache.james.user.api.UsersRepositoryException - If an error occurred

See Also:

AbstractUsersRepository.doAddUser(java.lang.String, java.lang.String)

updateUser

public void updateUser(org.apache.james.user.api.model.User user)
                throws org.apache.james.user.api.UsersRepositoryException

Deprecated.

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

Specified by:

updateUser in interface org.apache.james.user.api.UsersRepository

Parameters:

user - the user to be updated

Throws:

org.apache.james.user.api.UsersRepositoryException

getMappings

public org.apache.james.rrt.lib.Mappings getMappings(String username,
                                                     String domain)
                                              throws org.apache.james.rrt.api.RecipientRewriteTable.ErrorMappingException,
                                                     org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

getMappings in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

org.apache.james.rrt.api.RecipientRewriteTable.ErrorMappingException

See Also:

RecipientRewriteTable.getMappings(java.lang.String, java.lang.String)

setEnableAliases

public void setEnableAliases(boolean enableAliases)

Deprecated.

Specified by:

setEnableAliases in interface org.apache.james.user.api.JamesUsersRepository

See Also:

JamesUsersRepository.setEnableAliases(boolean)

setEnableForwarding

public void setEnableForwarding(boolean enableForwarding)

Deprecated.

Specified by:

setEnableForwarding in interface org.apache.james.user.api.JamesUsersRepository

See Also:

JamesUsersRepository.setEnableForwarding(boolean)

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Deprecated.

Specified by:

setIgnoreCase in interface org.apache.james.user.api.JamesUsersRepository

See Also:

JamesUsersRepository.setIgnoreCase(boolean)

getAllMappings

public Map<String,org.apache.james.rrt.lib.Mappings> getAllMappings()
                                                             throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

getAllMappings in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

See Also:

RecipientRewriteTable.getAllMappings()

getUserDomainMappings

public org.apache.james.rrt.lib.Mappings getUserDomainMappings(String user,
                                                               String domain)
                                                        throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

getUserDomainMappings in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

See Also:

RecipientRewriteTable.getUserDomainMappings(java.lang.String, java.lang.String)

addRegexMapping

public void addRegexMapping(String user,
                            String domain,
                            String regex)
                     throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

addRegexMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

removeRegexMapping

public void removeRegexMapping(String user,
                               String domain,
                               String regex)
                        throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

removeRegexMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

addAddressMapping

public void addAddressMapping(String user,
                              String domain,
                              String address)
                       throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

addAddressMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

removeAddressMapping

public void removeAddressMapping(String user,
                                 String domain,
                                 String address)
                          throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

removeAddressMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

addErrorMapping

public void addErrorMapping(String user,
                            String domain,
                            String error)
                     throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

addErrorMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

removeErrorMapping

public void removeErrorMapping(String user,
                               String domain,
                               String error)
                        throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

removeErrorMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

addMapping

public void addMapping(String user,
                       String domain,
                       String mapping)
                throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

addMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

removeMapping

public void removeMapping(String user,
                          String domain,
                          String mapping)
                   throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

removeMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

addAliasDomainMapping

public void addAliasDomainMapping(String aliasDomain,
                                  String realDomain)
                           throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

addAliasDomainMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException

removeAliasDomainMapping

public void removeAliasDomainMapping(String aliasDomain,
                                     String realDomain)
                              throws org.apache.james.rrt.api.RecipientRewriteTableException

Deprecated.

Specified by:

removeAliasDomainMapping in interface org.apache.james.rrt.api.RecipientRewriteTable

Throws:

org.apache.james.rrt.api.RecipientRewriteTableException