org.apache.james.rrt.api

Interface RecipientRewriteTable

All Known Subinterfaces:

JamesUsersRepository

All Known Implementing Classes:

AbstractJamesUsersRepository, AbstractJdbcUsersRepository, AbstractRecipientRewriteTable, DefaultUsersJdbcRepository, HBaseRecipientRewriteTable, JamesUsersJdbcRepository, JDBCRecipientRewriteTable, JPARecipientRewriteTable, UsersFileRepository, XMLRecipientRewriteTable

public interface RecipientRewriteTable

Interface which should be implemented of classes which map recipients.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RecipientRewriteTable.ErrorMappingException

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIASDOMAIN_PREFIX The prefix which is used for alias domain mappings
static String	ERROR_PREFIX The prefix which is used for error mappings
static String	REGEX_PREFIX The prefix which is used for regex mappings
static String	WILDCARD The wildcard used for alias domain mappings

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
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>	getMappings(String user, String domain) Return the mapped MailAddress for the given address.
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	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
void	removeRegexMapping(String user, String domain, String regex) Remove regex mapping

Field Detail

ERROR_PREFIX

static final String ERROR_PREFIX

The prefix which is used for error mappings

See Also:

Constant Field Values

REGEX_PREFIX

static final String REGEX_PREFIX

The prefix which is used for regex mappings

See Also:

Constant Field Values

ALIASDOMAIN_PREFIX

static final String ALIASDOMAIN_PREFIX

The prefix which is used for alias domain mappings

See Also:

Constant Field Values

WILDCARD

static final String WILDCARD

The wildcard used for alias domain mappings

See Also:

Constant Field Values

Method Detail

getMappings

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

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

Parameters:

user - the MailAddress

Returns:

the mapped mailAddress

Throws:

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

RecipientRewriteTableException

addRegexMapping

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

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:

RecipientRewriteTableException

removeRegexMapping

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

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:

RecipientRewriteTableException

addAddressMapping

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

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 -

Throws:

RecipientRewriteTableException

removeAddressMapping

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

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:

RecipientRewriteTableException

addErrorMapping

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

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 - the regex.

Throws:

RecipientRewriteTableException

removeErrorMapping

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

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:

RecipientRewriteTableException

getUserDomainMappings

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

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:

RecipientRewriteTableException

addMapping

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

Add mapping

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

removeMapping

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

Remove mapping

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

getAllMappings

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

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:

RecipientRewriteTableException

addAliasDomainMapping

void addAliasDomainMapping(String aliasDomain,
                         String realDomain)
                           throws RecipientRewriteTableException

Add aliasDomain mapping

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException

removeAliasDomainMapping

void removeAliasDomainMapping(String aliasDomain,
                            String realDomain)
                              throws RecipientRewriteTableException

Remove aliasDomain mapping

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Throws:

RecipientRewriteTableException