com.google.api.client.http
Class HttpResponseException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by com.google.api.client.http.HttpResponseException
All Implemented Interfaces:
Serializable

public class HttpResponseException
extends IOException

Exception thrown when an error status code is detected in an HTTP response.

Since:
1.0
Author:
Yaniv Inbar
See Also:
Serialized Form

Constructor Summary
HttpResponseException(HttpResponse response)
          Constructor that uses computeMessage(HttpResponse) for the detail message.
HttpResponseException(HttpResponse response, String message)
          Constructor that allows an alternative detail message to be used.
 
Method Summary
static String computeMessage(HttpResponse response)
          Deprecated. (scheduled to be removed in 1.8) Use computeMessageBuffer(HttpResponse)
static StringBuilder computeMessageBuffer(HttpResponse response)
          Returns an exception message string builder to use for the given HTTP response.
 HttpHeaders getHeaders()
          Returns the HTTP response headers.
 HttpResponse getResponse()
          Deprecated. (scheduled to be removed in 1.8)
 int getStatusCode()
          Returns the HTTP status code or 0 for none.
 boolean isSuccessStatusCode()
          Returns whether received a successful HTTP status code >= 200 && < 300 (see getStatusCode()).
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

HttpResponseException

public HttpResponseException(HttpResponse response)
Constructor that uses computeMessage(HttpResponse) for the detail message.

Parameters:
response - HTTP response

HttpResponseException

public HttpResponseException(HttpResponse response,
                             String message)
Constructor that allows an alternative detail message to be used.

Parameters:
response - HTTP response
message - detail message to use or null for none
Since:
1.6
Method Detail

getResponse

@Deprecated
public final HttpResponse getResponse()
Deprecated. (scheduled to be removed in 1.8)

Returns the HTTP response.

Since:
1.5

isSuccessStatusCode

public boolean isSuccessStatusCode()
Returns whether received a successful HTTP status code >= 200 && < 300 (see getStatusCode()).

Since:
1.7

getStatusCode

public int getStatusCode()
Returns the HTTP status code or 0 for none.

Since:
1.7

getHeaders

public HttpHeaders getHeaders()
Returns the HTTP response headers.

Since:
1.7

computeMessage

@Deprecated
public static String computeMessage(HttpResponse response)
Deprecated. (scheduled to be removed in 1.8) Use computeMessageBuffer(HttpResponse)

Returns an exception message to use for the given HTTP response.


computeMessageBuffer

public static StringBuilder computeMessageBuffer(HttpResponse response)
Returns an exception message string builder to use for the given HTTP response.

Since:
1.7


Copyright © 2011-2012 Google. All Rights Reserved.