org.apache.james.impl.vut
Class VirtualUserTableManagement

java.lang.Object
  org.apache.james.impl.vut.VirtualUserTableManagement

All Implemented Interfaces:

org.apache.avalon.framework.service.Serviceable, VirtualUserTableManagementMBean, VirtualUserTableManagementService

public class VirtualUserTableManagement
extends java.lang.Object
implements org.apache.avalon.framework.service.Serviceable, VirtualUserTableManagementService, VirtualUserTableManagementMBean

Management for VirtualUserTables

Field Summary

Fields inherited from interface org.apache.james.api.vut.management.VirtualUserTableManagementService

ROLE

Constructor Summary

VirtualUserTableManagement()

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
void	service(org.apache.avalon.framework.service.ServiceManager arg0)
void	setDefaultVirtualUserTable(VirtualUserTableManagement defaultVUT)
void	setVirtualUserTableStore(VirtualUserTableStore store)

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualUserTableManagement

public VirtualUserTableManagement()

Method Detail

service

public void service(org.apache.avalon.framework.service.ServiceManager arg0)
             throws org.apache.avalon.framework.service.ServiceException

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Throws:

org.apache.avalon.framework.service.ServiceException

See Also:

Serviceable.service(org.apache.avalon.framework.service.ServiceManager)

setVirtualUserTableStore

public void setVirtualUserTableStore(VirtualUserTableStore store)

setDefaultVirtualUserTable

public void setDefaultVirtualUserTable(VirtualUserTableManagement defaultVUT)

addAddressMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Add address mapping

Specified by:

addAddressMapping in interface VirtualUserTableManagementMBean

Specified by:

addAddressMapping in interface VirtualUserTableManagementService

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

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - TODO

See Also:

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

addErrorMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Add error mapping

Specified by:

addErrorMapping in interface VirtualUserTableManagementMBean

Specified by:

addErrorMapping in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

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

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

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - TODO

See Also:

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

addRegexMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Add regex mapping

Specified by:

addRegexMapping in interface VirtualUserTableManagementMBean

Specified by:

addRegexMapping in interface VirtualUserTableManagementService

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 - TODO

See Also:

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

getUserDomainMappings

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

Description copied from interface: VirtualUserTableManagementMBean

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

Specified by:

getUserDomainMappings in interface VirtualUserTableManagementMBean

Specified by:

getUserDomainMappings in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

user - the username

domain - the domain

Returns:

the collection which holds the mappings.

Throws:

VirtualUserTableManagementException - TODO

See Also:

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

removeAddressMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Remove address mapping

Specified by:

removeAddressMapping in interface VirtualUserTableManagementMBean

Specified by:

removeAddressMapping in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

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

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

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - TODO

See Also:

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

removeErrorMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Remove error mapping

Specified by:

removeErrorMapping in interface VirtualUserTableManagementMBean

Specified by:

removeErrorMapping in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

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

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

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - TODO

See Also:

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

removeRegexMapping

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

Description copied from interface: VirtualUserTableManagementMBean

Remove regex mapping

Specified by:

removeRegexMapping in interface VirtualUserTableManagementMBean

Specified by:

removeRegexMapping in interface VirtualUserTableManagementService

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 - TODO

See Also:

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

addMapping

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

Description copied from interface: VirtualUserTableManagementMBean

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

Specified by:

addMapping in interface VirtualUserTableManagementMBean

Specified by:

addMapping in interface VirtualUserTableManagementService

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 - TODO

See Also:

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

removeMapping

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

Description copied from interface: VirtualUserTableManagementMBean

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

Specified by:

removeMapping in interface VirtualUserTableManagementMBean

Specified by:

removeMapping in interface VirtualUserTableManagementService

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 - TODO

See Also:

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

getAllMappings

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

Description copied from interface: VirtualUserTableManagementService

Return a Map which holds all mappings

Specified by:

getAllMappings in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

Returns:

Map which holds all mappings

Throws:

VirtualUserTableManagementException

See Also:

VirtualUserTableManagementService.getAllMappings(java.lang.String)

addAliasDomainMapping

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

Description copied from interface: VirtualUserTableManagementService

Add aliasDomain mapping

Specified by:

addAliasDomainMapping in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

VirtualUserTableManagementException

See Also:

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

removeAliasDomainMapping

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

Description copied from interface: VirtualUserTableManagementService

Remove aliasDomain mapping

Specified by:

removeAliasDomainMapping in interface VirtualUserTableManagementService

Parameters:

virtualUserTable - The virtualUserTable

aliasDomain - the aliasdomain which should be mapped to the realDomain

realDomain - the realDomain

Returns:

true if successfilly

Throws:

VirtualUserTableManagementException

See Also:

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