Add an option to perform download with custom headers (#373)

Author: idand1741

README.md

@@ -224,6 +224,16 @@ InputStream iStream = artifactory.repository("RepoName")
         .doDownload();
 ```
 
+##### Downloading Artifact with custom headers
+
+```groovy
+Map<String, String> headers = new HashMap<>();
+headers.put("Range", "bytes=0-10");
+InputStream iStream = artifactory.repository("RepoName")
+        .download("path/to/fileToDownload.txt")
+        .doDownloadWithHeaders(headers);
+```
+
 #### File, Folder and Repository Info
 
 ##### File Info

api/src/main/java/org/jfrog/artifactory/client/Artifactory.java

@@ -44,10 +44,16 @@ public interface Artifactory extends ApiInterface, AutoCloseable {
 
     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;
     }
 
+    default public <T> T get(String path, Class<? extends T> object, Class<T> interfaceObject, Map<String, String> headers) throws IOException {
+        return null;
+    }
+
     default public <T> T post(String path, org.apache.http.entity.ContentType contentType, String content,
                               Map<String, String> headers, Class<? extends T> object, Class<T> interfaceObject) throws IOException {
         return null;

api/src/main/java/org/jfrog/artifactory/client/DownloadableArtifact.java

@@ -4,6 +4,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Map;
 
 /**
  * @author jbaruch
@@ -14,6 +15,7 @@ public interface DownloadableArtifact extends Artifact<DownloadableArtifact> {
 
     InputStream doDownload() throws IOException;
 
+    InputStream doDownloadWithHeaders(Map<String, String> headers) throws IOException;
     DownloadableArtifact withProperty(String name, Object... values);
 
     DownloadableArtifact withProperty(String name, Object value);

services/src/main/groovy/org/jfrog/artifactory/client/impl/ArtifactoryImpl.java

@@ -21,6 +21,7 @@
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URL;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -220,6 +221,15 @@ public InputStream getInputStream(String path) throws IOException {
         throw newHttpResponseException(httpResponse);
     }
 
+    public InputStream getInputStreamWithHeaders(String path, Map<String, String> headers) throws IOException {
+        HttpResponse httpResponse = get(path, null, null, headers);
+        if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK ||
+                httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_PARTIAL_CONTENT) {
+            return httpResponse.getEntity().getContent();
+        }
+        throw newHttpResponseException(httpResponse);
+    }
+
     private HttpResponseException newHttpResponseException(HttpResponse httpResponse) throws IOException {
         String artifactoryResponse = Util.responseToString(httpResponse);
         StatusLine statusLine = httpResponse.getStatusLine();
@@ -239,12 +249,23 @@ protected Boolean head(String path) throws IOException {
     }
 
     public <T> T get(String path, Class<? extends T> object, Class<T> interfaceObject) throws IOException {
-        HttpGet httpGet = new HttpGet();
+        return this.get(path, object, interfaceObject, new HashMap<>());
+    }
 
+    public <T> T get(String path, Class<? extends T> object, Class<T> interfaceObject, Map<String, String> headers) throws IOException {
+        HttpGet httpGet = new HttpGet();
         httpGet.setURI(URI.create(url + path));
+
+        if (headers != null && !headers.isEmpty()) {
+            for (String key : headers.keySet()) {
+                httpGet.setHeader(key, headers.get(key));
+            }
+        }
+
         HttpResponse httpResponse = execute(httpGet);
         int status = httpResponse.getStatusLine().getStatusCode();
-        if (status != HttpStatus.SC_OK && status != HttpStatus.SC_NO_CONTENT && status != HttpStatus.SC_ACCEPTED) {
+        if (status != HttpStatus.SC_OK && status != HttpStatus.SC_NO_CONTENT &&
+                status != HttpStatus.SC_ACCEPTED && status != HttpStatus.SC_PARTIAL_CONTENT) {
             throw newHttpResponseException(httpResponse);
         }
 

services/src/main/java/org/jfrog/artifactory/client/impl/DownloadableArtifactImpl.java

@@ -5,6 +5,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Created by eyalb on 21/06/2018.
@@ -22,12 +23,21 @@ public class DownloadableArtifactImpl extends ArtifactBase<DownloadableArtifact>
     }
 
     public InputStream doDownload() throws IOException {
+        String uri = generateUriWithParams();
+        return artifactory.getInputStream(uri);
+    }
+
+    public InputStream doDownloadWithHeaders(Map<String, String> headers) throws IOException {
+        String uri = generateUriWithParams();
+        return artifactory.getInputStreamWithHeaders(uri, headers);
+    }
+
+    private String generateUriWithParams() {
         String params = parseParams(props, "=") + parseParams(mandatoryProps, "+=");
         if (params.length() > 0) {
             params = ";" + params;
         }
-        String uri = String.format("/%s/%s%s", repo, path, params);
-        return artifactory.getInputStream(uri);
+        return String.format("/%s/%s%s", repo, path, params);
     }
 
     public DownloadableArtifact withProperty(String name, Object... values) {

services/src/test/java/org/jfrog/artifactory/client/DownloadUploadTests.java

@@ -19,7 +19,9 @@
 import java.text.DecimalFormat;
 import java.text.NumberFormat;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import static org.testng.Assert.*;
 
@@ -284,4 +286,13 @@ public void testDownloadWithMandatoryAndNonMandatoryProperties() throws IOExcept
                         .withProperty("foo", "bar").withMandatoryProperty("colors", "red").doDownload();
         assertEquals(textFrom(inputStream), textFrom(this.getClass().getResourceAsStream("/sample.txt")));
     }
+
+    @Test(dependsOnMethods = "testUploadWithSingleProperty")
+    public void testDownloadWithHeaders() throws IOException {
+        Map<String, String> headers = new HashMap<>();
+        headers.put("Range", "bytes=0-10");
+        InputStream inputStream = artifactory.repository(localRepository.getKey()).download(PATH).doDownloadWithHeaders(headers);
+        String actual = textFrom(inputStream);
+        assertEquals(actual, textFrom(this.getClass().getResourceAsStream("/sample.txt")).substring(0, 11));
+    }
 }