You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2010/11/05 12:00:17 UTC

svn commit: r1031509 - /james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java

Author: eric
Date: Fri Nov  5 11:00:16 2010
New Revision: 1031509

URL: http://svn.apache.org/viewvc?rev=1031509&view=rev
Log:
Further document the DNSService api to reflect the asymetry toward InetAddress methods (JAMES-302)

Modified:
    james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java

Modified: james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java
URL: http://svn.apache.org/viewvc/james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java?rev=1031509&r1=1031508&r2=1031509&view=diff
==============================================================================
--- james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java (original)
+++ james/server/trunk/dnsservice-api/src/main/java/org/apache/james/dnsservice/api/DNSService.java Fri Nov  5 11:00:16 2010
@@ -76,22 +76,37 @@ public interface DNSService {
     Iterator<HostAddress> getSMTPHostAddresses(String domainName) throws TemporaryResolutionException;
     
     /**
-     * @see java.net.InetAddress#getAllByName(String)
+     * 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
+     * 
+     * @return An array of InetAddress
      */
     public InetAddress[] getAllByName(String host) throws UnknownHostException;
  
     /**
-     * @see java.net.InetAddress#getByName(String)
+     * 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
+     * 
+     * @return The resolved InetAddress or null if not resolved
      */
     public InetAddress getByName(String host) throws UnknownHostException;
 
     /**
-     * @see java.net.InetAddress#getLocalHost()
+     * Resolve the local hostname of the machine and returns it.
+     * It relies on the hostname defined in the local host table
+     * 
+     * @return The local InetAddress of the machine.
      */
     public InetAddress getLocalHost() throws UnknownHostException;
 
     /**
-     * @see org.xbill.DNS.Address#getHostName(InetAddress)
+     * 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
+     * 
+     * @return The resolved hostname String or null if not resolved
      */
     public String getHostName(InetAddress addr);
     



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org