commit 6451260c9368fe070ba5b9b9a01202cf45d926e7
author Brett Johnson <Brett.Michael.Johnson@gmail.com> Thu Jun 26 17:27:15 2014 -0700
committer Brett Johnson <Brett.Michael.Johnson@gmail.com> Fri Jun 27 18:30:17 2014 -0700
tree fed5d6da4f386d51a6ed933601dcfba0bda10a53
parent a15692a8fb5301fb9a93b0cd356258b260640c39

Fix b/15187210: Better log message when dashboard login fails

This change will include the GSA admin URL in the log messages when
failing to connect the the GSA admin port for authentication.
Better, more descriptive log messages were crafted for common
GSA admin communication issues that can be fixed with proper
configuration of gsa.hostname, gsa.admin.hostname, and SSL certs.

This only fixes messages logged in the log file, and not the error
message that is displayed on the dashboard login page.

Code Review: http://codereview.appspot.com/110200046

src/com/google/enterprise/adaptor/AdministratorSecurityHandler.java

diff --git a/src/com/google/enterprise/adaptor/AdministratorSecurityHandler.java b/src/com/google/enterprise/adaptor/AdministratorSecurityHandler.java
index dc3e861..a4aa01b 100644
--- a/src/com/google/enterprise/adaptor/AdministratorSecurityHandler.java
+++ b/src/com/google/enterprise/adaptor/AdministratorSecurityHandler.java
@@ -24,11 +24,14 @@
 import java.io.InputStream;
 import java.net.ConnectException;
 import java.net.HttpURLConnection;
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.net.URLDecoder;
 import java.net.UnknownHostException;
 import java.nio.charset.Charset;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import javax.net.ssl.SSLException;
 
 /**
  * Require GSA-Administrator authentication before allowing requests.
@@ -197,15 +200,40 @@
       try {
         new GsaClient(protocol, gsaHostname, port, username, password);
       } catch (AuthenticationException e) {
-        log.log(Level.FINE, "AuthenticationException", e);
         if (e.getCause() instanceof ConnectException) {
+          log.log(Level.WARNING, "Failed to connect to the GSA Administrative "
+              + "Console at " + adminUrl() + " . If the GSA is online and the "
+              + "GSA's dedicated administrative network interface is enabled, "
+              + "please verify that the gsa.admin.hostname property is "
+              + "properly configured.", e);
           return AuthzStatus.INDETERMINATE;
         } else if (e.getCause() instanceof UnknownHostException) {
+          log.log(Level.WARNING, "Failed to locate the GSA Administrative "
+              + "Console at " + adminUrl() + " . Please verify that the "
+              + "gsa.hostname and/or the gsa.admin.hostname configuration "
+              + "properties are correct.", e);
           return AuthzStatus.INDETERMINATE;
+        } else if (e.getCause() instanceof SSLException && useHttps) {
+          log.log(Level.WARNING, "Failed to connect to the GSA Administrative "
+              + "Console at " + adminUrl() + " . Please verify that the your "
+              + "SSL Certificates are properly configured for secure "
+              + "communication with the GSA.", e);
+        } else {
+          log.log(Level.FINE, "AuthenticationException", e);
         }
         return AuthzStatus.DENY;
       }
       return AuthzStatus.PERMIT;
     }
+
+    private String adminUrl() {
+      try {
+        String protocol = useHttps ? "https" : "http";
+        int port = useHttps ? 8443 : 8000;
+        return new URL(protocol, gsaHostname, port, "").toString();
+      } catch (MalformedURLException e) {
+        return e.toString();
+      }
+    }
   }
 }