io.sphere.sdk.client

Class SphereServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.sphere.sdk.models.SphereException

io.sphere.sdk.client.SphereServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClientErrorException, ServerErrorException

public abstract class SphereServiceException
extends SphereException

Exception thrown when the API responds
with a status code other than HTTP 2xx.

For inspiration how to create exceptions in unit tests:

import io.sphere.sdk.client.*;

import io.sphere.sdk.http.HttpResponse;

import io.sphere.sdk.projects.queries.ProjectGet;

import org.junit.Test;

import java.time.Duration;

import static org.assertj.core.api.Assertions.assertThat;

import static org.assertj.core.api.AssertionsForClassTypes.catchThrowable;

public class ServerErrorExceptionDemoTest {
    @Test
    public void httpCodesAndTheCorrespondingExceptions() {
        httpCodeExpectedResult(500, InternalServerErrorException.class);
        httpCodeExpectedResult(502, BadGatewayException.class);
        httpCodeExpectedResult(503, ServiceUnavailableException.class);
        httpCodeExpectedResult(504, GatewayTimeoutException.class);
    }

    public static BlockingSphereClient clientForStatusCode(final int statusCode) {
        final SphereClient sphereClient = TestDoubleSphereClientFactory
                .createHttpTestDouble(intent -> HttpResponse.of(statusCode));
        return BlockingSphereClient.of(sphereClient, Duration.ofMillis(100));
    }

    private void httpCodeExpectedResult(final int statusCode, final Class<? extends ServerErrorException> type) {
        final Throwable throwable = catchThrowable(() ->
                clientForStatusCode(statusCode).executeBlocking(ProjectGet.of()));
        assertThat(throwable).isInstanceOf(type);
    }
}
See the test code.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.sphere.sdk.models.SphereException

httpResponse

Constructor Summary

Constructors

Constructor and Description
SphereServiceException(Integer statusCode)
SphereServiceException(String message, Integer statusCode)
SphereServiceException(String message, Throwable cause, Integer statusCode)
SphereServiceException(Throwable cause, Integer statusCode)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getJsonBody()
Integer	getStatusCode()

Methods inherited from class io.sphere.sdk.models.SphereException

addNote, getAdditionalNotes, getHttpResponse, getMessage, getProjectKey, getSphereRequest, httpSummary, setHttpRequest, setProjectKey, setSphereRequest, setUnderlyingHttpResponse

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SphereServiceException

public SphereServiceException(Integer statusCode)

SphereServiceException

public SphereServiceException(String message,
                              Integer statusCode)

SphereServiceException

public SphereServiceException(Throwable cause,
                              Integer statusCode)

SphereServiceException

public SphereServiceException(String message,
                              Throwable cause,
                              Integer statusCode)

Method Detail

getStatusCode

public Integer getStatusCode()

getJsonBody

@Nullable
public final com.fasterxml.jackson.databind.JsonNode getJsonBody()