Show better error message when SharePoint is down or adaptor is wrongly configured
b/15116813
Code Review : https://codereview.appspot.com/106090043/
diff --git a/src/com/google/enterprise/adaptor/sharepoint/SharePointAdaptor.java b/src/com/google/enterprise/adaptor/sharepoint/SharePointAdaptor.java
index dfb3af3..cb5c1c7 100644
--- a/src/com/google/enterprise/adaptor/sharepoint/SharePointAdaptor.java
+++ b/src/com/google/enterprise/adaptor/sharepoint/SharePointAdaptor.java
@@ -41,6 +41,7 @@
import com.google.enterprise.adaptor.sharepoint.SamlAuthenticationHandler.SamlHandshakeManager;
import com.google.enterprise.adaptor.sharepoint.SiteDataClient.CursorPaginator;
import com.google.enterprise.adaptor.sharepoint.SiteDataClient.Paginator;
+import com.google.enterprise.adaptor.sharepoint.SiteDataClient.WebServiceIOException;
import com.google.enterprise.adaptor.sharepoint.SiteDataClient.XmlProcessingException;
import com.microsoft.schemas.sharepoint.soap.ContentDatabase;
@@ -93,6 +94,7 @@
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.PasswordAuthentication;
+import java.net.SocketTimeoutException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
@@ -552,26 +554,33 @@
try {
log.log(Level.INFO, "Using {0} authentication.", authenticationType);
authenticationHandler.start();
- } catch (IOException ex) {
- if (ex instanceof UnknownHostException) {
- // This may be due to DNS issue or transiant network error.
- // Just rethrow excption and allow adaptor to retry.
- throw ex;
+ } catch (WebServiceException ex) {
+ if (ex.getCause() instanceof UnknownHostException) {
+ // This may be due to DNS issue or transiant network error.
+ // Just rethrow excption and allow adaptor to retry.
+ throw new IOException(String.format(
+ "Cannot find SharePoint server \"%s\" -- please make sure it is "
+ + "specified properly.", virtualServer), ex);
}
-
- if (ex instanceof ConnectException) {
+ if (ex.getCause() instanceof ConnectException
+ || ex.getCause() instanceof SocketTimeoutException ) {
// SharePoint might be down. Just rethrow exception and allow adaptor to
- // retry.
- throw ex;
+ // retry. We get ConnectException when IIS / web site is down and
+ // SocketTimeOutException when SharePoint server does not respond in
+ // timely manner.
+ throw new IOException(String.format(
+ "Unable to connect to SharePoint server \"%s\" -- please make "
+ + "sure it is specified properly and is available.",
+ virtualServer), ex);
}
String adfsWarning = "ADFS".equals(authenticationType)
? " Also verify if stsendpoint and stsrealm is specified correctly "
+ "and ADFS environment is available." : "";
String warning = String.format(
- "Failed to start adaptor using %s authentication."
+ "Failed to initialize adaptor using %s authentication."
+ " Please verify adaptor configuration for SharePoint url,"
+ " username and password.%s", authenticationType, adfsWarning);
- throw new StartupException(warning, ex);
+ throw new IOException(warning, ex);
}
try {
@@ -613,7 +622,7 @@
ntlmAuthenticator.addPermitForHost(spUrlToUri(siteString).toURL());
}
}
- } catch (WebServiceException ex) {
+ } catch (WebServiceIOException ex) {
String warning;
Throwable cause = ex.getCause();
if (cause instanceof UnknownHostException) {
diff --git a/src/com/google/enterprise/adaptor/sharepoint/SharePointUserProfileAdaptor.java b/src/com/google/enterprise/adaptor/sharepoint/SharePointUserProfileAdaptor.java
index 31034b2..5101a0d 100644
--- a/src/com/google/enterprise/adaptor/sharepoint/SharePointUserProfileAdaptor.java
+++ b/src/com/google/enterprise/adaptor/sharepoint/SharePointUserProfileAdaptor.java
@@ -60,6 +60,7 @@
import java.net.Authenticator;
import java.net.ConnectException;
import java.net.PasswordAuthentication;
+import java.net.SocketTimeoutException;
import java.net.URI;
import java.net.URL;
import java.net.URLEncoder;
@@ -307,26 +308,33 @@
try {
log.log(Level.INFO, "Using {0} authentication.", authenticationType);
authenticationHandler.start();
- } catch (IOException ex) {
- if (ex instanceof UnknownHostException) {
- // This may be due to DNS issue or transiant network error.
- // Just rethrow excption and allow adaptor to retry.
- throw ex;
+ } catch (WebServiceException ex) {
+ if (ex.getCause() instanceof UnknownHostException) {
+ // This may be due to DNS issue or transiant network error.
+ // Just rethrow excption and allow adaptor to retry.
+ throw new IOException(String.format(
+ "Cannot find SharePoint server \"%s\" -- please make sure it is "
+ + "specified properly.", virtualServer), ex);
}
-
- if (ex instanceof ConnectException) {
+ if (ex.getCause() instanceof ConnectException
+ || ex.getCause() instanceof SocketTimeoutException ) {
// SharePoint might be down. Just rethrow exception and allow adaptor to
- // retry.
- throw ex;
+ // retry. We get ConnectException when IIS / web site is down and
+ // SocketTimeOutException when SharePoint server does not respond in
+ // timely manner.
+ throw new IOException(String.format(
+ "Unable to connect to SharePoint server \"%s\" -- please make "
+ + "sure it is specified properly and is available.",
+ virtualServer), ex);
}
String adfsWarning = "ADFS".equals(authenticationType)
? " Also verify if stsendpoint and stsrealm is specified correctly "
+ "and ADFS environment is available." : "";
String warning = String.format(
- "Failed to start adaptor using %s authentication."
+ "Failed to initialize adaptor using %s authentication."
+ " Please verify adaptor configuration for SharePoint url,"
+ " username and password.%s", authenticationType, adfsWarning);
- throw new StartupException(warning, ex);
+ throw new IOException(warning, ex);
}
log.log(Level.FINEST, "Initializing User profile Service Client for {0}",
virtualServer + USER_PROFILE_SERVICE_ENDPOINT);
