org.apache.james.dnsservice.dnsjava

Class DNSJavaService

java.lang.Object

org.apache.james.dnsservice.dnsjava.DNSJavaService

All Implemented Interfaces:

DNSService, DNSServiceMBean, Configurable, LogEnabled

public class DNSJavaService
extends Object
implements DNSService, DNSServiceMBean, LogEnabled, Configurable

Provides DNS client functionality to services running inside James

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xbill.DNS.Cache	cache A TTL cache of results received from the DNS server.
protected org.xbill.DNS.Resolver	resolver A resolver instance used to retrieve DNS records.

Constructor Summary

Constructors

Constructor and Description
DNSJavaService()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clear the cache of the service
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Configure the object.
Collection<String>	findMXRecords(String hostname) Return a prioritized unmodifiable list of host handling mail for the domain.
Collection<String>	findTXTRecords(String hostname) Get a collection of DNS TXT Records
InetAddress[]	getAllByName(String host) Resolve the given hostname to an array of InetAddress based on the DNS Server.
InetAddress	getByName(String host) Resolve the given hostname to an InetAddress based on the DNS Server.
int	getCurrentCacheSize() Return the current size of the cache
String[]	getDNSServers() Return the list of DNS servers in use by this service
String	getHostName(InetAddress addr) Resolve the given InetAddress to an host name based on the DNS Server.
InetAddress	getLocalHost() Resolve the local hostname of the machine and returns it.
int	getMaximumCacheSize() Return the maximum cache size
org.xbill.DNS.Name[]	getSearchPaths() Return the list of DNS servers in use by this service
void	init()
protected org.xbill.DNS.Record[]	lookup(String namestr, int type, String typeDesc) Looks up DNS records of the specified type for the specified name.
protected org.xbill.DNS.Record[]	lookupNoException(String namestr, int type, String typeDesc)
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

Field Detail

resolver

protected org.xbill.DNS.Resolver resolver

A resolver instance used to retrieve DNS records. This is a reference to a third party library object.

cache

protected org.xbill.DNS.Cache cache

A TTL cache of results received from the DNS server. This is a reference to a third party library object.

Constructor Detail

DNSJavaService

public DNSJavaService()

Method Detail

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

See Also:

LogEnabled.setLog(org.slf4j.Logger)

configure

public void configure(org.apache.commons.configuration.HierarchicalConfiguration configuration)
               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(org.apache.commons.configuration.HierarchicalConfiguration)

init

@PostConstruct
public void init()
          throws Exception

Throws:

Exception

getDNSServers

public String[] getDNSServers()

Return the list of DNS servers in use by this service

Specified by:

getDNSServers in interface DNSServiceMBean

Returns:

an array of DNS server names

getSearchPaths

public org.xbill.DNS.Name[] getSearchPaths()

Return the list of DNS servers in use by this service

Returns:

an array of DNS server names

findMXRecords

public Collection<String> findMXRecords(String hostname)
                                 throws TemporaryResolutionException

Description copied from interface: DNSService

Return a prioritized unmodifiable list of host handling mail for the domain.

First lookup MX hosts, then MX hosts of the CNAME address, and if no server is found return the IP of the hostname

Specified by:

findMXRecords in interface DNSService

Parameters:

hostname - domain name to look up

Returns:

a unmodifiable list of handling servers corresponding to this mail domain name

Throws:

TemporaryResolutionException - get thrown on temporary problems

See Also:

DNSService.findMXRecords(String)

lookup

protected org.xbill.DNS.Record[] lookup(String namestr,
                            int type,
                            String typeDesc)
                                 throws TemporaryResolutionException

Looks up DNS records of the specified type for the specified name. This method is a public wrapper for the private implementation method

Parameters:

namestr - the name of the host to be looked up

type - the type of record desired

typeDesc - the description of the record type, for debugging purpose

Throws:

TemporaryResolutionException

lookupNoException

protected org.xbill.DNS.Record[] lookupNoException(String namestr,
                                       int type,
                                       String typeDesc)

getByName

public InetAddress getByName(String host)
                      throws UnknownHostException

Description copied from interface: DNSService

Resolve the given hostname to an InetAddress based on the DNS Server. It should not take into account the hostnames defined in the local host table

Specified by:

getByName in interface DNSService

Returns:

The resolved InetAddress or null if not resolved

Throws:

UnknownHostException

See Also:

DNSService.getByName(String)

getAllByName

public InetAddress[] getAllByName(String host)
                           throws UnknownHostException

Description copied from interface: DNSService

Resolve the given hostname to an array of InetAddress based on the DNS Server. It should not take into account the hostnames defined in the local host table

Specified by:

getAllByName in interface DNSService

Returns:

An array of InetAddress

Throws:

UnknownHostException

See Also:

DNSService.getAllByName(String)

findTXTRecords

public Collection<String> findTXTRecords(String hostname)

Description copied from interface: DNSService

Get a collection of DNS TXT Records

Specified by:

findTXTRecords in interface DNSService

Parameters:

hostname - The hostname to check

Returns:

collection of strings representing TXT record values

See Also:

DNSService.findTXTRecords(String)

getHostName

public String getHostName(InetAddress addr)

Description copied from interface: DNSService

Resolve the given InetAddress to an host name based on the DNS Server. It should not take into account the hostnames defined in the local host table

Specified by:

getHostName in interface DNSService

Returns:

The resolved hostname String or null if not resolved

See Also:

DNSService.getHostName(java.net.InetAddress)

getLocalHost

public InetAddress getLocalHost()
                         throws UnknownHostException

Description copied from interface: DNSService

Resolve the local hostname of the machine and returns it. It relies on the hostname defined in the local host table

Specified by:

getLocalHost in interface DNSService

Returns:

The local InetAddress of the machine.

Throws:

UnknownHostException

See Also:

DNSService.getLocalHost()

getMaximumCacheSize

public int getMaximumCacheSize()

Description copied from interface: DNSServiceMBean

Return the maximum cache size

Specified by:

getMaximumCacheSize in interface DNSServiceMBean

Returns:

maxCacheSize

See Also:

DNSServiceMBean.getMaximumCacheSize()

getCurrentCacheSize

public int getCurrentCacheSize()

Description copied from interface: DNSServiceMBean

Return the current size of the cache

Specified by:

getCurrentCacheSize in interface DNSServiceMBean

Returns:

currentCacheSize

See Also:

DNSServiceMBean.getCurrentCacheSize()

clearCache

public void clearCache()

Description copied from interface: DNSServiceMBean

Clear the cache of the service

Specified by:

clearCache in interface DNSServiceMBean

See Also:

DNSServiceMBean.clearCache()