[Issue 130] Ability to set zero-length content on an HTTP GET request

Yaniv Inbar · Yaniv Inbar · commit fd61d443be4e · 2011-04-05T15:56:06.000-04:00
[Issue 168] New method HttpResponse.disconnect() [Issue 169] Streaming mode for HTTP request content for HttpURLConnection http://codereview.appspot.com/4354051/
diff --git a/google-api-client-extensions/src/main/java/com/google/api/client/extensions/appengine/http/urlfetch/UrlFetchRequest.java b/google-api-client-extensions/src/main/java/com/google/api/client/extensions/appengine/http/urlfetch/UrlFetchRequest.java
@@ -74,9 +74,11 @@ public LowLevelHttpResponse execute() throws IOException {
       if (contentLength >= 0) {
         addHeader("Content-Length", Long.toString(contentLength));
       }
-      ByteArrayOutputStream out = new ByteArrayOutputStream();
-      content.writeTo(out);
-      request.setPayload(out.toByteArray());
+      if (contentLength != 0) {
+        ByteArrayOutputStream out = new ByteArrayOutputStream();
+        content.writeTo(out);
+        request.setPayload(out.toByteArray());
+      }
     }
     // connect
     URLFetchService service = URLFetchServiceFactory.getURLFetchService();
diff --git a/google-api-client/src/main/java/com/google/api/client/http/HttpResponse.java b/google-api-client/src/main/java/com/google/api/client/http/HttpResponse.java
@@ -224,10 +224,7 @@ public InputStream getContent() throws IOException {
   }
 
   /**
-   * Gets the content of the HTTP response from {@link #getContent()} and ignores the content if
-   * there is any.
-   *
-   * @throws IOException I/O exception
+   * Closes the the content of the HTTP response from {@link #getContent()}, ignoring any content.
    */
   public void ignore() throws IOException {
     InputStream content = getContent();
@@ -236,6 +233,15 @@ public void ignore() throws IOException {
     }
   }
 
+  /**
+   * Disconnect using {@link LowLevelHttpResponse#disconnect()}.
+   *
+   * @since 1.4
+   */
+  public void disconnect() throws IOException {
+    response.disconnect();
+  }
+
   /**
    * Returns the HTTP response content parser to use for the content type of this HTTP response or
    * {@code null} for none.
diff --git a/google-api-client/src/main/java/com/google/api/client/http/LowLevelHttpResponse.java b/google-api-client/src/main/java/com/google/api/client/http/LowLevelHttpResponse.java
@@ -68,4 +68,14 @@ public abstract class LowLevelHttpResponse {
 
   /** Returns the HTTP response header value at the given zero-based index. */
   public abstract String getHeaderValue(int index);
+
+  /**
+   * Default implementation does nothing, but subclasses may override to attempt to abort the
+   * connection or release allocated system resources for this connection.
+   *
+   * @throws IOException I/O exception
+   * @since 1.4
+   */
+  public void disconnect() throws IOException {
+  }
 }
diff --git a/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpRequest.java b/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpRequest.java
@@ -55,7 +55,7 @@ public void setTimeout(int connectTimeout, int readTimeout) throws IOException {
 
   @Override
   public LowLevelHttpResponse execute() throws IOException {
-    return new ApacheHttpResponse(httpClient.execute(request));
+    return new ApacheHttpResponse(request, httpClient.execute(request));
   }
 
   @Override
diff --git a/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpResponse.java b/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpResponse.java
@@ -18,17 +18,21 @@
 
 import org.apache.http.Header;
 import org.apache.http.HttpEntity;
+import org.apache.http.HttpResponse;
 import org.apache.http.StatusLine;
+import org.apache.http.client.methods.HttpRequestBase;
 
 import java.io.IOException;
 import java.io.InputStream;
 
 final class ApacheHttpResponse extends LowLevelHttpResponse {
 
-  private final org.apache.http.HttpResponse response;
+  private final HttpRequestBase request;
+  private final HttpResponse response;
   private final Header[] allHeaders;
 
-  ApacheHttpResponse(org.apache.http.HttpResponse response) {
+  ApacheHttpResponse(HttpRequestBase request, HttpResponse response) {
+    this.request = request;
     this.response = response;
     allHeaders = response.getAllHeaders();
   }
@@ -105,4 +109,14 @@ public String getHeaderName(int index) {
   public String getHeaderValue(int index) {
     return allHeaders[index].getValue();
   }
+
+  /**
+   * Aborts execution of the request.
+   *
+   * @since 1.4
+   */
+  @Override
+  public void disconnect() {
+    request.abort();
+  }
 }
diff --git a/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpTransport.java b/google-api-client/src/main/java/com/google/api/client/http/apache/ApacheHttpTransport.java
@@ -135,6 +135,8 @@ public ApacheHttpRequest buildPutRequest(String url) {
   /**
    * Shuts down the connection manager and releases allocated resources. This includes closing all
    * connections, whether they are currently used or not.
+   *
+   * @since 1.4
    */
   @Override
   public void shutdown() {
diff --git a/google-api-client/src/main/java/com/google/api/client/http/apache/ContentEntity.java b/google-api-client/src/main/java/com/google/api/client/http/apache/ContentEntity.java
@@ -52,6 +52,8 @@ public boolean isStreaming() {
   }
 
   public void writeTo(OutputStream out) throws IOException {
-    content.writeTo(out);
+    if (contentLength != 0) {
+      content.writeTo(out);
+    }
   }
 }
diff --git a/google-api-client/src/main/java/com/google/api/client/http/javanet/NetHttpRequest.java b/google-api-client/src/main/java/com/google/api/client/http/javanet/NetHttpRequest.java
@@ -53,9 +53,7 @@ public void setTimeout(int connectTimeout, int readTimeout) {
   public LowLevelHttpResponse execute() throws IOException {
     HttpURLConnection connection = this.connection;
     // write content
-    HttpContent content = this.content;
     if (content != null) {
-      connection.setDoOutput(true);
       String contentType = content.getType();
       if (contentType != null) {
         addHeader("Content-Type", contentType);
@@ -68,7 +66,17 @@ public LowLevelHttpResponse execute() throws IOException {
       if (contentLength >= 0) {
         addHeader("Content-Length", Long.toString(contentLength));
       }
-      content.writeTo(connection.getOutputStream());
+      if (contentLength != 0) {
+        // setDoOutput(true) will change a GET method to POST, so only if contentLength != 0
+        connection.setDoOutput(true);
+        // see http://developer.android.com/reference/java/net/HttpURLConnection.html
+        if (contentLength >= 0 && contentLength <= Integer.MAX_VALUE) {
+          connection.setFixedLengthStreamingMode((int) contentLength);
+        } else {
+          connection.setChunkedStreamingMode(0);
+        }
+        content.writeTo(connection.getOutputStream());
+      }
     }
     // connect
     connection.connect();
diff --git a/google-api-client/src/main/java/com/google/api/client/http/javanet/NetHttpResponse.java b/google-api-client/src/main/java/com/google/api/client/http/javanet/NetHttpResponse.java
@@ -104,4 +104,14 @@ public String getHeaderName(int index) {
   public String getHeaderValue(int index) {
     return headerValues.get(index);
   }
+
+  /**
+   * Closes the connection to the HTTP server.
+   *
+   * @since 1.4
+   */
+  @Override
+  public void disconnect() {
+    connection.disconnect();
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public void setTimeout(int connectTimeout, int readTimeout) throws IOException {`
`55`	`55`
`56`	`56`	`@Override`
`57`	`57`	`public LowLevelHttpResponse execute() throws IOException {`
`58`		`- return new ApacheHttpResponse(httpClient.execute(request));`
	`58`	`+ return new ApacheHttpResponse(request, httpClient.execute(request));`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,8 @@ public boolean isStreaming() {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`public void writeTo(OutputStream out) throws IOException {`
`55`		`- content.writeTo(out);`
	`55`	`+ if (contentLength != 0) {`
	`56`	`+ content.writeTo(out);`
	`57`	`+ }`
`56`	`58`	`}`
`57`	`59`	`}`