com.urbanairship.api.client

Class RequestError

java.lang.Object

com.urbanairship.api.client.RequestError

public final class RequestError
extends java.lang.Object

Error object for API requests. This is populated the as many details as are possible at the time of the error. Optional values from Google Guava are used in place of values that may not be present.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestError.Builder Builds an APIError.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static RequestError	errorFromResponse(java.lang.String body, java.lang.String contentType) Create an APIError from the response if it conforms to the API v3 Currently, three types of error bodies are returned, text/html strings, basic JSON errors {"error":"message"} and the v3 error spec.
java.util.Optional<RequestErrorDetails>	getDetails() Returns the details of this error if error details are available from the API.
java.lang.String	getError() Returns a description of the error
java.util.Optional<java.lang.Number>	getErrorCode() Returns an error code specific to the Urban Airship.
boolean	getOk()
java.util.Optional<java.lang.String>	getOperationId() Returns the operation id for the error.
int	hashCode()
static RequestError.Builder	newBuilder() Returns a APIError Builder
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

errorFromResponse

public static RequestError errorFromResponse(java.lang.String body,
                                             java.lang.String contentType)
                                      throws java.io.IOException

Create an APIError from the response if it conforms to the API v3 Currently, three types of error bodies are returned, text/html strings, basic JSON errors {"error":"message"} and the v3 error spec. This method parses between three, and returns a best effort response.

Parameters:

body - Response body for the request that caused the exception

contentType - String

Returns:

APIError

Throws:

java.io.IOException - if it fails reading the error

newBuilder

public static RequestError.Builder newBuilder()

Returns a APIError Builder

Returns:

Builder

getOk

public boolean getOk()

getOperationId

public java.util.Optional<java.lang.String> getOperationId()

Returns the operation id for the error. This value is useful for debugging errors within the Urban Airship system, and should be sent to UA support in cases where there is an issue. This value may be absent.

Returns:

Optional Operation ID

getError

public java.lang.String getError()

Returns a description of the error

Returns:

Optional error description.

getErrorCode

public java.util.Optional<java.lang.Number> getErrorCode()

Returns an error code specific to the Urban Airship. This value may be absent.

Returns:

Optional error code

getDetails

public java.util.Optional<RequestErrorDetails> getDetails()

Returns the details of this error if error details are available from the API. Currently errors from requests that are syntactically valid but otherwise malformed, (missing fields, incompatible parameters, etc) should return details to help identify the issue.

Returns:

Optional details object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object