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:

Configurable, LogEnabled, RecipientRewriteTable, JamesUsersRepository, UsersRepository

Direct Known Subclasses:

AbstractJdbcUsersRepository, UsersFileRepository

Deprecated.

Please implement UsersRepository

@Deprecated
public abstract class AbstractJamesUsersRepository
extends AbstractUsersRepository
implements JamesUsersRepository, 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

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

Methods

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String address) Deprecated. Add address mapping
void	addAliasDomainMapping(String aliasDomain, String realDomain) Deprecated. Add aliasDomain mapping
void	addErrorMapping(String user, String domain, String error) Deprecated. Add error mapping
void	addMapping(String user, String domain, String mapping) Deprecated. Add mapping
void	addRegexMapping(String user, String domain, String regex) Deprecated. Add regex mapping
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Deprecated. Configure the object.
protected void	doAddUser(String username, String password) Deprecated. Add the user with the given username and password
protected abstract void	doAddUser(User user) Deprecated. Adds a user to the underlying Repository.
protected abstract void	doUpdateUser(User user) Deprecated. Updates a user record to match the supplied User.
Map<String,Collection<String>>	getAllMappings() Deprecated. Return a Map which holds all mappings.
Collection<String>	getMappings(String username, String domain) Deprecated. Return the mapped MailAddress for the given address.
Collection<String>	getUserDomainMappings(String user, String domain) Deprecated. Return the explicit mapping stored for the given user and domain.
void	removeAddressMapping(String user, String domain, String address) Deprecated. Remove address mapping
void	removeAliasDomainMapping(String aliasDomain, String realDomain) Deprecated. Remove aliasDomain mapping
void	removeErrorMapping(String user, String domain, String error) Deprecated. Remove error mapping
void	removeMapping(String user, String domain, String mapping) Deprecated. Remove mapping
void	removeRegexMapping(String user, String domain, String regex) Deprecated. Remove regex mapping
void	setEnableAliases(boolean enableAliases) Deprecated. enable/disable aliases in case of JamesUsers
void	setEnableForwarding(boolean enableForwarding) Deprecated. enable/disable aliases in case of JamesUsers
void	setIgnoreCase(boolean ignoreCase) Deprecated. set case sensitive/insensitive operations
void	updateUser(User user) Deprecated. Update the repository with the specified user object.

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

addUser, doConfigure, 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, contains, countUsers, getUserByName, 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.

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface 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(User user)
                           throws 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:

UsersRepositoryException

doUpdateUser

protected abstract void doUpdateUser(User user)
                              throws UsersRepositoryException

Deprecated.

Updates a user record to match the supplied User.

Parameters:

user - the user to update

Throws:

UsersRepositoryException

doAddUser

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

Deprecated.

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

updateUser

public void updateUser(User user)
                throws UsersRepositoryException

Deprecated.

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

Specified by:

updateUser in interface UsersRepository

Parameters:

user - the user to be updated

Throws:

UsersRepositoryException

getMappings

public Collection<String> getMappings(String username,
                             String domain)
                               throws RecipientRewriteTable.ErrorMappingException,
                                      RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Return the mapped MailAddress for the given address. Return null if no matched mapping was found

Specified by:

getMappings in interface RecipientRewriteTable

Parameters:

username - the MailAddress

Returns:

the mapped mailAddress

Throws:

RecipientRewriteTableException

RecipientRewriteTable.ErrorMappingException - get thrown if an error mapping was found

See Also:

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

setEnableAliases

public void setEnableAliases(boolean enableAliases)

Deprecated.

Description copied from interface: JamesUsersRepository

enable/disable aliases in case of JamesUsers

Specified by:

setEnableAliases in interface JamesUsersRepository

Parameters:

enableAliases - enable

See Also:

JamesUsersRepository.setEnableAliases(boolean)

setEnableForwarding

public void setEnableForwarding(boolean enableForwarding)

Deprecated.

Description copied from interface: JamesUsersRepository

enable/disable aliases in case of JamesUsers

Specified by:

setEnableForwarding in interface JamesUsersRepository

Parameters:

enableForwarding - enable

See Also:

JamesUsersRepository.setEnableForwarding(boolean)

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Deprecated.

Description copied from interface: JamesUsersRepository

set case sensitive/insensitive operations

Specified by:

setIgnoreCase in interface JamesUsersRepository

Parameters:

ignoreCase - ignore

See Also:

JamesUsersRepository.setIgnoreCase(boolean)

getAllMappings

public Map<String,Collection<String>> getAllMappings()
                                              throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Return a Map which holds all mappings. The key is the user@domain and the value is a Collection which holds all mappings

Specified by:

getAllMappings in interface RecipientRewriteTable

Returns:

Map which holds all mappings

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.getAllMappings()

getUserDomainMappings

public Collection<String> getUserDomainMappings(String user,
                                       String domain)
                                         throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Return the explicit mapping stored for the given user and domain. Return null if no mapping was found

Specified by:

getUserDomainMappings in interface RecipientRewriteTable

Parameters:

user - the username

domain - the domain

Returns:

the collection which holds the mappings.

Throws:

RecipientRewriteTableException

See Also:

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

addRegexMapping

public void addRegexMapping(String user,
                   String domain,
                   String regex)
                     throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Add regex mapping

Specified by:

addRegexMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

regex - the regex.

Throws:

RecipientRewriteTableException

removeRegexMapping

public void removeRegexMapping(String user,
                      String domain,
                      String regex)
                        throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Remove regex mapping

Specified by:

removeRegexMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

regex - the regex.

Throws:

RecipientRewriteTableException

addAddressMapping

public void addAddressMapping(String user,
                     String domain,
                     String address)
                       throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Add address mapping

Specified by:

addAddressMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

Throws:

RecipientRewriteTableException

removeAddressMapping

public void removeAddressMapping(String user,
                        String domain,
                        String address)
                          throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Remove address mapping

Specified by:

removeAddressMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

Throws:

RecipientRewriteTableException

addErrorMapping

public void addErrorMapping(String user,
                   String domain,
                   String error)
                     throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Add error mapping

Specified by:

addErrorMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

error - the regex.

Throws:

RecipientRewriteTableException

removeErrorMapping

public void removeErrorMapping(String user,
                      String domain,
                      String error)
                        throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Remove error mapping

Specified by:

removeErrorMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

Throws:

RecipientRewriteTableException

addMapping

public void addMapping(String user,
              String domain,
              String mapping)
                throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Add mapping

Specified by:

addMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

mapping - the mapping

Throws:

RecipientRewriteTableException

removeMapping

public void removeMapping(String user,
                 String domain,
                 String mapping)
                   throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Remove mapping

Specified by:

removeMapping in interface RecipientRewriteTable

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

mapping - the mapping

Throws:

RecipientRewriteTableException

addAliasDomainMapping

public void addAliasDomainMapping(String aliasDomain,
                         String realDomain)
                           throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Add aliasDomain mapping

Specified by:

addAliasDomainMapping in interface RecipientRewriteTable

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException

removeAliasDomainMapping

public void removeAliasDomainMapping(String aliasDomain,
                            String realDomain)
                              throws RecipientRewriteTableException

Deprecated.

Description copied from interface: RecipientRewriteTable

Remove aliasDomain mapping

Specified by:

removeAliasDomainMapping in interface RecipientRewriteTable

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException