wrap exceptions

Author: stephen powis

src/main/java/com/darksci/pardot/api/Example.java

@@ -16,7 +16,7 @@ public class Example {
     /**
      * Example code.
      */
-    public static void example() throws IOException {
+    public static void example() {
         /*
          * Create a new configuration object with your Pardot credentials.
          *
@@ -59,7 +59,7 @@ public static void example() throws IOException {
     /**
      * Example code showing off Auto-closable.
      */
-    public static void autoCloseableExample() throws IOException {
+    public static void autoCloseableExample() {
         /*
          * Since PardotClient implements Autoclosable, you can also use the try-with-resources pattern.
          */

src/main/java/com/darksci/pardot/api/PardotClient.java

@@ -84,7 +84,7 @@ public PardotClient(final Configuration configuration, final RestClient restClie
         this.restClient = restClient;
     }
 
-    private <T> T submitRequest(final Request request, ResponseParser<T> responseParser) throws IOException {
+    private <T> T submitRequest(final Request request, ResponseParser<T> responseParser) {
         // Ugly hack,
         // avoid doing login check if we're doing a login request.
         if (!(request instanceof LoginRequest)) {
@@ -102,13 +102,21 @@ private <T> T submitRequest(final Request request, ResponseParser<T> responsePar
         if (restResponse.getHttpCode() >= 200 && restResponse.getHttpCode() < 300) {
             // High level check for error response
             if (restResponse.getResponseStr().contains("<rsp stat=\"fail\"")) {
-                // Parse error response
-                final ErrorResponse error = new ErrorResponseParser().parseResponse(restResponse.getResponseStr());
-
-                // throw exception
-                throw new InvalidRequestException(error.getMessage(), error.getCode());
+                try {
+                    // Parse error response
+                    final ErrorResponse error = new ErrorResponseParser().parseResponse(restResponse.getResponseStr());
+
+                    // throw exception
+                    throw new InvalidRequestException(error.getMessage(), error.getCode());
+                } catch (IOException exception) {
+                    throw new ParserException(exception.getMessage(), exception);
+                }
+            }
+            try {
+                return responseParser.parseResponse(restResponse.getResponseStr());
+            } catch (IOException exception) {
+                throw new ParserException(exception.getMessage(), exception);
             }
-            return responseParser.parseResponse(restResponse.getResponseStr());
         }
         // Otherwise throw an exception.
         throw new InvalidRequestException("Invalid http response code from server: " + restResponse.getHttpCode(), restResponse.getHttpCode());
@@ -144,7 +152,7 @@ RestClient getRestClient() {
      * If no existing API key is found, this will attempt to authenticate and
      * get a new API key.
      */
-    private void checkLogin() throws IOException {
+    private void checkLogin() {
         if (configuration.getApiKey() != null) {
             return;
         }
@@ -165,127 +173,115 @@ private void checkLogin() throws IOException {
      * Make login request
      * @return LoginResponse returned from server.
      */
-    public LoginResponse login(LoginRequest request) throws IOException {
+    public LoginResponse login(LoginRequest request) {
         return submitRequest(request, new LoginResponseParser());
     }
 
     /**
      * Make API request to read the account of the currently authenticated user.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Account accountRead(final AccountReadRequest request) throws IOException {
+    public Account accountRead(final AccountReadRequest request) {
         return submitRequest(request, new AccountReadResponseParser());
     }
 
     /**
      * Make API request to query one or more users.
      * @param request Request definition.
      * @return Parsed user query response.
-     * @throws IOException on parse errors.
      */
-    public UserQueryResponse.Result userQuery(final UserQueryRequest request) throws IOException {
+    public UserQueryResponse.Result userQuery(final UserQueryRequest request) {
         return submitRequest(request, new UserQueryResponseParser());
     }
 
     /**
      * Make API request to read the abilities of the currently authenticated user.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public UserAbilitiesResponse.Result userAbilities(final UserAbilitiesRequest request) throws IOException {
+    public UserAbilitiesResponse.Result userAbilities(final UserAbilitiesRequest request) {
         return submitRequest(request, new UserAbilitiesParser());
     }
 
     /**
      * Make API request to read a specific user.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public User userRead(final UserReadRequest request) throws IOException {
+    public User userRead(final UserReadRequest request) {
         return submitRequest(request, new UserReadResponseParser());
     }
 
     /**
      * Make API request to query for one or more campaigns.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public CampaignQueryResponse.Result campaignQuery(final CampaignQueryRequest request) throws IOException {
+    public CampaignQueryResponse.Result campaignQuery(final CampaignQueryRequest request) {
         return submitRequest(request, new CampaignQueryResponseParser());
     }
 
     /**
      * Make API request to read a specific campaign.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Campaign campaignRead(final CampaignReadRequest request) throws IOException {
+    public Campaign campaignRead(final CampaignReadRequest request) {
         return submitRequest(request, new CampaignReadResponseParser());
     }
 
     /**
      * Make API request to create a new Campaign.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Campaign campaignCreate(final CampaignCreateRequest request) throws IOException {
+    public Campaign campaignCreate(final CampaignCreateRequest request) {
         return submitRequest(request, new CampaignReadResponseParser());
     }
 
     /**
      * Make API request to update an existing Campaign.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Campaign campaignUpdate(final CampaignUpdateRequest request) throws IOException {
+    public Campaign campaignUpdate(final CampaignUpdateRequest request) {
         return submitRequest(request, new CampaignReadResponseParser());
     }
 
     /**
      * Make API request to read a specific Email.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Email emailRead(final EmailReadRequest request) throws IOException {
+    public Email emailRead(final EmailReadRequest request) {
         return submitRequest(request, new EmailReadResponseParser());
     }
 
     /**
      * Make API request to retrieve stats about a List Email Send.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public EmailStatsResponse.Stats emailStats(final EmailStatsRequest request) throws IOException {
+    public EmailStatsResponse.Stats emailStats(final EmailStatsRequest request) {
         return submitRequest(request, new EmailStatsResponseParser());
     }
 
     /**
      * Make API request to send a 1-to-1 prospect email.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Email emailSendOneToOne(final EmailSendOneToOneRequest request) throws IOException {
+    public Email emailSendOneToOne(final EmailSendOneToOneRequest request) {
         return submitRequest(request, new EmailReadResponseParser());
     }
 
     /**
      * Make API request to send a list email.
      * @param request Request definition.
      * @return Parsed api response.
-     * @throws IOException on parse errors.
      */
-    public Email emailSendList(final EmailSendListRequest request) throws IOException {
+    public Email emailSendList(final EmailSendListRequest request) {
         return submitRequest(request, new EmailReadResponseParser());
     }
 

src/main/java/com/darksci/pardot/api/ParserException.java

@@ -0,0 +1,28 @@
+package com.darksci.pardot.api;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Thrown when a parser implementation has an error.
+ */
+public class ParserException extends RuntimeException {
+    public ParserException() {
+    }
+
+    public ParserException(final String message) {
+        super(message);
+    }
+
+    public ParserException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+    public ParserException(final Throwable cause) {
+        super(cause);
+    }
+
+    public ParserException(final String message, final Throwable cause, final boolean enableSuppression, final boolean writableStackTrace) {
+        super(message, cause, enableSuppression, writableStackTrace);
+    }
+}

src/main/java/com/darksci/pardot/api/rest/RestClient.java

@@ -20,9 +20,9 @@ public interface RestClient {
      * Make a request against the Pardot API.
      * @param request The request to submit.
      * @return The response, in UTF-8 String format.
-     * @throws IOException if something goes wrong?
+     * @throws RestException When something goes wrong in an underlying implementation.
      */
-    RestResponse submitRequest(final Request request) throws IOException;
+    RestResponse submitRequest(final Request request) throws RestException;
 
     /**
      * Called to release any internally held resources.

src/main/java/com/darksci/pardot/api/rest/RestException.java

@@ -0,0 +1,28 @@
+package com.darksci.pardot.api.rest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Exception when an underlying error occurs in a RestClient implementation.
+ */
+public class RestException extends RuntimeException {
+    public RestException() {
+    }
+
+    public RestException(final String message) {
+        super(message);
+    }
+
+    public RestException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+    public RestException(final Throwable cause) {
+        super(cause);
+    }
+
+    public RestException(final String message, final Throwable cause, final boolean enableSuppression, final boolean writableStackTrace) {
+        super(message, cause, enableSuppression, writableStackTrace);
+    }
+}