Add Streaming Rest Call - returning the response input stream without…

… the wrappers
jfrog · Sep 12, 2023 · aec4be2 · aec4be2
1 parent 41d391f
commit aec4be2
Show file tree

Hide file tree

Showing 9 changed files with 173 additions and 26 deletions.
diff --git a/api/src/main/java/org/jfrog/artifactory/client/Artifactory.java b/api/src/main/java/org/jfrog/artifactory/client/Artifactory.java
@@ -42,10 +42,12 @@ public interface Artifactory extends ApiInterface, AutoCloseable {
 
     ArtifactoryResponse restCall(ArtifactoryRequest artifactoryRequest) throws IOException;
 
+    ArtifactoryStreamingResponse streamingRestCall(ArtifactoryRequest artifactoryRequest) throws IOException;
+
     InputStream getInputStream(String path) throws IOException;
 
     InputStream getInputStreamWithHeaders(String path, Map<String, String> headers) throws IOException;
-
+    
     default public <T> T get(String path, Class<? extends T> object, Class<T> interfaceObject) throws IOException {
         return null;
     }

diff --git a/api/src/main/java/org/jfrog/artifactory/client/ArtifactoryResponse.java b/api/src/main/java/org/jfrog/artifactory/client/ArtifactoryResponse.java
@@ -1,23 +1,15 @@
 package org.jfrog.artifactory.client;
 
-import org.apache.http.Header;
-import org.apache.http.StatusLine;
 
 import java.io.IOException;
 
 /**
  * ArtifactoryResponse object returned from {@link Artifactory#restCall(ArtifactoryRequest)}.
  * acts as a wrapper for {@link org.apache.http.HttpResponse} but removes the need to handle response stream.
  */
-public interface ArtifactoryResponse {
-
-    Header[] getAllHeaders();
-
-    StatusLine getStatusLine();
-
+public interface ArtifactoryResponse extends JfrogResponse {
     String getRawBody();
 
     <T> T parseBody(Class<T> toType) throws IOException;
 
-    boolean isSuccessResponse();
-}
+}
diff --git a/api/src/main/java/org/jfrog/artifactory/client/ArtifactoryStreamingResponse.java b/api/src/main/java/org/jfrog/artifactory/client/ArtifactoryStreamingResponse.java
@@ -0,0 +1,15 @@
+package org.jfrog.artifactory.client;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+
+/**
+ * ArtifactoryStreamingResponse object returned from {@link Artifactory#streamingRestCall(ArtifactoryRequest)}.
+ * acts as a wrapper for {@link org.apache.http.HttpResponse}.
+ */
+public interface ArtifactoryStreamingResponse extends JfrogResponse{
+
+    InputStream getInputStream() throws IOException;
+
+}
diff --git a/api/src/main/java/org/jfrog/artifactory/client/JfrogResponse.java b/api/src/main/java/org/jfrog/artifactory/client/JfrogResponse.java
@@ -0,0 +1,13 @@
+package org.jfrog.artifactory.client;
+import org.apache.http.Header;
+import org.apache.http.StatusLine;
+
+public interface JfrogResponse {
+
+    Header[] getAllHeaders();
+
+    StatusLine getStatusLine();
+
+    boolean isSuccessResponse();
+
+}
diff --git a/services/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryImpl.java b/services/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryImpl.java
@@ -132,6 +132,30 @@ public ArtifactorySystem system() {
      */
     @Override
     public ArtifactoryResponse restCall(ArtifactoryRequest artifactoryRequest) throws IOException {
+        HttpResponse httpResponse = handleArtifactoryRequest(artifactoryRequest);
+        return new ArtifactoryResponseImpl(httpResponse);
+    }
+
+    /**
+     * Create a REST call to artifactory with a generic request
+     *
+     * @param artifactoryRequest that should be sent to artifactory
+     * @return {@link ArtifactoryStreamingResponse} artifactory response as per to the request sent contain
+     * refers to inputStream
+     * @throws HttpResponseException in case the server did not return 200 OK or 206 Partial Content
+     */
+    @Override
+    public ArtifactoryStreamingResponse streamingRestCall(ArtifactoryRequest artifactoryRequest) throws IOException {
+        HttpResponse httpResponse = handleArtifactoryRequest(artifactoryRequest);
+        ArtifactoryStreamingResponseImpl response = new ArtifactoryStreamingResponseImpl(httpResponse);
+        if (response.isSuccessResponse()) {
+            return response;
+        } else {
+            throw newHttpResponseException(httpResponse);
+        }
+    }
+
+    private HttpResponse handleArtifactoryRequest(ArtifactoryRequest artifactoryRequest) throws IOException {
         HttpRequestBase httpRequest;
 
         String requestPath = "/" + artifactoryRequest.getApiUrl();
@@ -194,7 +218,7 @@ public ArtifactoryResponse restCall(ArtifactoryRequest artifactoryRequest) throw
         }
 
         HttpResponse httpResponse = execute(httpRequest);
-        return new ArtifactoryResponseImpl(httpResponse);
+        return httpResponse;
     }
 
     private void setEntity(HttpEntityEnclosingRequestBase httpRequest, Object body, ContentType contentType) throws JsonProcessingException {

diff --git a/services/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryResponseImpl.java b/services/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryResponseImpl.java
@@ -1,25 +1,23 @@
 package org.jfrog.artifactory.client.impl;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.apache.http.Header;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpResponse;
-import org.apache.http.StatusLine;
 import org.apache.http.util.EntityUtils;
 import org.jfrog.artifactory.client.ArtifactoryResponse;
 import org.jfrog.artifactory.client.impl.util.Util;
 
 import java.io.IOException;
 
-public class ArtifactoryResponseImpl implements ArtifactoryResponse {
+public class ArtifactoryResponseImpl extends JfrogResponseImpl implements ArtifactoryResponse {
 
     private static final ObjectMapper objectMapper = new ObjectMapper();
 
-    private HttpResponse httpResponse;
+
     private String rawBody;
 
     ArtifactoryResponseImpl(HttpResponse httpResponse) throws IOException {
-        this.httpResponse = httpResponse;
+        super(httpResponse);
 
         HttpEntity entity = httpResponse.getEntity();
 
@@ -34,15 +32,7 @@ public class ArtifactoryResponseImpl implements ArtifactoryResponse {
         }
     }
 
-    @Override
-    public Header[] getAllHeaders() {
-        return this.httpResponse.getAllHeaders();
-    }
 
-    @Override
-    public StatusLine getStatusLine() {
-        return this.httpResponse.getStatusLine();
-    }
 
     @Override
     public String getRawBody() {
@@ -62,7 +52,7 @@ public <T> T parseBody(Class<T> toType) throws IOException {
     @Override
     public boolean isSuccessResponse() {
         int status = getStatusLine().getStatusCode();
-
         return status >= 200 && status < 300;
     }
+
 }
diff --git a/...s/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryStreamingResponseImpl.java b/...s/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryStreamingResponseImpl.java
@@ -0,0 +1,26 @@
+package org.jfrog.artifactory.client.impl;
+
+import org.apache.http.HttpResponse;
+import org.apache.http.HttpStatus;
+import org.jfrog.artifactory.client.ArtifactoryStreamingResponse;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class ArtifactoryStreamingResponseImpl extends JfrogResponseImpl implements ArtifactoryStreamingResponse {
+
+    public ArtifactoryStreamingResponseImpl(HttpResponse httpResponse) {
+        super(httpResponse);
+    }
+
+    @Override
+    public InputStream getInputStream() throws IOException {
+        return getHttpResponse().getEntity().getContent();
+    }
+
+    public boolean isSuccessResponse() {
+        int status = getStatusLine().getStatusCode();
+        return (status == HttpStatus.SC_OK ||
+                status == HttpStatus.SC_PARTIAL_CONTENT);
+    }
+}
diff --git a/services/src/main/groovy/org/jfrog/artifactory/client/impl/JfrogResponseImpl.java b/services/src/main/groovy/org/jfrog/artifactory/client/impl/JfrogResponseImpl.java
@@ -0,0 +1,26 @@
+package org.jfrog.artifactory.client.impl;
+
+import org.apache.http.Header;
+import org.apache.http.HttpResponse;
+import org.apache.http.StatusLine;
+
+public class JfrogResponseImpl {
+    public JfrogResponseImpl(HttpResponse httpResponse) {
+        this.httpResponse = httpResponse;
+    }
+
+    public HttpResponse getHttpResponse() {
+        return httpResponse;
+    }
+
+    private final HttpResponse httpResponse;
+
+    public Header[] getAllHeaders() {
+        return this.httpResponse.getAllHeaders();
+    }
+
+    public StatusLine getStatusLine() {
+        return this.httpResponse.getStatusLine();
+    }
+
+}
diff --git a/services/src/test/java/org/jfrog/artifactory/client/StreamingRestCallTest.java b/services/src/test/java/org/jfrog/artifactory/client/StreamingRestCallTest.java
@@ -0,0 +1,59 @@
+package org.jfrog.artifactory.client;
+
+import org.apache.http.HttpStatus;
+import org.apache.http.client.HttpResponseException;
+import org.jfrog.artifactory.client.impl.ArtifactoryRequestImpl;
+import org.testng.annotations.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertNotNull;
+
+public class StreamingRestCallTest extends ArtifactoryTestsBase {
+
+    @Test
+    public void testDownloadWithHeadersByStreamingRestCall() throws IOException {
+        InputStream inputStream = this.getClass().getResourceAsStream("/sample.txt");
+        assertNotNull(inputStream);
+        artifactory.repository(localRepository.getKey()).upload(PATH, inputStream).withProperty("color", "blue")
+                .withProperty("color", "red").doUpload();
+
+        Map<String, String> headers = new HashMap<>();
+        headers.put("Range", "bytes=0-10");
+        ArtifactoryRequest request = new ArtifactoryRequestImpl()
+                .apiUrl(localRepository.getKey() + "/" + PATH)
+                .method(ArtifactoryRequest.Method.GET)
+                .setHeaders(headers)
+                .requestType(ArtifactoryRequest.ContentType.JSON);
+
+        ArtifactoryStreamingResponse response = artifactory.streamingRestCall(request);
+
+        inputStream = response.getInputStream();
+        String actual = textFrom(inputStream);
+        assertEquals(actual, textFrom(this.getClass().getResourceAsStream("/sample.txt")).substring(0, 11));
+    }
+
+    @Test
+    public void testErrorStreamingRestCall() throws IOException {
+        ArtifactoryRequest request = new ArtifactoryRequestImpl()
+                .apiUrl(localRepository.getKey() + "/" + PATH + "shouldNotExist")
+                .method(ArtifactoryRequest.Method.GET)
+                .requestType(ArtifactoryRequest.ContentType.JSON);
+        try {
+            artifactory.streamingRestCall(request);
+        } catch (HttpResponseException e) {
+            assertEquals(e.getStatusCode(), HttpStatus.SC_NOT_FOUND);
+            assertEquals(e.getReasonPhrase(), "{\n" +
+                    "  \"errors\" : [ {\n" +
+                    "    \"status\" : 404,\n" +
+                    "    \"message\" : \"File not found.\"\n" +
+                    "  } ]\n" +
+                    "}");
+        }
+
+    }
+}