Add timeout to URL requests and report failures.

Author: Yaytay

src/main/java/uk/co/spudsoft/params4j/doclet/AsciiDocLinkMaps.java

@@ -21,10 +21,13 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.net.URL;
+import java.net.URLConnection;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import javax.tools.Diagnostic;
+import jdk.javadoc.doclet.Reporter;
 
 /**
  *
@@ -42,12 +45,12 @@ public void addConfiguredBaseUrl(String baseUrl) {
     configuredBaseUrls.add(baseUrl);
   }
 
-  public String getUrlForPackage(String packageName) {
+  public String getUrlForPackage(Reporter reporter, String packageName) {
     if (!configuredBaseUrls.isEmpty() && !packageListsRead) {
       packageListsRead = true;
       for (String cofiguredBaseUrl : configuredBaseUrls) {
-        readPackageList(baseUrlFromPackage, cofiguredBaseUrl);
-        readElementList(baseUrlFromPackage, cofiguredBaseUrl);
+        readPackageList(reporter, baseUrlFromPackage, cofiguredBaseUrl);
+        readElementList(reporter, baseUrlFromPackage, cofiguredBaseUrl);
       }
     }
     String baseUrl = baseUrlFromPackage.get(packageName);
@@ -58,35 +61,43 @@ public String getUrlForPackage(String packageName) {
     }
   }
 
-  public String getUrlForType(String packageName, String className) {
-    String packageUrl = getUrlForPackage(packageName);
+  public String getUrlForType(Reporter reporter, String packageName, String className) {
+    String packageUrl = getUrlForPackage(reporter, packageName);
     if (packageUrl == null) {
       return null;
     } else {
       return packageUrl + className + ".html";
     }
   }
 
-  static void readPackageList(Map<String, String> baseUrlFromPackage, String baseUrl) {
+  static void readPackageList(Reporter reporter, Map<String, String> baseUrlFromPackage, String baseUrl) {
+    String url = baseUrl.endsWith("/") ? baseUrl + "package-list" : baseUrl + "/package-list";
     try {
-      URL link = new URL(baseUrl.endsWith("/") ? baseUrl + "package-list" : baseUrl + "/package-list");
-      try (InputStream in = link.openStream()) {
+      URL link = new URL(url);
+      URLConnection con = link.openConnection();
+      con.setConnectTimeout(2000);
+      con.setReadTimeout(2000);
+      try (InputStream in = con.getInputStream()) {
         readPackageList(baseUrlFromPackage, in, baseUrl);
       }
     } catch (Throwable ex) {
-      // Silently fail, because failure is quite likely
+      reporter.print(Diagnostic.Kind.NOTE, "Failed to download from URL " + url + " (" + ex.toString() + ")");
     }
 
   }
 
-  static void readElementList(Map<String, String> baseUrlFromPackage, String baseUrl) {
+  static void readElementList(Reporter reporter, Map<String, String> baseUrlFromPackage, String baseUrl) {
+    String url = baseUrl.endsWith("/") ? baseUrl + "element-list" : baseUrl + "/element-list";
     try {
-      URL link = new URL(baseUrl.endsWith("/") ? baseUrl + "element-list" : baseUrl + "/element-list");
-      try (InputStream in = link.openStream()) {
+      URL link = new URL(url);
+      URLConnection con = link.openConnection();
+      con.setConnectTimeout(2000);
+      con.setReadTimeout(2000);
+      try (InputStream in = con.getInputStream()) {
         readPackageList(baseUrlFromPackage, in, baseUrl);
       }
     } catch (Throwable ex) {
-      // Silently fail, because failure is quite likely
+      reporter.print(Diagnostic.Kind.NOTE, "Failed to download from URL " + url + " (" + ex.toString() + ")");
     }
   }
 

src/main/java/uk/co/spudsoft/params4j/doclet/TypeWriter.java

@@ -54,7 +54,7 @@ public void writeReferenceTree(DocletEnvironment environment, DocTreePath curren
       TypeElement typeElement = (TypeElement) element.getEnclosingElement();
       ExecutableElement methodElement = (ExecutableElement) element;
 
-      String url = linkMaps.getUrlForType(TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
+      String url = linkMaps.getUrlForType(reporter, TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
       if (url == null) {
         if (includedClasses.contains(typeElement.getQualifiedName().toString())) {
           write("xref:");
@@ -69,7 +69,7 @@ public void writeReferenceTree(DocletEnvironment environment, DocTreePath curren
         }
       } else {
         write("link:");
-        write(linkMaps.getUrlForType(TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement)));
+        write(linkMaps.getUrlForType(reporter, TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement)));
         write(TypeWriter.getMethodAnchor(methodElement));
         write("[");
         // For method links javadoc removes leading packages and type parameters        
@@ -79,7 +79,7 @@ public void writeReferenceTree(DocletEnvironment environment, DocTreePath curren
     } else if (element instanceof TypeElement) {
       TypeElement typeElement = (TypeElement) element;
 
-      String url = linkMaps.getUrlForType(TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
+      String url = linkMaps.getUrlForType(reporter, TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
       if (url == null) {
         if (includedClasses.contains(typeElement.getQualifiedName().toString())) {
           write("xref:");
@@ -94,7 +94,7 @@ public void writeReferenceTree(DocletEnvironment environment, DocTreePath curren
         }
       } else {
         write("link:");
-        write(linkMaps.getUrlForType(TypeWriter.getPackage(element), TypeWriter.getClassName(element)));
+        write(linkMaps.getUrlForType(reporter, TypeWriter.getPackage(element), TypeWriter.getClassName(element)));
         write("[");
         write(refTree.getSignature());
         write("] ");
@@ -107,7 +107,7 @@ public void writeDeclaredType(DeclaredType declaredType) {
 
     TypeElement typeElement = (TypeElement) declaredType.asElement();    
 
-    String url = linkMaps.getUrlForType(TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
+    String url = linkMaps.getUrlForType(reporter, TypeWriter.getPackage(typeElement), TypeWriter.getClassName(typeElement));
 
     if (url != null) {
       write("link:");