com.google.api.client.googleapis.json

Class GoogleJsonResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

com.google.api.client.http.HttpResponseException

com.google.api.client.googleapis.json.GoogleJsonResponseException

All Implemented Interfaces:

java.io.Serializable

public class GoogleJsonResponseException
extends com.google.api.client.http.HttpResponseException

Exception thrown when an error status code is detected in an HTTP response to a Google API that uses the JSON format, using the format specified in Error Responses.

To execute a request, call execute(JsonFactory, HttpRequest). This will throw a GoogleJsonResponseException on an error response. To get the structured details, use getDetails().

  static void executeShowingError(JsonFactory factory, HttpRequest request) throws IOException {
    try {
      GoogleJsonResponseException.execute(factory, request);
    } catch (GoogleJsonResponseException e) {
      System.err.println(e.getDetails());
    }
  }
 

Since:

1.6

Author:

Yaniv Inbar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.http.HttpResponseException

com.google.api.client.http.HttpResponseException.Builder

Constructor Summary

Constructors

Constructor and Description
GoogleJsonResponseException(com.google.api.client.http.HttpResponseException.Builder builder, GoogleJsonError details)

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.api.client.http.HttpResponse	execute(com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpRequest request) Executes an HTTP request using HttpRequest.execute(), but throws a GoogleJsonResponseException on error instead of HttpResponseException.
static GoogleJsonResponseException	from(com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.HttpResponse response) Returns a new instance of GoogleJsonResponseException.
GoogleJsonError	getDetails() Returns the Google JSON error details or null for none (for example if response is not JSON).

Methods inherited from class com.google.api.client.http.HttpResponseException

computeMessageBuffer, getContent, getHeaders, getStatusCode, getStatusMessage, isSuccessStatusCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GoogleJsonResponseException

public GoogleJsonResponseException(com.google.api.client.http.HttpResponseException.Builder builder,
                           GoogleJsonError details)

Parameters:

builder - builder

details - Google JSON error details

Since:

1.21.0

Method Detail

getDetails

public final GoogleJsonError getDetails()

Returns the Google JSON error details or null for none (for example if response is not JSON).

from

public static GoogleJsonResponseException from(com.google.api.client.json.JsonFactory jsonFactory,
                               com.google.api.client.http.HttpResponse response)

Returns a new instance of GoogleJsonResponseException.

If there is a JSON error response, it is parsed using GoogleJsonError, which can be inspected using getDetails(). Otherwise, the full response content is read and included in the exception message.

Parameters:

jsonFactory - JSON factory

response - HTTP response

Returns:

new instance of GoogleJsonResponseException

execute

public static com.google.api.client.http.HttpResponse execute(com.google.api.client.json.JsonFactory jsonFactory,
                                              com.google.api.client.http.HttpRequest request)
                                                       throws GoogleJsonResponseException,
                                                              java.io.IOException

Executes an HTTP request using HttpRequest.execute(), but throws a GoogleJsonResponseException on error instead of HttpResponseException.

Callers should call HttpResponse.disconnect() when the returned HTTP response object is no longer needed. However, HttpResponse.disconnect() does not have to be called if the response stream is properly closed. Example usage:

     HttpResponse response = GoogleJsonResponseException.execute(jsonFactory, request);
     try {
       // process the HTTP response object
     } finally {
       response.disconnect();
     }
 

Parameters:

jsonFactory - JSON factory

request - HTTP request

Returns:

HTTP response for an HTTP success code (or error code if HttpRequest.getThrowExceptionOnExecuteError())

Throws:

GoogleJsonResponseException - for an HTTP error code (only if not HttpRequest.getThrowExceptionOnExecuteError())

java.io.IOException - some other kind of I/O exception

Since:

1.7