io.sphere.sdk.client

Interface SphereClient

Table of Contents

• Instantiation
• Example call

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

BlockingSphereClient, RetrySphereClientDecorator

All Known Implementing Classes:

DeprecationExceptionSphereClientDecorator, QueueSphereClientDecorator, SimpleMetricsSphereClient, SphereClientDecorator, TimeoutSphereClientDecorator

public interface SphereClient
extends AutoCloseable

A client interface to perform requests to Composable Commerce.

Instantiation

import io.sphere.sdk.client.SphereClient;

import io.sphere.sdk.client.SphereClientFactory;

public class JavaClientInstantiationExample {
    public void instantiate() {
        final SphereClientFactory factory = SphereClientFactory.of();
        final SphereClient client = factory.createClient(
                "jvm-sdk-dev-1", //replace with your project key
                "ELqF0rykXD2fyS8s-IhIPKfQ", //replace with your client id
                "222222222222222222222222222222226"); //replace with your client secret
    }
}
See the test code.

Example call

CompletionStage<PagedQueryResult<TaxCategory>> future = client.execute(TaxCategoryQuery.of().byName("de19"));
See the test code.

Refer to resources for known Composable Commerce requests.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the client to save resources like connections and threads.
<T> CompletionStage<T>	execute(SphereRequest<T> sphereRequest) Executes asynchronously a request to Composable Commerce.
SphereApiConfig	getConfig() Getter for the SphereApiConfig used for this client
static SphereClient	of(SphereApiConfig config, HttpClient httpClient, SphereAccessTokenSupplier tokenSupplier) Raw client creation.
static SphereClient	of(SphereApiConfig config, HttpClient httpClient, SphereAccessTokenSupplier tokenSupplier, List<SolutionInfo> additionalSolutionInfos) Raw client creation.

Method Detail

execute

<T> CompletionStage<T> execute(SphereRequest<T> sphereRequest)

Executes asynchronously a request to Composable Commerce. By default it does not have a timeout.

Type Parameters:

T - type of the result for the request

Parameters:

sphereRequest - request to Composable Commerce to perform

Returns:

future monad which can contain the result or an exception

close

void close()

Shuts down the client to save resources like connections and threads.

Specified by:

close in interface AutoCloseable

of

static SphereClient of(SphereApiConfig config,
                       HttpClient httpClient,
                       SphereAccessTokenSupplier tokenSupplier)

Raw client creation. See also SphereClientFactory.

Parameters:

config - Project and location

httpClient - client to execute requests

tokenSupplier - delivery of access tokens

Returns:

sphere client

of

static SphereClient of(SphereApiConfig config,
                       HttpClient httpClient,
                       SphereAccessTokenSupplier tokenSupplier,
                       List<SolutionInfo> additionalSolutionInfos)

Raw client creation. See also SphereClientFactory.

Parameters:

config - Project and location

httpClient - client to execute requests

tokenSupplier - delivery of access tokens

Returns:

sphere client

getConfig

SphereApiConfig getConfig()

Getter for the SphereApiConfig used for this client

Returns:

the configuration used for this client

See Also:

SphereApiConfig