io.sphere.sdk.meta

Class ExceptionDocumentation

java.lang.Object

io.sphere.sdk.meta.ExceptionDocumentation

public final class ExceptionDocumentation
extends Object

The exception hierarchy documentation.

Exceptions

Open the exception hierarchy image in a new tab.

The JVM SDK makes use of exceptions of the Java JDK, such as IllegalArgumentException, and provides own exceptions which all inherit from SphereException.

Problems concerning the HttpClient throw a HttpException.

JSON serializing and deserializing problems throw JsonException.

SphereServiceException is a base exception for all error responses from the commercetools Composable Commerce APIs (HTTP status code >= 400).

ClientErrorException expresses errors which can be recovered by the client side (HTTP status code >= 400 and < 500). ServerErrorException is for server errors.

Errors

If a command cannot be performed due to unfulfilled preconditions the system can return one error response with multiple errors (listing of error codes). The JVM SDK will then put a ErrorResponseException into a CompletionStage. The following example shows how to distinguish errors by error code:

final String wrongPassword = "wrong password";
final CustomerSignInCommand signInCommand = CustomerSignInCommand.of(email, wrongPassword);
final CompletionStage<CustomerSignInResult> future = client.execute(signInCommand);
future.whenCompleteAsync((signInResult, exception) -> {
    if (signInResult != null) {
        println("Signing worked");
    } else if (exception instanceof ErrorResponseException) {
        final ErrorResponseException errorResponseException = (ErrorResponseException) exception;
        final String code = CustomerInvalidCredentials.CODE;
        if (errorResponseException.hasErrorCode(code)) {
            println("customer has invalid credentials");
        }
    }
});
See the test code.

Errors can contain extra information like InvalidJsonInputError hinting to the problem with the JSON:

final String json = "{\n" +
        "  \"statusCode\" : 400,\n" +
        "  \"message\" : \"Request body does not contain valid JSON.\",\n" +
        "  \"errors\" : [ {\n" +
        "    \"code\" : \"InvalidJsonInput\",\n" +
        "    \"message\" : \"Request body does not contain valid JSON.\",\n" +
        "    \"detailedErrorMessage\" : \"detailed error message\"" +
        "  } ]\n" +
        "}";
final ErrorResponse sphereErrorResponse = SphereJsonUtils.readObject(json, ErrorResponse.typeReference());
final InvalidJsonInputError jsonError = sphereErrorResponse.getErrors().get(0).as(InvalidJsonInputError.class);


assertThat(jsonError.getDetailedErrorMessage()).isEqualTo("detailed error message");
See the test code.

See Also:

SphereException

Method Summary

Methods inherited from class java.lang.Object

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