org.apache.james.api.vut.management
Interface VirtualUserTableManagementService

All Known Implementing Classes:

VirtualUserTableManagement

public interface VirtualUserTableManagementService

Field Summary

static java.lang.String

ROLE The component role used by components implementing this service

Method Summary

boolean	addAddressMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String address) Add address mapping
boolean	addAliasDomainMapping(java.lang.String virtualUserTable, java.lang.String aliasDomain, java.lang.String realDomain) Add aliasDomain mapping
boolean	addErrorMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String error) Add error mapping
boolean	addMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String mapping) Try to identify the right method based on the prefix of the mapping and add it.
boolean	addRegexMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String regex) Add regex mapping
java.util.Map	getAllMappings(java.lang.String virtualUserTable) Return a Map which holds all mappings
java.util.Collection	getUserDomainMappings(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain) Return the explicit mapping stored for the given user and domain.
boolean	removeAddressMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String address) Remove address mapping
boolean	removeAliasDomainMapping(java.lang.String virtualUserTable, java.lang.String aliasDomain, java.lang.String realDomain) Remove aliasDomain mapping
boolean	removeErrorMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String error) Remove error mapping
boolean	removeMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String mapping) Try to identify the right method based on the prefix of the mapping and remove it.
boolean	removeRegexMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String regex) Remove regex mapping

Field Detail

ROLE

static final java.lang.String ROLE

The component role used by components implementing this service

See Also:

Constant Field Values

Method Detail

addRegexMapping

boolean addRegexMapping(java.lang.String virtualUserTable,
                        java.lang.String user,
                        java.lang.String domain,
                        java.lang.String regex)
                        throws VirtualUserTableManagementException

Add regex mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

regex - the regex.

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

removeRegexMapping

boolean removeRegexMapping(java.lang.String virtualUserTable,
                           java.lang.String user,
                           java.lang.String domain,
                           java.lang.String regex)
                           throws VirtualUserTableManagementException

Remove regex mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

regex - the regex.

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

addAddressMapping

boolean addAddressMapping(java.lang.String virtualUserTable,
                          java.lang.String user,
                          java.lang.String domain,
                          java.lang.String address)
                          throws VirtualUserTableManagementException

Add address mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

address -

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

removeAddressMapping

boolean removeAddressMapping(java.lang.String virtualUserTable,
                             java.lang.String user,
                             java.lang.String domain,
                             java.lang.String address)
                             throws VirtualUserTableManagementException

Remove address mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

address -

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

addErrorMapping

boolean addErrorMapping(java.lang.String virtualUserTable,
                        java.lang.String user,
                        java.lang.String domain,
                        java.lang.String error)
                        throws VirtualUserTableManagementException

Add error mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

error -

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

removeErrorMapping

boolean removeErrorMapping(java.lang.String virtualUserTable,
                           java.lang.String user,
                           java.lang.String domain,
                           java.lang.String error)
                           throws VirtualUserTableManagementException

Remove error mapping

Parameters:

virtualUserTable - The virtualUserTable

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

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

error -

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

getUserDomainMappings

java.util.Collection getUserDomainMappings(java.lang.String virtualUserTable,
                                           java.lang.String user,
                                           java.lang.String domain)
                                           throws VirtualUserTableManagementException

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

Parameters:

virtualUserTable - The virtualUserTable

user - the username

domain - the domain

Returns:

the collection which holds the mappings.

Throws:

VirtualUserTableManagementException - get thrown if an invalid use or domain was given

addMapping

boolean addMapping(java.lang.String virtualUserTable,
                   java.lang.String user,
                   java.lang.String domain,
                   java.lang.String mapping)
                   throws VirtualUserTableManagementException

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

Parameters:

virtualUserTable - The virtualUserTable

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

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

mapping - the mapping.

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

removeMapping

boolean removeMapping(java.lang.String virtualUserTable,
                      java.lang.String user,
                      java.lang.String domain,
                      java.lang.String mapping)
                      throws VirtualUserTableManagementException

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

Parameters:

virtualUserTable - The virtualUserTable

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

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

mapping - the mapping.

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - get thrown if an invalid argument was given

getAllMappings

java.util.Map getAllMappings(java.lang.String virtualUserTable)
                             throws VirtualUserTableManagementException

Return a Map which holds all mappings

Parameters:

virtualUserTable - The virtualUserTable

Returns:

Map which holds all mappings

Throws:

VirtualUserTableManagementException

addAliasDomainMapping

boolean addAliasDomainMapping(java.lang.String virtualUserTable,
                              java.lang.String aliasDomain,
                              java.lang.String realDomain)
                              throws VirtualUserTableManagementException

Add aliasDomain mapping

Parameters:

virtualUserTable - The virtualUserTable

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

InvalidMappingException

VirtualUserTableManagementException

removeAliasDomainMapping

boolean removeAliasDomainMapping(java.lang.String virtualUserTable,
                                 java.lang.String aliasDomain,
                                 java.lang.String realDomain)
                                 throws VirtualUserTableManagementException

Remove aliasDomain mapping

Parameters:

virtualUserTable - The virtualUserTable

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

InvalidMappingException

VirtualUserTableManagementException