io.sphere.sdk.client

Class JavaAndHttpResponseSphereRequest<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.JavaAndHttpResponseSphereRequest<T>

Type Parameters:

T - the Java class of the originals SphereRequests result.

All Implemented Interfaces:

SphereRequest<org.apache.commons.lang3.tuple.Pair<T,HttpResponse>>

public final class JavaAndHttpResponseSphereRequest<T>
extends Base
implements SphereRequest<org.apache.commons.lang3.tuple.Pair<T,HttpResponse>>

A wrapper for a SphereRequest to receive the Java object as well as the HttpResponse representation.

withCategory(client(), category -> {
    final CategoryByIdGet originalRequest = CategoryByIdGet.of(category);
    final JavaAndHttpResponseSphereRequest<Category> request =
            JavaAndHttpResponseSphereRequest.of(originalRequest);
    final Pair<Category, HttpResponse> result = client().executeBlocking(request);
    final Category categoryJavaObject = result.getLeft();
    final HttpResponse httpResponse = result.getRight();
    assertThat(categoryJavaObject).isEqualTo(category);
    assertThat(httpResponse.getHeaders().findFlatHeader(HttpHeaders.CONTENT_TYPE).get())
            .contains("application/json");
});
See the test code.

Method Summary

Modifier and Type	Method and Description
boolean	canDeserialize(HttpResponse httpResponse) Checks if the response can be handled by SphereRequest.deserialize(HttpResponse).
org.apache.commons.lang3.tuple.Pair<T,HttpResponse>	deserialize(HttpResponse httpResponse) Takes an http response and maps it into a Java object of type T.
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
static <T> JavaAndHttpResponseSphereRequest<T>	of(SphereRequest<T> delegate)

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> JavaAndHttpResponseSphereRequest<T> of(SphereRequest<T> delegate)

deserialize

@Nullable
public org.apache.commons.lang3.tuple.Pair<T,HttpResponse> deserialize(HttpResponse httpResponse)

Description copied from interface: SphereRequest

Takes an http response and maps it into a Java object of type T. Before calling this method, check with SphereRequest.canDeserialize(HttpResponse) if the response can be consumed.

Specified by:

deserialize in interface SphereRequest<org.apache.commons.lang3.tuple.Pair<T,HttpResponse>>

Parameters:

httpResponse - the http response of the API

Returns:

the deserialized object

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Specified by:

httpRequestIntent in interface SphereRequest<org.apache.commons.lang3.tuple.Pair<T,HttpResponse>>

Returns:

http request intent

canDeserialize

public boolean canDeserialize(HttpResponse httpResponse)

Description copied from interface: SphereRequest

Checks if the response can be handled by SphereRequest.deserialize(HttpResponse). Use case 1: A http response returns 404 and the this SphereRequest can handle this error by returning an empty optional, an empty list or throwing a domain specific exception.

Specified by:

canDeserialize in interface SphereRequest<org.apache.commons.lang3.tuple.Pair<T,HttpResponse>>

Parameters:

httpResponse - the http response which shall be transformed

Returns:

true if the http response can be consumed, false otherwise