Package com.vonage.client

Class VonageApiResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.vonage.client.VonageClientException

com.vonage.client.VonageApiResponseException

All Implemented Interfaces:

Jsonable, Serializable

Direct Known Subclasses:

AccountResponseException, ApplicationResponseException, CamaraResponseException, ConversationsResponseException, MeetingsResponseException, MessageResponseException, NetworkAuthResponseException, NumberInsight2ResponseException, NumbersResponseException, ProactiveConnectResponseException, RedactResponseException, SubaccountsResponseException, UsersResponseException, VerifyResponseException, VideoResponseException, VoiceResponseException

public class VonageApiResponseException
extends VonageClientException
implements Jsonable

Base class for exceptions which represent an error API response conforming to RFC 7807 standard.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	code
protected String	detail
protected String	errorCode
protected String	errorCodeLabel
protected List<?>	errors
protected String	instance
protected List<?>	invalidParameters
protected int	statusCode
protected String	title
protected URI	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VonageApiResponseException()
protected	VonageApiResponseException(String message)
protected	VonageApiResponseException(String message, Throwable cause)
protected	VonageApiResponseException(Throwable cause)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
protected static <E extends VonageApiResponseException> E	fromJson(Class<E> clazz, String json)
String	getCode()	Name of the error code.
String	getDetail()	Extended description of the error, explaining the cause.
String	getErrorCodeLabel()	The status code description.
List<?>	getErrors()	Additional description of problems encountered with the request.
String	getInstance()	Internal trace ID of the request.
List<?>	getInvalidParameters()	If the request was rejected due to invalid parameters, this will return the offending parameters, sometimes along with a description of the errors.
String	getMessage()
int	getStatusCode()	The API response status code, usually 4xx or 500.
String	getTitle()	Brief description / name of the error.
URI	getType()	Link to the API error type.
int	hashCode()
String	toJson()	Generates JSON from this object.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

updateFromJson

Field Details

type

protected URI type

title

protected String title

detail

protected String detail

instance

protected String instance

code

protected String code

errorCodeLabel

protected String errorCodeLabel

errorCode

protected String errorCode

errors

protected List<?> errors

invalidParameters

protected List<?> invalidParameters

statusCode

protected int statusCode

Constructor Details

VonageApiResponseException

protected VonageApiResponseException()

VonageApiResponseException

protected VonageApiResponseException(String message)

VonageApiResponseException

protected VonageApiResponseException(String message,
 Throwable cause)

VonageApiResponseException

protected VonageApiResponseException(Throwable cause)

Method Details

getErrorCodeLabel

public String getErrorCodeLabel()

The status code description.

Returns:

The error code label, or null if unknown.

getType

public URI getType()

Link to the API error type.

Returns:

URL of the error type / description.

getTitle

public String getTitle()

Brief description / name of the error.

Returns:

The error title.

getDetail

public String getDetail()

Extended description of the error, explaining the cause.

Returns:

The detailed error description.

getInstance

public String getInstance()

Internal trace ID of the request.

Returns:

The instance ID.

getErrors

public List<?> getErrors()

Additional description of problems encountered with the request. This is typically only applicable to 400 or 409 error codes.

Returns:

The list of errors returned from the server (could be a Map or String), or null if none / not applicable.

getInvalidParameters

public List<?> getInvalidParameters()

If the request was rejected due to invalid parameters, this will return the offending parameters, sometimes along with a description of the errors.

Returns:

The list of invalid parameters, typically as a Map, or null if not applicable.

Since:

7.7.0

getCode

public String getCode()

Name of the error code.

Returns:

The Vonage error code as a string, or null if unknown / not applicable.

getStatusCode

public int getStatusCode()

The API response status code, usually 4xx or 500.

Returns:

The status code.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toJson

public String toJson()

Generates JSON from this object. Excludes fields inherited from superclasses.

Specified by:

toJson in interface Jsonable

Returns:

The JSON representation of this response object.

fromJson

protected static <E extends VonageApiResponseException>
E fromJson(Class<E> clazz,
 String json)