org.apache.james.api.vut
Interface VirtualUserTable

All Known Subinterfaces:

JamesUsersRepository, VirtualUserTableManagement

All Known Implementing Classes:

AbstractJdbcUsersRepository, AbstractUsersRepository, AbstractVirtualUserTable, DefaultUsersJdbcRepository, DefaultVirtualUserTable, JamesUsersJdbcRepository, JDBCVirtualUserTable, ListUsersJdbcRepository, LocalJamesUsersRepository, UsersFileRepository, UsersLDAPRepository, XMLVirtualUserTable

public interface VirtualUserTable

Interface which should be implemented of classes which map recipients

Field Summary

static java.lang.String	ALIASDOMAIN_PREFIX The prefix which is used for alias domain mappings
static java.lang.String	ERROR_PREFIX The prefix which is used for error mappings
static java.lang.String	REGEX_PREFIX The prefix which is used for regex mappings
static java.lang.String	ROLE The component role used by components implementing this service

Method Summary

java.util.Collection

getMappings(java.lang.String user, java.lang.String domain) Return the mapped MailAddress for the given address.

Field Detail

ROLE

static final java.lang.String ROLE

The component role used by components implementing this service

See Also:

Constant Field Values

ERROR_PREFIX

static final java.lang.String ERROR_PREFIX

The prefix which is used for error mappings

See Also:

Constant Field Values

REGEX_PREFIX

static final java.lang.String REGEX_PREFIX

The prefix which is used for regex mappings

See Also:

Constant Field Values

ALIASDOMAIN_PREFIX

static final java.lang.String ALIASDOMAIN_PREFIX

The prefix which is used for alias domain mappings

See Also:

Constant Field Values

Method Detail

getMappings

java.util.Collection getMappings(java.lang.String user,
                                 java.lang.String domain)
                                 throws ErrorMappingException

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:

ErrorMappingException - get thrown if an error mapping was found