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

All Known Implementing Classes:

VirtualUserTableManagement

public interface VirtualUserTableManagementMBean

Expose virtualusertable management functionality through JMX.

Method Summary

boolean	addAddressMapping(java.lang.String virtualUserTable, java.lang.String user, java.lang.String domain, java.lang.String address) Add address 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.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	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

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

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

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

Returns:

true if successfully

Throws:

VirtualUserTableManagementException - TODO

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

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

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

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

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

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