org.apache.james.rrt.lib

Class AbstractRecipientRewriteTable

java.lang.Object

org.apache.james.rrt.lib.AbstractRecipientRewriteTable

All Implemented Interfaces:

Configurable, LogEnabled, RecipientRewriteTable

Direct Known Subclasses:

HBaseRecipientRewriteTable, JDBCRecipientRewriteTable, JPARecipientRewriteTable, XMLRecipientRewriteTable

public abstract class AbstractRecipientRewriteTable
extends Object
implements RecipientRewriteTable, LogEnabled, Configurable

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
AbstractRecipientRewriteTable()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String address) Add address mapping
void	addAliasDomainMapping(String aliasDomain, String realDomain) Add aliasDomain mapping
void	addErrorMapping(String user, String domain, String error) Add error mapping
void	addMapping(String user, String domain, String mapping) Add mapping
protected abstract void	addMappingInternal(String user, String domain, String mapping) Add new mapping
void	addRegexMapping(String user, String domain, String regex) Add regex mapping
void	configure(org.apache.commons.configuration.HierarchicalConfiguration config) Configure the object.
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration conf) Override to handle config
Map<String,Collection<String>>	getAllMappings() Return a Map which holds all mappings.
protected abstract Map<String,Collection<String>>	getAllMappingsInternal() Return a Map which holds all Mappings
protected String	getFixedDomain(String domain) Fix the domain for the given argument.
protected String	getFixedUser(String user) Return user String for the given argument.
protected org.slf4j.Logger	getLogger()
Collection<String>	getMappings(String user, String domain) Return the mapped MailAddress for the given address.
Collection<String>	getMappings(String user, String domain, int mappingLimit)
Collection<String>	getUserDomainMappings(String user, String domain) Return the explicit mapping stored for the given user and domain.
protected abstract Collection<String>	getUserDomainMappingsInternal(String user, String domain) Return Collection of all mappings for the given username and domain
protected abstract String	mapAddressInternal(String user, String domain) Override to map virtual recipients to real recipients, both local and non-local.
void	removeAddressMapping(String user, String domain, String address) Remove address mapping
void	removeAliasDomainMapping(String aliasDomain, String realDomain) Remove aliasDomain mapping
void	removeErrorMapping(String user, String domain, String error) Remove error mapping
void	removeMapping(String user, String domain, String mapping) Remove mapping
protected abstract void	removeMappingInternal(String user, String domain, String mapping) Remove mapping
void	removeRegexMapping(String user, String domain, String regex) Remove regex mapping
void	setDomainList(DomainList domainList)
void	setLog(org.slf4j.Logger logger) Sets the service log.
void	setMappingLimit(int mappingLimit) Set the mappingLimit
void	setRecursiveMapping(boolean recursive)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRecipientRewriteTable

public AbstractRecipientRewriteTable()

Method Detail

setDomainList

public void setDomainList(DomainList domainList)

configure

public void configure(org.apache.commons.configuration.HierarchicalConfiguration config)
               throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

Configurable.configure(HierarchicalConfiguration)

setLog

public void setLog(org.slf4j.Logger logger)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

logger - not null

doConfigure

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

Override to handle config

Parameters:

conf -

Throws:

org.apache.commons.configuration.ConfigurationException

setRecursiveMapping

public void setRecursiveMapping(boolean recursive)

setMappingLimit

public void setMappingLimit(int mappingLimit)
                     throws IllegalArgumentException

Set the mappingLimit

Parameters:

mappingLimit - the mappingLimit

Throws:

IllegalArgumentException - get thrown if mappingLimit smaller then 1 is used

getMappings

public Collection<String> getMappings(String user,
                             String domain)
                               throws RecipientRewriteTable.ErrorMappingException,
                                      RecipientRewriteTableException

Description copied from interface: RecipientRewriteTable

Return the mapped MailAddress for the given address. Return null if no matched mapping was found

Specified by:

getMappings in interface RecipientRewriteTable

Parameters:

user - the MailAddress

Returns:

the mapped mailAddress

Throws:

RecipientRewriteTable.ErrorMappingException - get thrown if an error mapping was found

RecipientRewriteTableException

See Also:

RecipientRewriteTable.getMappings(String, String)

getMappings

public Collection<String> getMappings(String user,
                             String domain,
                             int mappingLimit)
                               throws RecipientRewriteTable.ErrorMappingException,
                                      RecipientRewriteTableException

Throws:

RecipientRewriteTable.ErrorMappingException

RecipientRewriteTableException

addRegexMapping

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

Description copied from interface: RecipientRewriteTable

Add regex mapping

Specified by:

addRegexMapping in interface RecipientRewriteTable

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:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.addRegexMapping(java.lang.String, java.lang.String, java.lang.String)

removeRegexMapping

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

Description copied from interface: RecipientRewriteTable

Remove regex mapping

Specified by:

removeRegexMapping in interface RecipientRewriteTable

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:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.removeRegexMapping(java.lang.String, java.lang.String, java.lang.String)

addAddressMapping

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

Description copied from interface: RecipientRewriteTable

Add address mapping

Specified by:

addAddressMapping in interface RecipientRewriteTable

Parameters:

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

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

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.addAddressMapping(java.lang.String, java.lang.String, java.lang.String)

removeAddressMapping

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

Description copied from interface: RecipientRewriteTable

Remove address mapping

Specified by:

removeAddressMapping in interface RecipientRewriteTable

Parameters:

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

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

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.removeAddressMapping(java.lang.String, java.lang.String, java.lang.String)

addErrorMapping

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

Description copied from interface: RecipientRewriteTable

Add error mapping

Specified by:

addErrorMapping in interface RecipientRewriteTable

Parameters:

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

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

error - the regex.

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.addErrorMapping(java.lang.String, java.lang.String, java.lang.String)

removeErrorMapping

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

Description copied from interface: RecipientRewriteTable

Remove error mapping

Specified by:

removeErrorMapping in interface RecipientRewriteTable

Parameters:

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

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

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.removeErrorMapping(java.lang.String, java.lang.String, java.lang.String)

addMapping

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

Description copied from interface: RecipientRewriteTable

Add mapping

Specified by:

addMapping in interface RecipientRewriteTable

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:

RecipientRewriteTableException

See Also:

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

removeMapping

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

Description copied from interface: RecipientRewriteTable

Remove mapping

Specified by:

removeMapping in interface RecipientRewriteTable

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:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.removeMapping(java.lang.String, java.lang.String, java.lang.String)

getAllMappings

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

Description copied from interface: RecipientRewriteTable

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 RecipientRewriteTable

Returns:

Map which holds all mappings

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.getAllMappings()

getUserDomainMappings

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

Description copied from interface: RecipientRewriteTable

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

Specified by:

getUserDomainMappings in interface RecipientRewriteTable

Parameters:

user - the username

domain - the domain

Returns:

the collection which holds the mappings.

Throws:

RecipientRewriteTableException

See Also:

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

addAliasDomainMapping

public void addAliasDomainMapping(String aliasDomain,
                         String realDomain)
                           throws RecipientRewriteTableException

Description copied from interface: RecipientRewriteTable

Add aliasDomain mapping

Specified by:

addAliasDomainMapping in interface RecipientRewriteTable

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.addAliasDomainMapping(java.lang.String, java.lang.String)

removeAliasDomainMapping

public void removeAliasDomainMapping(String aliasDomain,
                            String realDomain)
                              throws RecipientRewriteTableException

Description copied from interface: RecipientRewriteTable

Remove aliasDomain mapping

Specified by:

removeAliasDomainMapping in interface RecipientRewriteTable

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException

See Also:

RecipientRewriteTable.removeAliasDomainMapping(java.lang.String, java.lang.String)

getLogger

protected org.slf4j.Logger getLogger()

addMappingInternal

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

Add new mapping

Parameters:

user - the user

domain - the domain

mapping - the mapping

Throws:

InvalidMappingException

RecipientRewriteTableException

removeMappingInternal

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

Remove mapping

Parameters:

user - the user

domain - the domain

mapping - the mapping

Throws:

InvalidMappingException

RecipientRewriteTableException

getUserDomainMappingsInternal

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

Return Collection of all mappings for the given username and domain

Parameters:

user - the user

domain - the domain

Returns:

Collection which hold the mappings

Throws:

RecipientRewriteTableException

getAllMappingsInternal

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

Return a Map which holds all Mappings

Returns:

Map

Throws:

RecipientRewriteTableException

mapAddressInternal

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

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.

Parameters:

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

Throws:

RecipientRewriteTableException

getFixedUser

protected String getFixedUser(String user)

Return user String for the given argument. If give value is null, return a wildcard.

Parameters:

user - the given user String

Returns:

fixedUser the fixed user String

Throws:

InvalidMappingException - get thrown on invalid argument

getFixedDomain

protected String getFixedDomain(String domain)

Fix the domain for the given argument. If give value is null, return a wildcard.

Parameters:

domain - the given domain String

Returns:

fixedDomain the fixed domain String

Throws:

InvalidMappingException - get thrown on invalid argument