org.apache.james.rrt.lib

Class RecipientRewriteTableManagement

java.lang.Object

javax.management.StandardMBean

org.apache.james.rrt.lib.RecipientRewriteTableManagement

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, RecipientRewriteTableManagementMBean

public class RecipientRewriteTableManagement
extends StandardMBean
implements RecipientRewriteTableManagementMBean

Management for RecipientRewriteTables

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecipientRewriteTableManagement()

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
void	setManageableRecipientRewriteTable(RecipientRewriteTable vut)

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

RecipientRewriteTableManagement

protected RecipientRewriteTableManagement()
                                   throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

setManageableRecipientRewriteTable

public void setManageableRecipientRewriteTable(RecipientRewriteTable vut)

addRegexMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Add regex mapping

Specified by:

addRegexMapping in interface RecipientRewriteTableManagementMBean

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

See Also:

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

removeRegexMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Remove regex mapping

Specified by:

removeRegexMapping in interface RecipientRewriteTableManagementMBean

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

See Also:

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

addAddressMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Add address mapping

Specified by:

addAddressMapping in interface RecipientRewriteTableManagementMBean

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

See Also:

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

removeAddressMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Remove address mapping

Specified by:

removeAddressMapping in interface RecipientRewriteTableManagementMBean

Parameters:

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

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

Throws:

Exception - If an error occurred

See Also:

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

addErrorMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Add error mapping

Specified by:

addErrorMapping in interface RecipientRewriteTableManagementMBean

Parameters:

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

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

Throws:

Exception - If an error occurred

See Also:

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

removeErrorMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

Remove error mapping

Specified by:

removeErrorMapping in interface RecipientRewriteTableManagementMBean

Parameters:

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

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

Throws:

Exception - If an error occurred

See Also:

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

addDomainMapping

public void addDomainMapping(String domain,
                    String targetDomain)
                      throws Exception

Description copied from interface: RecipientRewriteTableManagementMBean

Add domain mapping

Specified by:

addDomainMapping in interface RecipientRewriteTableManagementMBean

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

public void removeDomainMapping(String domain,
                       String targetDomain)
                         throws Exception

Description copied from interface: RecipientRewriteTableManagementMBean

Remove domain mapping

Specified by:

removeDomainMapping in interface RecipientRewriteTableManagementMBean

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

public Collection<String> getUserDomainMappings(String user,
                                       String domain)
                                         throws Exception

Description copied from interface: RecipientRewriteTableManagementMBean

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

Specified by:

getUserDomainMappings in interface RecipientRewriteTableManagementMBean

Parameters:

user - the username

domain - the domain

Returns:

the collection which holds the mappings.

Throws:

Exception - If an error occurred

See Also:

#getUserDomainMappings(java.lang.String, java.lang.String)

addMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

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

Specified by:

addMapping in interface RecipientRewriteTableManagementMBean

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

See Also:

#addMapping(java.lang.String, java.lang.String, java.lang.String)

removeMapping

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

Description copied from interface: RecipientRewriteTableManagementMBean

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

Specified by:

removeMapping in interface RecipientRewriteTableManagementMBean

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

See Also:

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

getAllMappings

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

Description copied from interface: RecipientRewriteTableManagementMBean

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

Specified by:

getAllMappings in interface RecipientRewriteTableManagementMBean

Returns:

Map which holds all mappings

Throws:

Exception - If an error occurred

See Also:

RecipientRewriteTableManagementMBean.getAllMappings()