org.apache.james.user.lib

Class AbstractUsersRepository

java.lang.Object

org.apache.james.user.lib.AbstractUsersRepository

All Implemented Interfaces:

Configurable, LogEnabled, UsersRepository

Direct Known Subclasses:

AbstractJamesUsersRepository, HBaseUsersRepository, JCRUsersRepository, JPAUsersRepository

public abstract class AbstractUsersRepository
extends Object
implements UsersRepository, LogEnabled, Configurable

Constructor Summary

Constructors

Constructor and Description
AbstractUsersRepository()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUser(String username, String password) Adds a user to the repository with the specified password
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Configure the object.
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 org.slf4j.Logger	getLogger()
protected void	isValidUsername(String username)
void	setDomainList(DomainList domainList)
void	setEnableVirtualHosting(boolean virtualHosting)
void	setLog(org.slf4j.Logger logger) Sets the service log.
boolean	supportVirtualHosting() Return true if virtualHosting support is enabled, otherwise false

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)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

logger - not null

See Also:

LogEnabled.setLog(org.slf4j.Logger)

configure

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

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

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

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

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

public void setDomainList(DomainList domainList)

isValidUsername

protected void isValidUsername(String username)
                        throws UsersRepositoryException

Throws:

UsersRepositoryException

addUser

public void addUser(String username,
           String password)
             throws UsersRepositoryException

Description copied from interface: UsersRepository

Adds a user to the repository with the specified password

Specified by:

addUser in interface UsersRepository

Parameters:

username - the username of the user to be added

password - the password of the user to add

Throws:

UsersRepositoryException - if error

See Also:

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

supportVirtualHosting

public boolean supportVirtualHosting()
                              throws UsersRepositoryException

Description copied from interface: UsersRepository

Return true if virtualHosting support is enabled, otherwise false

Specified by:

supportVirtualHosting in interface UsersRepository

Returns:

true or false

Throws:

UsersRepositoryException

See Also:

UsersRepository.supportVirtualHosting()

doAddUser

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

Add the user with the given username and password

Parameters:

username -

password -

Throws:

UsersRepositoryException - If an error occurred