org.apache.james.domainlist.lib

Class AbstractDomainList

java.lang.Object

org.apache.james.domainlist.lib.AbstractDomainList

All Implemented Interfaces:

DomainList, Configurable, LogEnabled

Direct Known Subclasses:

HBaseDomainList, JPADomainList, XMLDomainList

public abstract class AbstractDomainList
extends Object
implements DomainList, LogEnabled, Configurable

All implementations of the DomainList interface should extends this abstract class

Constructor Summary

Constructors

Constructor and Description
AbstractDomainList()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.commons.configuration.HierarchicalConfiguration config) Configure the object.
String	getDefaultDomain() Return the default domain which will get used to deliver mail to if only the localpart was given on rcpt to.
protected DNSService	getDNSServer() Return dnsServer
protected abstract List<String>	getDomainListInternal() Return domainList
String[]	getDomains() Return array of domains which should be used as localdomains.
protected org.slf4j.Logger	getLogger()
void	setAutoDetect(boolean autoDetect) Set to true to autodetect the hostname of the host on which james is running, and add this to the domain service Default is true
void	setAutoDetectIP(boolean autoDetectIP) Set to true to lookup the ipaddresses for each given domain and add these to the domain service Default is true
void	setDNSService(DNSService dns)
void	setLog(org.slf4j.Logger logger) Sets the service log.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.domainlist.api.DomainList

addDomain, containsDomain, removeDomain

Constructor Detail

AbstractDomainList

public AbstractDomainList()

Method Detail

setDNSService

public void setDNSService(DNSService dns)

setLog

public void setLog(org.slf4j.Logger logger)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

logger - not null

getLogger

protected org.slf4j.Logger getLogger()

configure

public void configure(org.apache.commons.configuration.HierarchicalConfiguration config)
               throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

Configurable.configure(HierarchicalConfiguration)

getDefaultDomain

public String getDefaultDomain()
                        throws DomainListException

Description copied from interface: DomainList

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

Specified by:

getDefaultDomain in interface DomainList

Returns:

the defaultdomain

Throws:

DomainListException

See Also:

DomainList.getDefaultDomain()

getDomains

public String[] getDomains()
                    throws DomainListException

Description copied from interface: DomainList

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

Specified by:

getDomains in interface DomainList

Returns:

domains

Throws:

DomainListException

See Also:

DomainList.getDomains()

setAutoDetect

public void setAutoDetect(boolean autoDetect)

Set to true to autodetect the hostname of the host on which james is running, and add this to the domain service Default is true

Parameters:

autoDetect - set to false for disable

setAutoDetectIP

public void setAutoDetectIP(boolean autoDetectIP)

Set to true to lookup the ipaddresses for each given domain and add these to the domain service Default is true

Parameters:

autoDetectIP - set to false for disable

getDNSServer

protected DNSService getDNSServer()

Return dnsServer

Returns:

dns

getDomainListInternal

protected abstract List<String> getDomainListInternal()
                                               throws DomainListException

Return domainList

Returns:

List

Throws:

DomainListException