com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.client.googleapis.services.json;

import com.google.api.client.googleapis.batch.BatchRequest;
import com.google.api.client.googleapis.batch.json.JsonBatchCallback;
import com.google.api.client.googleapis.json.GoogleJsonErrorContainer;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.googleapis.services.AbstractGoogleClientRequest;
import com.google.api.client.http.HttpHeaders;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.UriTemplate;
import com.google.api.client.http.json.JsonHttpContent;
import java.io.IOException;

/**
 * Google JSON request for a {@link AbstractGoogleJsonClient}.
 *
 * Implementation is not thread-safe.
 *
 * @param  type of the response
 * @since 1.12
 * @author Yaniv Inbar
 */
public abstract class AbstractGoogleJsonClientRequest extends AbstractGoogleClientRequest {

  /** POJO that can be serialized into JSON content or {@code null} for none. */
  private final Object jsonContent;

  /**
   * @param abstractGoogleJsonClient Google JSON client
   * @param requestMethod HTTP Method
   * @param uriTemplate URI template for the path relative to the base URL. If it starts with a "/"
   *     the base path from the base URL will be stripped out. The URI template can also be a full
   *     URL. URI template expansion is done using {@link UriTemplate#expand(String, String, Object,
   *     boolean)}
   * @param jsonContent POJO that can be serialized into JSON content or {@code null} for none
   * @param responseClass response class to parse into
   */
  protected AbstractGoogleJsonClientRequest(
      AbstractGoogleJsonClient abstractGoogleJsonClient,
      String requestMethod,
      String uriTemplate,
      Object jsonContent,
      Class responseClass) {
    super(
        abstractGoogleJsonClient,
        requestMethod,
        uriTemplate,
        jsonContent == null
            ? null
            : new JsonHttpContent(abstractGoogleJsonClient.getJsonFactory(), jsonContent)
                .setWrapperKey(
                    abstractGoogleJsonClient.getObjectParser().getWrapperKeys().isEmpty()
                        ? null
                        : "data"),
        responseClass);
    this.jsonContent = jsonContent;
  }

  @Override
  public AbstractGoogleJsonClient getAbstractGoogleClient() {
    return (AbstractGoogleJsonClient) super.getAbstractGoogleClient();
  }

  @Override
  public AbstractGoogleJsonClientRequest setDisableGZipContent(boolean disableGZipContent) {
    return (AbstractGoogleJsonClientRequest) super.setDisableGZipContent(disableGZipContent);
  }

  @Override
  public AbstractGoogleJsonClientRequest setRequestHeaders(HttpHeaders headers) {
    return (AbstractGoogleJsonClientRequest) super.setRequestHeaders(headers);
  }

  /**
   * Queues the request into the specified batch request container.
   *
   * 
Batched requests are then executed when {@link BatchRequest#execute()} is called.
   *
   * 
Example usage:
   *
   * 
{@code
   * request.queue(batchRequest, new JsonBatchCallback<SomeResponseType>() {
   *
   *   public void onSuccess(SomeResponseType content, HttpHeaders responseHeaders) {
   *     log("Success");
   *   }
   *
   *   public void onFailure(GoogleJsonError e, HttpHeaders responseHeaders) {
   *     log(e.getMessage());
   *   }
   * });
   * }
   *
   * @param batchRequest batch request container
   * @param callback batch callback
   */
  public final void queue(BatchRequest batchRequest, JsonBatchCallback callback)
      throws IOException {
    super.queue(batchRequest, GoogleJsonErrorContainer.class, callback);
  }

  @Override
  protected GoogleJsonResponseException newExceptionOnError(HttpResponse response) {
    return GoogleJsonResponseException.from(getAbstractGoogleClient().getJsonFactory(), response);
  }

  /** Returns POJO that can be serialized into JSON content or {@code null} for none. */
  public Object getJsonContent() {
    return jsonContent;
  }

  @Override
  public AbstractGoogleJsonClientRequest set(String fieldName, Object value) {
    return (AbstractGoogleJsonClientRequest) super.set(fieldName, value);
  }
}