Merge pull request #44 from cloudconvert/issue-41-error-management

Add CloudConvertServerException and CloudConvertClientException

Author: josiasmontag

README.md

@@ -11,7 +11,7 @@ Add the following dependency to your pom.xml:
 <dependency>
     <groupId>com.cloudconvert</groupId>
     <artifactId>cloudconvert-java</artifactId>
-    <version>1.0.7</version>
+    <version>1.1.0</version>
 </dependency>
 ```
 

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>com.cloudconvert</groupId>
     <artifactId>cloudconvert-java</artifactId>
-    <version>1.0.7</version>
+    <version>1.1.0</version>
 
     <name>cloudconvert-java</name>
     <description>CloudConvert is an online file converter API - more than 200 different audio, video, document, ebook, archive, image, spreadsheet and presentation formats supported.</description>
@@ -48,8 +48,6 @@
         </repository>
     </distributionManagement>
 
-
-
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>1.8</maven.compiler.source>

src/main/java/com/cloudconvert/client/AsyncCloudConvertClient.java

@@ -13,7 +13,22 @@
 import com.cloudconvert.dto.result.AsyncResult;
 import com.cloudconvert.executor.AsyncRequestExecutor;
 import com.cloudconvert.extractor.ResultExtractor;
-import com.cloudconvert.resource.async.*;
+import com.cloudconvert.resource.async.AsyncCaptureWebsitesResource;
+import com.cloudconvert.resource.async.AsyncConvertFilesResource;
+import com.cloudconvert.resource.async.AsyncCreateArchivesResource;
+import com.cloudconvert.resource.async.AsyncCreateThumbnailsResource;
+import com.cloudconvert.resource.async.AsyncExecuteCommandsResource;
+import com.cloudconvert.resource.async.AsyncExportFilesResource;
+import com.cloudconvert.resource.async.AsyncFilesResource;
+import com.cloudconvert.resource.async.AsyncGetMetadataResource;
+import com.cloudconvert.resource.async.AsyncImportFilesResource;
+import com.cloudconvert.resource.async.AsyncJobsResource;
+import com.cloudconvert.resource.async.AsyncMergeFilesResource;
+import com.cloudconvert.resource.async.AsyncOptimizeFilesResource;
+import com.cloudconvert.resource.async.AsyncTasksResource;
+import com.cloudconvert.resource.async.AsyncUsersResource;
+import com.cloudconvert.resource.async.AsyncWebhookResource;
+import com.cloudconvert.resource.async.AsyncWriteMetadataResource;
 
 import java.io.IOException;
 import java.io.InputStream;

src/main/java/com/cloudconvert/client/CloudConvertClient.java

@@ -13,7 +13,22 @@
 import com.cloudconvert.dto.result.Result;
 import com.cloudconvert.executor.RequestExecutor;
 import com.cloudconvert.extractor.ResultExtractor;
-import com.cloudconvert.resource.sync.*;
+import com.cloudconvert.resource.sync.CaptureWebsitesResource;
+import com.cloudconvert.resource.sync.ConvertFilesResource;
+import com.cloudconvert.resource.sync.CreateArchivesResource;
+import com.cloudconvert.resource.sync.CreateThumbnailsResource;
+import com.cloudconvert.resource.sync.ExecuteCommandsResource;
+import com.cloudconvert.resource.sync.ExportFilesResource;
+import com.cloudconvert.resource.sync.FilesResource;
+import com.cloudconvert.resource.sync.GetMetadataResource;
+import com.cloudconvert.resource.sync.ImportFilesResource;
+import com.cloudconvert.resource.sync.JobsResource;
+import com.cloudconvert.resource.sync.MergeFilesResource;
+import com.cloudconvert.resource.sync.OptimizeFilesResource;
+import com.cloudconvert.resource.sync.TasksResource;
+import com.cloudconvert.resource.sync.UsersResource;
+import com.cloudconvert.resource.sync.WebhookResource;
+import com.cloudconvert.resource.sync.WriteMetadataResource;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -53,7 +68,7 @@ public CloudConvertClient(
                 new ExecuteCommandsResource(settingsProvider, objectMapperProvider, requestExecutor),
                 new CreateThumbnailsResource(settingsProvider, objectMapperProvider, requestExecutor),
                 new GetMetadataResource(settingsProvider, objectMapperProvider, requestExecutor),
-                    new WriteMetadataResource(settingsProvider, objectMapperProvider, requestExecutor)
+                new WriteMetadataResource(settingsProvider, objectMapperProvider, requestExecutor)
             ),
             new JobsResource(settingsProvider, objectMapperProvider, requestExecutor)
         );

src/main/java/com/cloudconvert/dto/response/ErrorResponse.java

@@ -0,0 +1,23 @@
+package com.cloudconvert.dto.response;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+import javax.annotation.Nullable;
+import java.util.Map;
+
+@Getter
+@Setter
+@Accessors(chain = true)
+@ToString
+public class ErrorResponse {
+
+    private String code;
+
+    private String message;
+
+    @Nullable
+    private Map<String, Object> errors;
+}

src/main/java/com/cloudconvert/dto/result/AsyncResult.java

@@ -1,15 +1,18 @@
 package com.cloudconvert.dto.result;
 
+import com.cloudconvert.exception.CloudConvertClientException;
+import com.cloudconvert.exception.CloudConvertServerException;
+
 import java.io.IOException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 
 public abstract class AsyncResult<T> extends AbstractResult<T> {
 
-    public abstract Result<T> get() throws InterruptedException, ExecutionException, IOException;
+    public abstract Result<T> get() throws InterruptedException, ExecutionException, IOException, CloudConvertClientException, CloudConvertServerException;
 
     public abstract Result<T> get(
         final long timeout, final TimeUnit timeUnit
-    ) throws InterruptedException, ExecutionException, TimeoutException, IOException;
+    ) throws InterruptedException, ExecutionException, TimeoutException, IOException, CloudConvertClientException, CloudConvertServerException;
 }

src/main/java/com/cloudconvert/dto/result/FutureAsyncResult.java

@@ -1,5 +1,7 @@
 package com.cloudconvert.dto.result;
 
+import com.cloudconvert.exception.CloudConvertClientException;
+import com.cloudconvert.exception.CloudConvertServerException;
 import com.cloudconvert.extractor.ResultExtractor;
 import com.fasterxml.jackson.core.type.TypeReference;
 import lombok.Builder;
@@ -24,20 +26,22 @@ public class FutureAsyncResult<T> extends AsyncResult<T> {
     @Nullable
     private Result<T> result;
 
-    public Result<T> get() throws InterruptedException, ExecutionException, IOException {
+    public Result<T> get() throws InterruptedException, ExecutionException, IOException, CloudConvertClientException, CloudConvertServerException {
         return extractResult(future.get());
     }
 
     public Result<T> get(
         final long timeout, final TimeUnit timeUnit
-    ) throws InterruptedException, ExecutionException, TimeoutException, IOException {
+    ) throws InterruptedException, ExecutionException, TimeoutException, IOException, CloudConvertClientException, CloudConvertServerException {
         return extractResult(future.get(timeout, timeUnit));
     }
 
     /**
      * This method should be synchronized in order to prevent unexpected behavior if multiple threads tries to access an input stream
      */
-    private synchronized Result<T> extractResult(final HttpResponse httpResponse) throws IOException {
+    private synchronized Result<T> extractResult(
+        final HttpResponse httpResponse
+    ) throws IOException, CloudConvertClientException, CloudConvertServerException {
         // Cache result, in case user will try to call get() multiple times
         if (result == null) {
             result = resultExtractor.extract(httpResponse, typeReference);

src/main/java/com/cloudconvert/dto/result/Result.java

@@ -10,14 +10,11 @@
 public class Result<T> extends AbstractResult<T> {
 
     @Getter
-    private int status;
+    private Status status;
 
     @Getter
     private Map<String, String> headers;
 
-    @Getter
-    private String message;
-
     @Getter
     @Nullable
     private T body;

src/main/java/com/cloudconvert/dto/result/Status.java

@@ -0,0 +1,34 @@
+package com.cloudconvert.dto.result;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Builder
+public class Status {
+
+    @Getter
+    private int code;
+
+    @Getter
+    private String reason;
+
+    public boolean isInformational() {
+        return 100 <= code && code <= 199;
+    }
+
+    public boolean isSuccessful() {
+        return 200 <= code && code <= 299;
+    }
+
+    public boolean isRedirection() {
+        return 300 <= code && code <= 399;
+    }
+
+    public boolean isClientError() {
+        return 400 <= code && code <= 499;
+    }
+
+    public boolean isServerError() {
+        return 500 <= code && code <= 599;
+    }
+}

src/main/java/com/cloudconvert/exception/CloudConvertClientException.java

@@ -0,0 +1,23 @@
+package com.cloudconvert.exception;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.dto.result.Status;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Map;
+
+public class CloudConvertClientException extends CloudConvertException {
+
+    public CloudConvertClientException(
+        final Status status, final Map<String, String> headers, final InputStream inputStream
+    ) throws IOException {
+        this(status, headers, inputStream, new ObjectMapperProvider());
+    }
+
+    public CloudConvertClientException(
+        final Status status, final Map<String, String> headers, final InputStream inputStream, final ObjectMapperProvider objectMapperProvider
+    ) throws IOException {
+        super(status, headers, inputStream, objectMapperProvider);
+    }
+}