Document AddressResolver and implementations

acogoluegnes · acogoluegnes · commit a5362a3cff12 · 2016-08-25T17:13:44.000+02:00
References rabbitmq#138
diff --git a/src/main/java/com/rabbitmq/client/AddressResolver.java b/src/main/java/com/rabbitmq/client/AddressResolver.java
@@ -8,6 +8,11 @@
  */
 public interface AddressResolver {
 
+    /**
+     * Get the potential {@link Address}es to connect to.
+     * @return candidate {@link Address}es
+     * @throws IOException if it encounters a problem
+     */
     List<Address> getAddresses() throws IOException;
 
 }
diff --git a/src/main/java/com/rabbitmq/client/DnsRecordIpAddressResolver.java b/src/main/java/com/rabbitmq/client/DnsRecordIpAddressResolver.java
@@ -7,7 +7,12 @@
 import java.util.List;
 
 /**
- *
+ * {@link AddressResolver} that resolves DNS record IPs.
+ * Uses {@link InetAddress} internally.
+ * The first returned address is used when automatic recovery is NOT enabled
+ * at the {@link ConnectionFactory} level.
+ * When automatic recovery is enabled, a random address will be picked up
+ * from the returned list of {@link Address}es.
  */
 public class DnsRecordIpAddressResolver implements AddressResolver {
 
@@ -40,6 +45,11 @@ public DnsRecordIpAddressResolver(Address address, boolean ssl) {
         this.ssl = ssl;
     }
 
+    /**
+     * Get the IP addresses from a DNS query
+     * @return candidate {@link Address}es
+     * @throws IOException if DNS resolution fails
+     */
     @Override
     public List<Address> getAddresses() throws IOException {
         String hostName = address.getHost();
