org.apache.james.user.api

Interface UsersRepositoryManagementMBean

All Known Implementing Classes:

UsersRepositoryManagement

public interface UsersRepositoryManagementMBean

Expose user account management functionality through JMX.

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) Deprecated.
String	getForwardAddress(String userName) Deprecated.
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	unsetAlias(String userName) Deprecated.
void	unsetForwardAddress(String userName) Deprecated.
boolean	verifyExists(String userName) Check if a user exists with the given name.

Method Detail

addUser

void addUser(String userName,
           String password)
             throws Exception

Adds a user to this mail server.

Parameters:

userName - The name of the user being added

password - The password of the user being added

Throws:

Exception

deleteUser

void deleteUser(String userName)
                throws Exception

Deletes a user from this mail server.

Parameters:

userName - The name of the user being deleted

Throws:

UsersRepositoryException - if error

Exception

verifyExists

boolean verifyExists(String userName)
                     throws Exception

Check if a user exists with the given name.

Parameters:

userName - The name of the user

Returns:

TRUE, if the user exists

Throws:

UsersRepositoryException - if error

Exception

countUsers

long countUsers()
                throws Exception

Total count of existing users

Returns:

Total count of existing users

Throws:

Exception

listAllUsers

String[] listAllUsers()
                      throws Exception

List the names of all users

Returns:

List of all user names

Throws:

UsersRepositoryException - if error

Exception

setPassword

void setPassword(String userName,
               String password)
                 throws Exception

Set a user's password

Parameters:

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

password - The new password

Throws:

UsersRepositoryException - if error

Exception

unsetAlias

@Deprecated
void unsetAlias(String userName)
                throws Exception

Deprecated.

Removes a user's alias which terminates local mail forwarding

Parameters:

userName - The name of the user whose alias is unset

Throws:

UsersRepositoryException - if error

Exception

getAlias

@Deprecated
String getAlias(String userName)
                throws Exception

Deprecated.

Retrieves the user's alias, if set

Returns:

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

Throws:

UsersRepositoryException - if error

Exception

unsetForwardAddress

@Deprecated
void unsetForwardAddress(String userName)
                         throws Exception

Deprecated.

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

Parameters:

userName - The name of the user whose forward is unset

Throws:

UsersRepositoryException - if error

Exception

getForwardAddress

@Deprecated
String getForwardAddress(String userName)
                         throws Exception

Deprecated.

Retrieves the user's forward, if set

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

getVirtualHostingEnabled

boolean getVirtualHostingEnabled()
                                 throws Exception

Return true if the UserRepository has VirtualHosting enabled

Returns:

virtual

Throws:

UsersRepositoryException

Exception