io.orchestrate.client

Class RequestException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.orchestrate.client.ClientException

io.orchestrate.client.RequestException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ApiBadRequestException, InvalidApiKeyException, ItemAlreadyPresentException, ItemVersionMismatchException, PatchConflictException

public class RequestException
extends ClientException

An object that stores information about a failed Client request.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Method Summary

Modifier and Type	Method and Description
java.util.Map	getDetails() If the error from Orchestrate includes a details map, it will be exposed here.
java.lang.String	getInfo() 'info' is a commonly included detail for Orchestrate errors.
java.lang.String	getLocator() The locator code in the response, if present.
java.lang.String	getRawResponse() Returns the raw response body that the Orc service returned.
java.lang.String	getRequestId() Returns the HTTP response ID from the failed request.
int	getStatusCode() Returns the HTTP status code from the failed request.

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

Field Detail

MAPPER

protected static com.fasterxml.jackson.databind.ObjectMapper MAPPER

Method Detail

getStatusCode

public int getStatusCode()

Returns the HTTP status code from the failed request.

Returns:

The HTTP status code from the failed request.

getRequestId

public java.lang.String getRequestId()

Returns the HTTP response ID from the failed request.

The response ID is used to help with debugging the query in the Orchestrate.io service.

Returns:

The HTTP response ID from the failed request.

getDetails

public java.util.Map getDetails()

If the error from Orchestrate includes a details map, it will be exposed here.

Returns:

The details map from the response, or null if there is not one.

getLocator

public java.lang.String getLocator()

The locator code in the response, if present. The locator code can be useful to help with debugging when working with Orchestrate support.

Returns:

The locator code from the response, null if not present.

getRawResponse

public java.lang.String getRawResponse()

Returns the raw response body that the Orc service returned. This is useful for cases where the orc service introduces new fields in error responses that the client version currently in use does not explicitly expose.

Returns:

The raw response body. This will usually be JSON, but in some unexpected cases it may be html or plain text.

getInfo

public java.lang.String getInfo()

'info' is a commonly included detail for Orchestrate errors. Exposed here for convenience.

Returns:

The details.info entry, if present.