org.apache.james.user.lib

Class UsersRepositoryManagement

java.lang.Object

javax.management.StandardMBean

org.apache.james.user.lib.UsersRepositoryManagement

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, UsersRepositoryManagementMBean

public class UsersRepositoryManagement
extends StandardMBean
implements UsersRepositoryManagementMBean

Constructor Summary

Constructors

Constructor and Description
UsersRepositoryManagement()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUser(String userName, String password) Adds a user to this mail server.
long	countUsers() Total count of existing users
void	deleteUser(String userName) Deletes a user from this mail server.
String	getAlias(String userName) Retrieves the user's alias, if set
String	getForwardAddress(String userName) Retrieves the user's forward, if set
boolean	getVirtualHostingEnabled() Return true if the UserRepository has VirtualHosting enabled
String[]	listAllUsers() List the names of all users
void	setPassword(String userName, String password) Set a user's password
void	setUsersRepository(UsersRepository localUsers)
void	unsetAlias(String userName) Removes a user's alias which terminates local mail forwarding
void	unsetForwardAddress(String userName) Removes a user's forward email address which terminates remote mail forwarding
boolean	verifyExists(String userName) Check if a user exists with the given name.

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersRepositoryManagement

public UsersRepositoryManagement()
                          throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

setUsersRepository

public void setUsersRepository(UsersRepository localUsers)

addUser

public void addUser(String userName,
           String password)
             throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Adds a user to this mail server.

Specified by:

addUser in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user being added

password - The password of the user being added

Throws:

Exception

See Also:

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

deleteUser

public void deleteUser(String userName)
                throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Deletes a user from this mail server.

Specified by:

deleteUser in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user being deleted

Throws:

UsersRepositoryException - if error

Exception

See Also:

UsersRepositoryManagementMBean.deleteUser(java.lang.String)

verifyExists

public boolean verifyExists(String userName)
                     throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Check if a user exists with the given name.

Specified by:

verifyExists in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user

Returns:

TRUE, if the user exists

Throws:

UsersRepositoryException - if error

Exception

See Also:

(java.lang.String)

countUsers

public long countUsers()
                throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Total count of existing users

Specified by:

countUsers in interface UsersRepositoryManagementMBean

Returns:

Total count of existing users

Throws:

Exception

See Also:

UsersRepositoryManagementMBean.countUsers()

listAllUsers

public String[] listAllUsers()
                      throws Exception

Description copied from interface: UsersRepositoryManagementMBean

List the names of all users

Specified by:

listAllUsers in interface UsersRepositoryManagementMBean

Returns:

List of all user names

Throws:

UsersRepositoryException - if error

Exception

See Also:

UsersRepositoryManagementMBean.listAllUsers()

setPassword

public void setPassword(String userName,
               String password)
                 throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Set a user's password

Specified by:

setPassword in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user whose password will be changed

password - The new password

Throws:

UsersRepositoryException - if error

Exception

See Also:

(java.lang.String, java.lang.String)

unsetAlias

public void unsetAlias(String userName)
                throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Removes a user's alias which terminates local mail forwarding

Specified by:

unsetAlias in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user whose alias is unset

Throws:

UsersRepositoryException - if error

Exception

See Also:

UsersRepositoryManagementMBean.unsetAlias(java.lang.String)

getAlias

public String getAlias(String userName)
                throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Retrieves the user's alias, if set

Specified by:

getAlias in interface UsersRepositoryManagementMBean

Returns:

User's alias, or NULL, if no alias is set

Throws:

UsersRepositoryException - if error

Exception

See Also:

UsersRepositoryManagementMBean.getAlias(java.lang.String)

unsetForwardAddress

public void unsetForwardAddress(String userName)
                         throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Removes a user's forward email address which terminates remote mail forwarding

Specified by:

unsetForwardAddress in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user whose forward is unset

Throws:

UsersRepositoryException - if error

Exception

See Also:

(java.lang.String)

getForwardAddress

public String getForwardAddress(String userName)
                         throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Retrieves the user's forward, if set

Specified by:

getForwardAddress in interface UsersRepositoryManagementMBean

Parameters:

userName - The name of the user whose forward is set

Returns:

User's forward email address, or NULL, if no forward is set

Throws:

UsersRepositoryException - if error

Exception

See Also:

(java.lang.String)

getVirtualHostingEnabled

public boolean getVirtualHostingEnabled()
                                 throws Exception

Description copied from interface: UsersRepositoryManagementMBean

Return true if the UserRepository has VirtualHosting enabled

Specified by:

getVirtualHostingEnabled in interface UsersRepositoryManagementMBean

Returns:

virtual

Throws:

UsersRepositoryException

Exception

See Also:

UsersRepositoryManagementMBean.getVirtualHostingEnabled()