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

All Superinterfaces:

VirtualUserTable

All Known Implementing Classes:

AbstractVirtualUserTable, DefaultVirtualUserTable, JDBCVirtualUserTable, XMLVirtualUserTable

public interface VirtualUserTableManagement
extends VirtualUserTable

Field Summary

static java.lang.String

ROLE The component role used by components implementing this service

Fields inherited from interface org.apache.james.api.vut.VirtualUserTable

ALIASDOMAIN_PREFIX, ERROR_PREFIX, REGEX_PREFIX

Method Summary

boolean	addAddressMapping(java.lang.String user, java.lang.String domain, java.lang.String address) Add address mapping
boolean	addAliasDomainMapping(java.lang.String aliasDomain, java.lang.String realDomain) Add aliasDomain mapping
boolean	addErrorMapping(java.lang.String user, java.lang.String domain, java.lang.String error) Add error mapping
boolean	addMapping(java.lang.String user, java.lang.String domain, java.lang.String mapping) Add mapping
boolean	addRegexMapping(java.lang.String user, java.lang.String domain, java.lang.String regex) Add regex mapping
java.util.Map	getAllMappings() Return a Map which holds all mappings.
java.util.Collection	getUserDomainMappings(java.lang.String user, java.lang.String domain) Return the explicit mapping stored for the given user and domain.
boolean	removeAddressMapping(java.lang.String user, java.lang.String domain, java.lang.String address) Remove address mapping
boolean	removeAliasDomainMapping(java.lang.String aliasDomain, java.lang.String realDomain) Remove aliasDomain mapping
boolean	removeErrorMapping(java.lang.String user, java.lang.String domain, java.lang.String error) Remove error mapping
boolean	removeMapping(java.lang.String user, java.lang.String domain, java.lang.String mapping) Remove mapping
boolean	removeRegexMapping(java.lang.String user, java.lang.String domain, java.lang.String regex) Remove regex mapping

Methods inherited from interface org.apache.james.api.vut.VirtualUserTable

getMappings

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 user,
                        java.lang.String domain,
                        java.lang.String regex)
                        throws InvalidMappingException

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.

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

removeRegexMapping

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

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.

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

addAddressMapping

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

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 -

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

removeAddressMapping

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

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 -

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

addErrorMapping

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

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.

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

removeErrorMapping

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

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 -

Returns:

true if successfully

Throws:

InvalidMappingException - get thrown if an invalid argument was given

getUserDomainMappings

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

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:

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

addMapping

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

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

Returns:

true if successfully

Throws:

InvalidMappingException

removeMapping

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

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

Returns:

true if successfully

Throws:

InvalidMappingException

getAllMappings

java.util.Map getAllMappings()

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

addAliasDomainMapping

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

Add aliasDomain mapping

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

InvalidMappingException

removeAliasDomainMapping

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

Remove aliasDomain mapping

Parameters:

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

InvalidMappingException