io.sphere.sdk.client

Interface SphereRequest<T>

Type Parameters:

T - the type which is returned in a successful http request.

All Known Subinterfaces:

ApiClientByIdGet, ApiClientCreateCommand, ApiClientDeleteCommand, ApiClientQuery, CartByCustomerIdGet, CartByIdGet, CartByKeyGet, CartCreateCommand, CartDeleteCommand, CartDiscountByIdGet, CartDiscountByKeyGet, CartDiscountCreateCommand, CartDiscountDeleteCommand, CartDiscountQuery, CartDiscountUpdateCommand, CartInStoreByCustomerIdGet, CartInStoreByIdGet, CartInStoreByKeyGet, CartInStoreCreateCommand, CartInStoreDeleteCommand, CartInStoreQuery, CartInStoreUpdateCommand, CartQuery, CartUpdateCommand, CategoryByIdGet, CategoryByKeyGet, CategoryCreateCommand, CategoryDeleteCommand, CategoryQuery, CategoryUpdateCommand, ChannelByIdGet, ChannelCreateCommand, ChannelDeleteCommand, ChannelQuery, ChannelUpdateCommand, Command<T>, CreateCommand<T>, CustomerByEmailTokenGet, CustomerByIdGet, CustomerByKeyGet, CustomerByPasswordTokenGet, CustomerCreateCommand, CustomerDeleteCommand, CustomerGroupByIdGet, CustomerGroupByKeyGet, CustomerGroupCreateCommand, CustomerGroupDeleteCommand, CustomerGroupQuery, CustomerGroupUpdateCommand, CustomerInStoreByEmailTokenGet, CustomerInStoreByIdGet, CustomerInStoreByKeyGet, CustomerInStoreByPasswordTokenGet, CustomerInStoreCreateCommand, CustomerInStoreDeleteCommand, CustomerInStoreQuery, CustomerInStoreUpdateCommand, CustomerQuery, CustomerUpdateCommand, CustomObjectByIdGet<T>, CustomObjectByKeyGet<T>, CustomObjectDeleteCommand<T>, CustomObjectQuery<T>, CustomObjectUpsertCommand<T>, DeleteCommand<T>, DiscountCodeByIdGet, DiscountCodeCreateCommand, DiscountCodeDeleteCommand, DiscountCodeQuery, DiscountCodeUpdateCommand, DraftBasedCreateCommand<T,D>, DraftBasedCreateCommandDsl<T,D,C>, ExtensionByIdGet, ExtensionByKeyGet, ExtensionCreateCommand, ExtensionDeleteCommand, ExtensionQuery, ExtensionUpdateCommand, Get<T>, GetDsl<R,T,C>, Head<T>, HeadDsl<R,T,C>, InventoryEntryByIdGet, InventoryEntryCreateCommand, InventoryEntryDeleteCommand, InventoryEntryQuery, InventoryEntryUpdateCommand, JsonNodeQuery, MessageByIdGet, MessageQuery, MetaModelGetDsl<R,T,C,E>, MetaModelHeadDsl<R,T,C>, MetaModelQueryDsl<T,C,Q,E>, MetaModelSearchDsl<T,C,S,L,F,E>, OrderByIdGet, OrderByOrderNumberGet, OrderDeleteCommand, OrderEditByIdGet, OrderEditByKeyGet, OrderEditCreateCommand, OrderEditDeleteCommand, OrderEditQuery, OrderEditUpdateCommand, OrderFromCartCreateCommand, OrderFromCartInStoreCreateCommand, OrderInStoreByIdGet, OrderInStoreByOrderNumberGet, OrderInStoreDeleteByIdCommand, OrderInStoreDeleteByOrderNumberCommand, OrderInStoreQuery, OrderInStoreUpdateByIdCommand, OrderInStoreUpdateByOrderNumberCommand, OrderQuery, OrderUpdateCommand, PaymentByIdGet, PaymentByKeyGet, PaymentCreateCommand, PaymentDeleteCommand, PaymentQuery, PaymentUpdateCommand, ProductByIdGet, ProductByIdHead, ProductByIdProductSelectionGet, ProductByKeyGet, ProductByKeyHead, ProductByKeyProductSelectionGet, ProductCreateCommand, ProductDeleteCommand, ProductDiscountByIdGet, ProductDiscountByKeyGet, ProductDiscountCreateCommand, ProductDiscountDeleteCommand, ProductDiscountQuery, ProductDiscountUpdateCommand, ProductProjectionByIdGet, ProductProjectionByKeyGet, ProductProjectionInStoreByIdGet, ProductProjectionInStoreByKeyGet, ProductProjectionInStoreQuery, ProductProjectionQuery, ProductProjectionSearch, ProductQuery, ProductSelectionByIdGet, ProductSelectionByIdProductGet, ProductSelectionByIdProductsGet, ProductSelectionByKeyGet, ProductSelectionByKeyProductGet, ProductSelectionByKeyProductsGet, ProductSelectionCreateCommand, ProductSelectionDeleteCommand, ProductSelectionQuery, ProductSelectionUpdateCommand, ProductsHead, ProductTypeByIdGet, ProductTypeByKeyGet, ProductTypeCreateCommand, ProductTypeDeleteCommand, ProductTypeQuery, ProductTypeUpdateCommand, ProductUpdateCommand, ProjectUpdateCommand, Query<T>, QueryDsl<T,C>, ResourceQuery<T>, ResourceSearch<T>, ReviewByIdGet, ReviewByKeyGet, ReviewCreateCommand, ReviewDeleteCommand, ReviewQuery, ReviewUpdateCommand, Search<T>, SearchDsl<T,C>, ShippingMethodByIdGet, ShippingMethodByKeyGet, ShippingMethodCreateCommand, ShippingMethodDeleteCommand, ShippingMethodQuery, ShippingMethodsByCartGet, ShippingMethodsByLocationGet, ShippingMethodsByOrderEditGet, ShippingMethodUpdateCommand, ShoppingListByIdGet, ShoppingListByKeyGet, ShoppingListCreateCommand, ShoppingListDeleteCommand, ShoppingListInStoreByIdGet, ShoppingListInStoreByKeyGet, ShoppingListInStoreCreateCommand, ShoppingListInStoreDeleteCommand, ShoppingListInStoreQuery, ShoppingListInStoreUpdateCommand, ShoppingListQuery, ShoppingListUpdateCommand, StateByIdGet, StateByKeyGet, StateCreateCommand, StateDeleteCommand, StateQuery, StateUpdateCommand, StoreByIdGet, StoreByKeyGet, StoreCreateCommand, StoreDeleteCommand, StoreQuery, StoreUpdateCommand, SubscriptionByIdGet, SubscriptionByKeyGet, SubscriptionCreateCommand, SubscriptionDeleteCommand, SubscriptionQuery, SubscriptionUpdateCommand, SuggestQuery, TaxCategoryByIdGet, TaxCategoryByKeyGet, TaxCategoryCreateCommand, TaxCategoryDeleteCommand, TaxCategoryQuery, TaxCategoryUpdateCommand, TypeByIdGet, TypeCreateCommand, TypeDeleteCommand, TypeQuery, TypeUpdateCommand, UpdateCommand<T>, UpdateCommandDsl<T,C>, ZoneByIdGet, ZoneByKeyGet, ZoneCreateCommand, ZoneDeleteCommand, ZoneQuery, ZoneUpdateCommand

All Known Implementing Classes:

CartInStoreReplicationCommand, CartReplicationCommand, CommandImpl, CorrelationIdRequestDecorator, CreateCommandImpl, CustomerChangePasswordCommand, CustomerCreateEmailTokenCommand, CustomerCreatePasswordTokenCommand, CustomerInStoreChangePasswordCommand, CustomerInStoreCreateEmailTokenCommand, CustomerInStoreCreatePasswordTokenCommand, CustomerInStorePasswordResetCommand, CustomerInStoreSignInCommand, CustomerInStoreVerifyEmailCommand, CustomerPasswordResetCommand, CustomerSignInCommand, CustomerVerifyEmailCommand, CustomObjectCustomJsonMappingByKeyGet, CustomObjectCustomJsonMappingUpsertCommand, JavaAndHttpResponseSphereRequest, JavaAndJsonSphereRequest, JsonNodeSphereRequest, MatchingProductDiscountGet, MetaModelByIdDeleteCommandImpl, MetaModelCreateCommandImpl, MetaModelGetDslImpl, MetaModelHeadDslImpl, MetaModelQueryDslImpl, MetaModelSearchDslImpl, MetaModelUpdateCommandDslImpl, OrderEditApplyCommand, OrderImportCommand, ProductImageUploadCommand, ProjectGet, SphereRequestDecorator

public interface SphereRequest<T>

An argument for a sphere client to execute an HTTP API call on the level of one project.

Typical workflow: A client executes httpRequestIntent() and creates a future of an http response. When the future redeems the client uses the http response and passes it as argument to canDeserialize(HttpResponse). If the call results in true, the client applies deserialize(HttpResponse) to transform the http response into T.

It is intented that this class is immutable, so that every method can be used in a pure functional way.

Method Summary

Modifier and Type	Method and Description
default boolean	canDeserialize(HttpResponse httpResponse) Checks if the response can be handled by deserialize(HttpResponse).
T	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.

Method Detail

deserialize

@Nullable
T deserialize(HttpResponse httpResponse)

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

Parameters:

httpResponse - the http response of the API

Returns:

the deserialized object

httpRequestIntent

HttpRequestIntent httpRequestIntent()

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

Returns:

http request intent

canDeserialize

default boolean canDeserialize(HttpResponse httpResponse)

Checks if the response can be handled by 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.

Parameters:

httpResponse - the http response which shall be transformed

Returns:

true if the http response can be consumed, false otherwise