Remove JsonHttpClient.builder and add enableGZipContent to JsonHttpRequest

http://codereview.appspot.com/6297045/

Author: rmistry

google-http-client/src/main/java/com/google/api/client/http/json/JsonHttpClient.java

@@ -37,6 +37,13 @@
  * Implementation is not thread-safe.
  * </p>
  *
+ * <p>
+ * Upgrade warning: prior to version 1.10 there was a {@code builder} method in
+ * {@link JsonHttpClient}, this has been removed in version 1.10. The Builder can now be
+ * instantiated with
+ * {@link Builder#Builder(HttpTransport, JsonFactory, String, String, HttpRequestInitializer)}.
+ * </p>
+ *
  * @since 1.6
  * @author Ravi Mistry
  */
@@ -240,14 +247,14 @@ protected void initialize(JsonHttpRequest jsonHttpRequest) throws IOException {
    * Constructor with required parameters.
    *
    * <p>
-   * Use {@link #builder} if you need to specify any of the optional parameters.
+   * Use {@link Builder} if you need to specify any of the optional parameters.
    * </p>
    *
    * @param transport The transport to use for requests
    * @param jsonFactory A factory for creating JSON parsers and serializers
    * @param baseUrl The base URL of the service. Must end with a "/"
-   * @deprecated (scheduled to be removed in 1.11) Use
-   *             {@link #JsonHttpClient(HttpTransport, JsonFactory, String, String)}.
+   * @deprecated (scheduled to be removed in 1.11) Use {@link #JsonHttpClient(HttpTransport,
+   *             JsonFactory, String, String, HttpRequestInitializer)}.
    */
   @Deprecated
   public JsonHttpClient(HttpTransport transport, JsonFactory jsonFactory, String baseUrl) {
@@ -258,19 +265,20 @@ public JsonHttpClient(HttpTransport transport, JsonFactory jsonFactory, String b
    * Constructor with required parameters.
    *
    * <p>
-   * Use {@link #builder} if you need to specify any of the optional parameters.
+   * Use {@link Builder} if you need to specify any of the optional parameters.
    * </p>
    *
    * @param transport The transport to use for requests
    * @param jsonFactory A factory for creating JSON parsers and serializers
    * @param rootUrl The root URL of the service. Must end with a "/"
    * @param servicePath The service path of the service. Must end with a "/" and not begin with a
    *        "/". It is allowed to be an empty string {@code ""}
+   * @param httpRequestInitializer The HTTP request initializer or {@code null} for none
    * @since 1.10
    */
-  public JsonHttpClient(
-      HttpTransport transport, JsonFactory jsonFactory, String rootUrl, String servicePath) {
-    this(transport, null, null, jsonFactory, null, rootUrl, servicePath, null);
+  public JsonHttpClient(HttpTransport transport, JsonFactory jsonFactory, String rootUrl,
+      String servicePath, HttpRequestInitializer httpRequestInitializer) {
+    this(transport, null, httpRequestInitializer, jsonFactory, null, rootUrl, servicePath, null);
   }
 
   /**
@@ -513,36 +521,6 @@ protected InputStream executeAsInputStream(HttpMethod method, GenericUrl url, Ob
     return response.getContent();
   }
 
-  /**
-   * Returns an instance of a new builder.
-   *
-   * @param transport The transport to use for requests
-   * @param jsonFactory A factory for creating JSON parsers and serializers
-   * @param baseUrl The base URL of the service. Must end with a "/"
-   * @deprecated (scheduled to be removed in 1.11) Use
-   *             {@link #builder(HttpTransport, JsonFactory, GenericUrl, String)} instead.
-   */
-  @Deprecated
-  public static Builder builder(
-      HttpTransport transport, JsonFactory jsonFactory, GenericUrl baseUrl) {
-    return new Builder(transport, jsonFactory, baseUrl);
-  }
-
-  /**
-   * Returns an instance of a new builder.
-   *
-   * @param transport The transport to use for requests
-   * @param jsonFactory A factory for creating JSON parsers and serializers
-   * @param rootUrl The root URL of the service. Must end with a "/"
-   * @param servicePath The service path of the service. Must end with a "/" and not begin with a
-   *        "/". It is allowed to be an empty string {@code ""}
-   * @since 1.10
-   */
-  public static Builder builder(
-      HttpTransport transport, JsonFactory jsonFactory, GenericUrl rootUrl, String servicePath) {
-    return new Builder(transport, jsonFactory, rootUrl, servicePath);
-  }
-
   /**
    * Builder for {@link JsonHttpClient}.
    *
@@ -578,7 +556,7 @@ public static class Builder {
     private GenericUrl baseUrl;
 
     /** The root URL of the service, for example {@code "https://www.googleapis.com/"}. */
-    private GenericUrl rootUrl;
+    private String rootUrl;
 
     /** The service path of the service, for example {@code "tasks/v1/"}. */
     private String servicePath;
@@ -602,8 +580,8 @@ public static class Builder {
      * @param jsonFactory A factory for creating JSON parsers and serializers
      * @param baseUrl The base URL of the service. Must end with a "/"
      *
-     * @deprecated (scheduled to be removed in 1.11) Use
-     *             {@link #Builder(HttpTransport, JsonFactory, GenericUrl, String)} instead.
+     * @deprecated (scheduled to be removed in 1.11) Use {@link #Builder(HttpTransport, JsonFactory,
+     *             String, String, HttpRequestInitializer)} instead.
      */
     @Deprecated
     protected Builder(HttpTransport transport, JsonFactory jsonFactory, GenericUrl baseUrl) {
@@ -621,14 +599,17 @@ protected Builder(HttpTransport transport, JsonFactory jsonFactory, GenericUrl b
      * @param rootUrl The root URL of the service. Must end with a "/"
      * @param servicePath The service path of the service. Must end with a "/" and not begin with a
      *        "/". It is allowed to be an empty string {@code ""}
+     * @param httpRequestInitializer The HTTP request initializer or {@code null} for none
      * @since 1.10
      */
-    protected Builder(
-        HttpTransport transport, JsonFactory jsonFactory, GenericUrl rootUrl, String servicePath) {
+    public Builder(HttpTransport transport, JsonFactory jsonFactory, String rootUrl,
+        String servicePath,
+        HttpRequestInitializer httpRequestInitializer) {
       this.transport = transport;
       this.jsonFactory = jsonFactory;
       setRootUrl(rootUrl);
       setServicePath(servicePath);
+      this.httpRequestInitializer = httpRequestInitializer;
     }
 
     /**
@@ -652,13 +633,13 @@ public JsonHttpClient build() {
           httpRequestInitializer,
           jsonFactory,
           jsonObjectParser,
-          rootUrl.build(),
+          rootUrl,
           servicePath,
           applicationName);
     }
 
     /**
-     * Returns if baseUrl is used instead of {@code servicePath} and {@code rootUrl}.
+     * Returns if {@code baseUrl} is used instead of {@code rootUrl} and {@code servicePath}.
      *
      * @since 1.10
      * @deprecated (scheduled to be removed in 1.11) Use {@link #getRootUrl} and
@@ -714,7 +695,8 @@ public Builder setObjectParser(JsonObjectParser parser) {
      * This is determined when the library is generated and normally should not be changed.
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl)} was used.
+     * Use this method only if {@code baseUrl} is used instead of {@code rootUrl} and
+     * {@code servicePath}.
      * </p>
      *
      * @deprecated (scheduled to be removed in 1.11) Use {@link #getRootUrl} and
@@ -732,7 +714,8 @@ public final GenericUrl getBaseUrl() {
      * and normally should not be changed. Subclasses should override by calling super.
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl)} was used.
+     * Use this method only if {@code baseUrl} is used instead of {@code rootUrl} and
+     * {@code servicePath}.
      * </p>
      *
      * @since 1.7
@@ -752,15 +735,15 @@ public Builder setBaseUrl(GenericUrl baseUrl) {
      * URL-encoded and must end with a "/".
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl, String)} was
-     * used.
+     * Use this method only if {@code rootUrl} and {@code servicePath} are used instead of
+     * {@code baseUrl}.
      * </p>
      *
      * @since 1.10
      */
     public final String getRootUrl() {
       Preconditions.checkArgument(!baseUrlUsed);
-      return rootUrl.build();
+      return rootUrl;
     }
 
     /**
@@ -769,16 +752,16 @@ public final String getRootUrl() {
      * normally should be changed. Subclasses should override by calling super.
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl, String)} was
-     * used.
+     * Use this method only if {@code rootUrl} and {@code servicePath} are used instead of
+     * {@code baseUrl}.
      * </p>
      *
      * @since 1.10
      */
-    public Builder setRootUrl(GenericUrl rootUrl) {
+    public Builder setRootUrl(String rootUrl) {
       Preconditions.checkArgument(!baseUrlUsed);
       Preconditions.checkNotNull(rootUrl);
-      Preconditions.checkArgument(rootUrl.build().endsWith("/"));
+      Preconditions.checkArgument(rootUrl.endsWith("/"));
       this.rootUrl = rootUrl;
       return this;
     }
@@ -790,8 +773,8 @@ public Builder setRootUrl(GenericUrl rootUrl) {
      * {@code ""}.
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl, String)} was
-     * used.
+     * Use this method only if {@code rootUrl} and {@code servicePath} are used instead of
+     * {@code baseUrl}.
      * </p>
      *
      * @since 1.10
@@ -808,8 +791,8 @@ public final String getServicePath() {
      * changed. Subclasses should override by calling super.
      *
      * <p>
-     * Use this method only if {@link #builder(HttpTransport, JsonFactory, GenericUrl, String)} was
-     * used.
+     * Use this method only if {@code rootUrl} and {@code servicePath} are used instead of
+     * {@code baseUrl}.
      * </p>
      *
      * @since 1.10

google-http-client/src/main/java/com/google/api/client/http/json/JsonHttpRequest.java

@@ -51,6 +51,9 @@ public class JsonHttpRequest extends GenericData {
   /** The HTTP headers of the last response or {@code null} for none. */
   private HttpHeaders lastResponseHeaders;
 
+  /** Whether to enable GZip compression of HTTP content. */
+  private boolean enableGZipContent = true;
+
   /**
    * Builds an instance of {@link JsonHttpRequest}.
    *
@@ -70,6 +73,30 @@ public JsonHttpRequest(JsonHttpClient client, HttpMethod method, String uriTempl
     this.content = content;
   }
 
+  /**
+   * Sets whether to enable GZip compression of HTTP content. Subclasses should override by
+   * calling super.
+   *
+   * <p>
+   * By default it is {@code true}.
+   * </p>
+   *
+   * @since 1.10
+   */
+  public JsonHttpRequest setEnableGZipContent(boolean enableGZipContent) {
+    this.enableGZipContent = enableGZipContent;
+    return this;
+  }
+
+  /**
+   * Returns whether to enable GZip compression of HTTP content.
+   *
+   * @since 1.10
+   */
+  public final boolean getEnableGZipContent() {
+    return enableGZipContent;
+  }
+
   /** Returns the HTTP Method type. */
   public final HttpMethod getMethod() {
     return method;
@@ -176,6 +203,7 @@ public HttpRequest buildHttpRequest() throws IOException {
    */
   public HttpResponse executeUnparsed() throws IOException {
     HttpRequest request = buildHttpRequest();
+    request.setEnableGZipContent(enableGZipContent);
     HttpResponse response = client.executeUnparsed(request);
     lastResponseHeaders = response.getHeaders();
     return response;

google-http-client/src/test/java/com/google/api/client/http/json/JsonHttpClientTest.java

@@ -65,7 +65,7 @@ public void testJsonHttpClientBuilderWithBaseUrl() {
     String applicationName = "Test Application";
 
     JsonHttpClient.Builder builder =
-        JsonHttpClient.builder(transport, jsonFactory, baseUrl)
+        new JsonHttpClient.Builder(transport, jsonFactory, baseUrl)
             .setJsonHttpRequestInitializer(jsonHttpRequestInitializer)
         .setApplicationName(applicationName);
     try {
@@ -87,7 +87,7 @@ public void testJsonHttpClientBuilderWithBaseUrl() {
       // expected
     }
     try {
-      builder.setRootUrl(new GenericUrl("http://www.test.com/"));
+      builder.setRootUrl("http://www.test.com/");
       fail("Expected " + IllegalArgumentException.class);
     } catch (IllegalArgumentException e) {
       // expected
@@ -117,13 +117,13 @@ public void testJsonHttpClientBuilderWithBaseUrl() {
   public void testJsonHttpClientBuilderWithRootUrlAndServicePath() {
     HttpTransport transport = new NetHttpTransport();
     JsonFactory jsonFactory = new JacksonFactory();
-    GenericUrl rootUrl = new GenericUrl("http://www.testgoogleapis.com/");
+    String rootUrl = "http://www.testgoogleapis.com/";
     String servicePath = "test/path/v1/";
     JsonHttpRequestInitializer jsonHttpRequestInitializer = new TestRemoteRequestInitializer();
     String applicationName = "Test Application";
 
-    JsonHttpClient.Builder builder = JsonHttpClient.builder(
-        transport, jsonFactory, rootUrl, servicePath)
+    JsonHttpClient.Builder builder = new JsonHttpClient.Builder(
+        transport, jsonFactory, rootUrl, servicePath, null)
         .setJsonHttpRequestInitializer(jsonHttpRequestInitializer)
         .setApplicationName(applicationName);
     try {
@@ -133,14 +133,14 @@ public void testJsonHttpClientBuilderWithRootUrlAndServicePath() {
       // expected
     }
     try {
-      builder.setBaseUrl(rootUrl);
+      builder.setBaseUrl(new GenericUrl(rootUrl));
       fail("Expected " + IllegalArgumentException.class);
     } catch (IllegalArgumentException e) {
       // expected
     }
     try {
       // With no "/" at the end.
-      builder.setRootUrl(new GenericUrl("http://www.testgoogleapis.com"));
+      builder.setRootUrl("http://www.testgoogleapis.com");
       fail("Expected " + IllegalArgumentException.class);
     } catch (IllegalArgumentException e) {
       //expected
@@ -164,19 +164,19 @@ public void testJsonHttpClientBuilderWithRootUrlAndServicePath() {
 
     JsonHttpClient client = builder.build();
 
-    assertEquals(rootUrl.build(), client.getRootUrl());
+    assertEquals(rootUrl, client.getRootUrl());
     assertEquals("", client.getServicePath());
     assertEquals(applicationName, client.getApplicationName());
     assertEquals(jsonFactory, client.getJsonFactory());
     assertEquals(jsonHttpRequestInitializer, client.getJsonHttpRequestInitializer());
-    assertEquals(rootUrl.build(), client.getBaseUrl());
+    assertEquals(rootUrl, client.getBaseUrl());
   }
 
   @SuppressWarnings("deprecation")
   public void testBaseServerAndBasePathBuilder() {
     JsonHttpClient client =
-        JsonHttpClient
-            .builder(new NetHttpTransport(), new JacksonFactory(),
+        new JsonHttpClient
+            .Builder(new NetHttpTransport(), new JacksonFactory(),
                 new GenericUrl("http://www.testgoogleapis.com/test/path/v1/"))
             .setBaseUrl(new GenericUrl("http://www.googleapis.com/test/path/v2/"))
             .build();
@@ -187,7 +187,7 @@ public void testBaseServerAndBasePathBuilder() {
   @SuppressWarnings("deprecation")
   public void testInitializeWithBaseUrl() throws IOException {
     TestRemoteRequestInitializer remoteRequestInitializer = new TestRemoteRequestInitializer();
-    JsonHttpClient client = JsonHttpClient.builder(
+    JsonHttpClient client = new JsonHttpClient.Builder(
         new NetHttpTransport(), new JacksonFactory(), new GenericUrl("http://www.test.com/"))
         .setJsonHttpRequestInitializer(remoteRequestInitializer)
         .setApplicationName("Test Application").build();
@@ -197,9 +197,9 @@ public void testInitializeWithBaseUrl() throws IOException {
 
   public void testInitializeWithRootUrl() throws IOException {
     TestRemoteRequestInitializer remoteRequestInitializer = new TestRemoteRequestInitializer();
-    JsonHttpClient client = JsonHttpClient.builder(
-        new NetHttpTransport(), new JacksonFactory(), new GenericUrl("http://www.test.com/"),
-        "test/").setJsonHttpRequestInitializer(remoteRequestInitializer)
+    JsonHttpClient client = new JsonHttpClient.Builder(
+        new NetHttpTransport(), new JacksonFactory(), "http://www.test.com/", "test/",
+        null).setJsonHttpRequestInitializer(remoteRequestInitializer)
         .setApplicationName("Test Application").build();
     client.initialize(null);
     assertTrue(remoteRequestInitializer.isCalled);
@@ -224,7 +224,7 @@ public LowLevelHttpResponse execute() {
       }
     };
     JsonHttpClient client =
-      JsonHttpClient.builder(
+      new JsonHttpClient.Builder(
           transport, new JacksonFactory(), new GenericUrl(testBaseUrl)).build();
     client.executeUnparsed(HttpMethod.GET, new GenericUrl(testBaseUrl + testUriTemplate), null);
   }
@@ -247,8 +247,8 @@ public LowLevelHttpResponse execute() {
         };
       }
     };
-    JsonHttpClient client = JsonHttpClient.builder(
-        transport, new JacksonFactory(), new GenericUrl(testRootUrl), testServicePath).build();
+    JsonHttpClient client = new JsonHttpClient.Builder(
+        transport, new JacksonFactory(), testRootUrl, testServicePath, null).build();
     client.executeUnparsed(
         HttpMethod.GET, new GenericUrl(testRootUrl + testServicePath + testUriTemplate), null);
   }