org.apache.james.cli.probe

Interface ServerProbe

All Known Implementing Classes:

JmxServerProbe

public interface ServerProbe

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String toAddress) Add address mapping.
void	addDomain(String domain) Add domain to the service.
void	addRegexMapping(String user, String domain, String regex) Remove regex mapping.
void	addUser(String userName, String password) Add a user to this mail server.
String[]	listDomains() Get a list of domains for the service.
Map<String,Collection<String>>	listMappings() Get a Map which holds all mappings.
Collection<String>	listUserDomainMappings(String user, String domain) Return the explicit mapping stored for the given user and domain.
String[]	listUsers() Get a List the names of all users.
void	removeAddressMapping(String user, String domain, String fromAddress) Remove address mapping.
void	removeDomain(String domain) Remove domain from the service
void	removeRegexMapping(String user, String domain, String regex) Remove regex mapping.
void	removeUser(String username) Delete a user from this mail server.
void	setPassword(String userName, String password) Set a user's password.

Method Detail

addUser

void addUser(String userName,
           String password)
             throws Exception

Add 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

removeUser

void removeUser(String username)
                throws Exception

Delete a user from this mail server.

Parameters:

username - The name of the user being deleted.

Throws:

Exception

listUsers

String[] listUsers()
                   throws Exception

Get a List the names of all users.

Returns:

a List of all user names.

Throws:

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:

Exception

addDomain

void addDomain(String domain)
               throws Exception

Add domain to the service.

Parameters:

domain - The domain to add.

Throws:

Exception

removeDomain

void removeDomain(String domain)
                  throws Exception

Remove domain from the service

Parameters:

domain - The domain to remove.

Throws:

Exception

listDomains

String[] listDomains()
                     throws Exception

Get a list of domains for the service.

Returns:

domains an array of domains, or null if no domains exist.

Throws:

Exception

listMappings

Map<String,Collection<String>> listMappings()
                                            throws Exception

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

Returns:

a Map which holds all mappings.

Throws:

Exception

addAddressMapping

void addAddressMapping(String user,
                     String domain,
                     String toAddress)
                       throws Exception

Add address mapping.

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

toAddress - The address.

Throws:

Exception

removeAddressMapping

void removeAddressMapping(String user,
                        String domain,
                        String fromAddress)
                          throws Exception

Remove address mapping.

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used

fromAddress - The address.

Throws:

Exception

listUserDomainMappings

Collection<String> listUserDomainMappings(String user,
                                        String domain)
                                          throws Exception

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

Parameters:

user - The username.

domain - The domain.

Returns:

the collection which holds the mappings, or null if no mapping is found.

Throws:

Exception

addRegexMapping

void addRegexMapping(String user,
                   String domain,
                   String regex)
                     throws Exception

Remove regex mapping.

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

regex - The regex.

Throws:

Exception

removeRegexMapping

void removeRegexMapping(String user,
                      String domain,
                      String regex)
                        throws Exception

Remove regex mapping.

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

regex - The regex.

Throws:

Exception