org.apache.james.domainlist.api

Interface DomainList

All Known Implementing Classes:

AbstractDomainList, HBaseDomainList, JPADomainList, XMLDomainList

public interface DomainList

This interface should be implemented by services which offer domains for which email will accepted.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDomain(String domain) Add domain to the service
boolean	containsDomain(String domain) Return true if the domain exists in the service
String	getDefaultDomain() Return the default domain which will get used to deliver mail to if only the localpart was given on rcpt to.
String[]	getDomains() Return array of domains which should be used as localdomains.
void	removeDomain(String domain) Remove domain from the service

Method Detail

getDomains

String[] getDomains()
                    throws DomainListException

Return array of domains which should be used as localdomains. Return null if no domain is found.

Returns:

domains

Throws:

DomainListException

containsDomain

boolean containsDomain(String domain)
                       throws DomainListException

Return true if the domain exists in the service

Parameters:

domain - the domain

Returns:

true if the given domain exists in the service

Throws:

DomainListException

addDomain

void addDomain(String domain)
               throws DomainListException

Add domain to the service

Parameters:

domain - domain to add

Throws:

DomainListException - If the domain could not be added

removeDomain

void removeDomain(String domain)
                  throws DomainListException

Remove domain from the service

Parameters:

domain - domain to remove

Throws:

DomainListException - If the domain could not be removed

getDefaultDomain

String getDefaultDomain()
                        throws DomainListException

Return the default domain which will get used to deliver mail to if only the localpart was given on rcpt to.

Returns:

the defaultdomain

Throws:

DomainListException