io.sphere.sdk.client

Interface SphereClientFactory

public interface SphereClientFactory

A factory to instantiate Composable Commerce Java clients which use CompletionStage as future implementation.

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.

Method Summary

Modifier and Type	Method and Description
default SphereClient	createClient(SphereApiConfig config, SphereAccessTokenSupplier tokenSupplier) Creates a client with a custom service to provide access tokens.
default SphereClient	createClient(SphereClientConfig config) Creates a standard client with configurable service URLs.
default SphereClient	createClient(String projectKey, String clientId, String clientSecret) Creates a standard client suitable for online shops.
default SphereClient	createClient(String projectKey, String clientId, String clientSecret, String authUrl, String apiUrl) Creates a standard client suitable for online shops.
default SphereClient	createClientOfApiConfigAndAccessToken(SphereApiConfig config, String accessToken) Creates a client which relies on an access token and does not refresh it.
default SphereClient	createClientOfApiConfigAndAccessToken(SphereApiConfig config, String accessToken, HttpClient httpClient) Creates a client which relies on an access token and does not refresh it, it reuses an existing http client.
HttpClient	createHttpClient()
static SphereClientFactory	of()
static SphereClientFactory	of(Supplier<HttpClient> httpClientSupplier)

Method Detail

createHttpClient

HttpClient createHttpClient()

createClient

default SphereClient createClient(SphereClientConfig config)

Creates a standard client with configurable service URLs. Intended for commercetools staff developing with a custom Composable Commerce instance.

Parameters:

config - configuration for the client

Returns:

client

createClient

default SphereClient createClient(SphereApiConfig config,
                                  SphereAccessTokenSupplier tokenSupplier)

Creates a client with a custom service to provide access tokens.

Parameters:

config - the configuration to use the API

tokenSupplier - a service which provides tokens

Returns:

client

createClient

default SphereClient createClient(String projectKey,
                                  String clientId,
                                  String clientSecret)

Creates a standard client suitable for online shops. For the credentials consult the Merchant Center.

Parameters:

projectKey - the project identifier

clientId - username

clientSecret - password

Returns:

sphere client

createClient

default SphereClient createClient(String projectKey,
                                  String clientId,
                                  String clientSecret,
                                  String authUrl,
                                  String apiUrl)

Creates a standard client suitable for online shops. For the credentials consult the Merchant Center.

Parameters:

projectKey - the project identifier

clientId - username

clientSecret - password

authUrl - authentication url for the Api

apiUrl - api url for the Api

Returns:

sphere client

createClientOfApiConfigAndAccessToken

default SphereClient createClientOfApiConfigAndAccessToken(SphereApiConfig config,
                                                           String accessToken,
                                                           HttpClient httpClient)

Creates a client which relies on an access token and does not refresh it, it reuses an existing http client. A possible use case is keeping the clientSecret secret and/or instantiate a client which is used for few requests for a limited time. The underlying http client does not get closed by closing the client

Parameters:

config - the configuration to use the API

accessToken - the token belonging to the project in config

httpClient - the http client used for performing requests

Returns:

client

createClientOfApiConfigAndAccessToken

default SphereClient createClientOfApiConfigAndAccessToken(SphereApiConfig config,
                                                           String accessToken)

Creates a client which relies on an access token and does not refresh it. A possible use case is keeping the clientSecret secret and/or instantiate a client which is used for few requests for a limited time.

Parameters:

config - the configuration to use the API

accessToken - the token belonging to the project in config

Returns:

client

of

static SphereClientFactory of(Supplier<HttpClient> httpClientSupplier)

of

static SphereClientFactory of()