org.apache.james.rrt.api

Interface RecipientRewriteTableManagementMBean

All Known Implementing Classes:

RecipientRewriteTableManagement

public interface RecipientRewriteTableManagementMBean

Expose virtualusertable management functionality through JMX.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String address) Add address mapping
void	addDomainMapping(String domain, String targetDomain) Add domain mapping
void	addErrorMapping(String user, String domain, String error) Add error mapping
void	addMapping(String user, String domain, String mapping) Try to identify the right method based on the prefix of the mapping and add it.
void	addRegexMapping(String user, String domain, String regex) Add regex mapping
Map<String,Collection<String>>	getAllMappings() Return a Map which holds all mappings.
Collection<String>	getUserDomainMappings(String user, String domain) Return the explicit mapping stored for the given user and domain.
void	removeAddressMapping(String user, String domain, String address) Remove address mapping
void	removeDomainMapping(String domain, String targetDomain) Remove domain mapping
void	removeErrorMapping(String user, String domain, String error) Remove error mapping
void	removeMapping(String user, String domain, String mapping) Try to identify the right method based on the prefix of the mapping and remove it.
void	removeRegexMapping(String user, String domain, String regex) Remove regex mapping

Method Detail

addRegexMapping

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

Add regex mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

regex - the regex.

Throws:

Exception - If an error occurred

removeRegexMapping

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

Remove regex mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

regex - the regex.

Throws:

Exception - If an error occurred

addAddressMapping

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

Add address mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

address - the address.

Throws:

Exception - If an error occurred

removeAddressMapping

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

Remove address mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

address -

Throws:

Exception - If an error occurred

addErrorMapping

void addErrorMapping(String user,
                   String domain,
                   String error)
                     throws Exception

Add error mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

error -

Throws:

Exception - If an error occurred

removeErrorMapping

void removeErrorMapping(String user,
                      String domain,
                      String error)
                        throws Exception

Remove error mapping

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

error -

Throws:

Exception - If an error occurred

addDomainMapping

void addDomainMapping(String domain,
                    String targetDomain)
                      throws Exception

Add domain mapping

Parameters:

domain - the domain. Null if no domain should be used

targetDomain - the target domain for the mapping

Throws:

Exception - If an error occurred

removeDomainMapping

void removeDomainMapping(String domain,
                       String targetDomain)
                         throws Exception

Remove domain mapping

Parameters:

domain - the domain. Null if no domain should be used

targetDomain - the target domain for the mapping

Throws:

Exception - If an error occurred

getUserDomainMappings

Collection<String> getUserDomainMappings(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.

Throws:

Exception - If an error occurred

addMapping

void addMapping(String user,
              String domain,
              String mapping)
                throws Exception

Try to identify the right method based on the prefix of the mapping and add it.

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

mapping - the mapping.

Throws:

Exception - If an error occurred

removeMapping

void removeMapping(String user,
                 String domain,
                 String mapping)
                   throws Exception

Try to identify the right method based on the prefix of the mapping and remove it.

Parameters:

user - the username. Null if no username should be used

domain - the domain. Null if no domain should be used

mapping - the mapping.

Throws:

Exception - If an error occurred

getAllMappings

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

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

Returns:

Map which holds all mappings

Throws:

Exception - If an error occurred