org.apache.james.user.lib

Class AbstractUsersRepository

java.lang.Object

org.apache.james.user.lib.AbstractUsersRepository

All Implemented Interfaces:

org.apache.james.lifecycle.api.Configurable, org.apache.james.lifecycle.api.LogEnabled, org.apache.james.user.api.UsersRepository

Direct Known Subclasses:

AbstractJamesUsersRepository

public abstract class AbstractUsersRepository
extends Object
implements org.apache.james.user.api.UsersRepository, org.apache.james.lifecycle.api.LogEnabled, org.apache.james.lifecycle.api.Configurable

Constructor Summary

Constructors

Constructor and Description
AbstractUsersRepository()

Method Summary

Modifier and Type	Method and Description
void	addUser(String username, String password)
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration)
protected abstract void	doAddUser(String username, String password) Add the user with the given username and password
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
protected boolean	getDefaultVirtualHostingValue()
protected org.slf4j.Logger	getLogger()
String	getUser(org.apache.mailet.MailAddress mailAddress)
boolean	isAdministrator(String username)
protected void	isValidUsername(String username)
void	setDomainList(org.apache.james.domainlist.api.DomainList domainList)
void	setEnableVirtualHosting(boolean virtualHosting)
void	setLog(org.slf4j.Logger logger)
boolean	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

contains, countUsers, getUserByName, list, removeUser, test, updateUser

Constructor Detail

AbstractUsersRepository

public AbstractUsersRepository()

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

setLog

public void setLog(org.slf4j.Logger logger)

Specified by:

setLog in interface org.apache.james.lifecycle.api.LogEnabled

See Also:

LogEnabled.setLog(org.slf4j.Logger)

configure

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

Specified by:

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

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

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

getDefaultVirtualHostingValue

protected boolean getDefaultVirtualHostingValue()

doConfigure

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

Throws:

org.apache.commons.configuration.ConfigurationException

setEnableVirtualHosting

public void setEnableVirtualHosting(boolean virtualHosting)

setDomainList

@Inject
public void setDomainList(org.apache.james.domainlist.api.DomainList domainList)

isValidUsername

protected void isValidUsername(String username)
                        throws org.apache.james.user.api.UsersRepositoryException

Throws:

org.apache.james.user.api.UsersRepositoryException

addUser

public void addUser(String username,
                    String password)
             throws org.apache.james.user.api.UsersRepositoryException

Specified by:

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

Throws:

org.apache.james.user.api.UsersRepositoryException

See Also:

UsersRepository.addUser(java.lang.String, java.lang.String)

supportVirtualHosting

public boolean supportVirtualHosting()

Specified by:

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

See Also:

UsersRepository.supportVirtualHosting()

doAddUser

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

Add the user with the given username and password

Parameters:

username -

password -

Throws:

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

getUser

public String getUser(org.apache.mailet.MailAddress mailAddress)
               throws org.apache.james.user.api.UsersRepositoryException

Specified by:

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

Throws:

org.apache.james.user.api.UsersRepositoryException

isAdministrator

public boolean isAdministrator(String username)
                        throws org.apache.james.user.api.UsersRepositoryException

Specified by:

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

Throws:

org.apache.james.user.api.UsersRepositoryException