org.apache.james.rrt.file

Class XMLRecipientRewriteTable

java.lang.Object

org.apache.james.rrt.lib.AbstractRecipientRewriteTable

org.apache.james.rrt.file.XMLRecipientRewriteTable

All Implemented Interfaces:

Configurable, LogEnabled, RecipientRewriteTable

public class XMLRecipientRewriteTable
extends AbstractRecipientRewriteTable

Class responsible to implement the Virtual User Table in XML disk file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.rrt.api.RecipientRewriteTable

RecipientRewriteTable.ErrorMappingException

Field Summary

Fields inherited from interface org.apache.james.rrt.api.RecipientRewriteTable

ALIASDOMAIN_PREFIX, ERROR_PREFIX, REGEX_PREFIX, WILDCARD

Constructor Summary

Constructors

Constructor and Description
XMLRecipientRewriteTable()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMappingInternal(String user, String domain, String mapping) Add new mapping
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration arg0) Override to handle config
protected Map<String,Collection<String>>	getAllMappingsInternal() Return a Map which holds all Mappings
protected Collection<String>	getUserDomainMappingsInternal(String user, String domain) Return Collection of all mappings for the given username and domain
protected String	mapAddressInternal(String user, String domain) Override to map virtual recipients to real recipients, both local and non-local.
protected void	removeMappingInternal(String user, String domain, String mapping) Remove mapping

Methods inherited from class org.apache.james.rrt.lib.AbstractRecipientRewriteTable

addAddressMapping, addAliasDomainMapping, addErrorMapping, addMapping, addRegexMapping, configure, getAllMappings, getFixedDomain, getFixedUser, getLogger, getMappings, getMappings, getUserDomainMappings, removeAddressMapping, removeAliasDomainMapping, removeErrorMapping, removeMapping, removeRegexMapping, setDomainList, setLog, setMappingLimit, setRecursiveMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLRecipientRewriteTable

public XMLRecipientRewriteTable()

Method Detail

doConfigure

protected void doConfigure(org.apache.commons.configuration.HierarchicalConfiguration arg0)
                    throws org.apache.commons.configuration.ConfigurationException

Description copied from class: AbstractRecipientRewriteTable

Override to handle config

Overrides:

doConfigure in class AbstractRecipientRewriteTable

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

AbstractRecipientRewriteTable.doConfigure(org.apache.commons.configuration.HierarchicalConfiguration)

mapAddressInternal

protected String mapAddressInternal(String user,
                        String domain)
                             throws RecipientRewriteTableException

Description copied from class: AbstractRecipientRewriteTable

Override to map virtual recipients to real recipients, both local and non-local. Each key in the provided map corresponds to a potential virtual recipient, stored as a MailAddress object. Translate virtual recipients to real recipients by mapping a string containing the address of the real recipient as a value to a key. Leave the value null if no mapping should be performed. Multiple recipients may be specified by delineating the mapped string with commas, semi-colons or colons.

Specified by:

mapAddressInternal in class AbstractRecipientRewriteTable

Parameters:

user - the mapping of virtual to real recipients, as MailAddresses to Strings.

Throws:

RecipientRewriteTableException

See Also:

AbstractRecipientRewriteTable.mapAddressInternal(java.lang.String, java.lang.String)

getUserDomainMappingsInternal

protected Collection<String> getUserDomainMappingsInternal(String user,
                                               String domain)
                                                    throws RecipientRewriteTableException

Description copied from class: AbstractRecipientRewriteTable

Return Collection of all mappings for the given username and domain

Specified by:

getUserDomainMappingsInternal in class AbstractRecipientRewriteTable

Parameters:

user - the user

domain - the domain

Returns:

Collection which hold the mappings

Throws:

RecipientRewriteTableException

See Also:

AbstractRecipientRewriteTable.getUserDomainMappingsInternal(java.lang.String, java.lang.String)

getAllMappingsInternal

protected Map<String,Collection<String>> getAllMappingsInternal()
                                                         throws RecipientRewriteTableException

Description copied from class: AbstractRecipientRewriteTable

Return a Map which holds all Mappings

Specified by:

getAllMappingsInternal in class AbstractRecipientRewriteTable

Returns:

Map

Throws:

RecipientRewriteTableException

See Also:

AbstractRecipientRewriteTable.getAllMappingsInternal()

addMappingInternal

protected void addMappingInternal(String user,
                      String domain,
                      String mapping)
                           throws RecipientRewriteTableException

Description copied from class: AbstractRecipientRewriteTable

Add new mapping

Specified by:

addMappingInternal in class AbstractRecipientRewriteTable

Parameters:

user - the user

domain - the domain

mapping - the mapping

Throws:

RecipientRewriteTableException

removeMappingInternal

protected void removeMappingInternal(String user,
                         String domain,
                         String mapping)
                              throws RecipientRewriteTableException

Description copied from class: AbstractRecipientRewriteTable

Remove mapping

Specified by:

removeMappingInternal in class AbstractRecipientRewriteTable

Parameters:

user - the user

domain - the domain

mapping - the mapping

Throws:

RecipientRewriteTableException