io.sphere.sdk.client

Class ForbiddenException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.sphere.sdk.models.SphereException

io.sphere.sdk.client.SphereServiceException

io.sphere.sdk.client.ClientErrorException

io.sphere.sdk.client.ForbiddenException

All Implemented Interfaces:

Serializable

public class ForbiddenException
extends ClientErrorException

The commercetools Composable Commerce API received the request but refuses to process it, typically to insufficient rights. For example it happens if an access token has been received to view products but a request to the customers endpoint is requested.

final List<SphereScope> scopes = singletonList(SphereProjectScope.VIEW_PRODUCTS);

ApiClientFixtures.withApiClient(client(), scopes, apiClient -> {
    final SphereClientConfig clientConfig = toSphereClientConfig(getSphereClientConfig(), apiClient);
    try (final SphereClient client = SphereClientFactory.of(IntegrationTest::newHttpClient)
            .createClient(clientConfig)) {
        assertThatThrownBy(() -> {
            final CustomerQuery request = CustomerQuery.of();
            SphereClientUtils.blockingWait(client.execute(request), 5, SECONDS);
        })
                .as("since the allowed scope is only to view products, customer data should not be loadable")
                .isInstanceOf(ForbiddenException.class);
    }
});
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
ForbiddenException()
ForbiddenException(String message)
ForbiddenException(String message, Throwable cause)

Method Summary

Methods inherited from class io.sphere.sdk.client.SphereServiceException

getJsonBody, 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

ForbiddenException

public ForbiddenException(String message,
                          Throwable cause)

ForbiddenException

public ForbiddenException(String message)

ForbiddenException

public ForbiddenException()