io.sphere.sdk.client

Class SphereClientConfig

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.SphereClientConfig

All Implemented Interfaces:

SphereApiConfig, SphereAuthConfig, SphereCorrelationIdConfig

public final class SphereClientConfig
extends Base
implements SphereAuthConfig, SphereApiConfig, SphereCorrelationIdConfig

The full api and auth configuration for a Composable Commerce client.

See Also:

SphereClientConfigBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_VARIABLE_API_URL_SUFFIX
static String	ENVIRONMENT_VARIABLE_AUTH_URL_SUFFIX
static String	ENVIRONMENT_VARIABLE_CLIENT_ID_SUFFIX
static String	ENVIRONMENT_VARIABLE_CLIENT_SECRET_SUFFIX
static String	ENVIRONMENT_VARIABLE_PROJECT_KEY_SUFFIX
static String	ENVIRONMENT_VARIABLE_SCOPES_SUFFIX
static String	PROPERTIES_KEY_API_URL_SUFFIX
static String	PROPERTIES_KEY_AUTH_URL_SUFFIX
static String	PROPERTIES_KEY_CLIENT_ID_SUFFIX
static String	PROPERTIES_KEY_CLIENT_SECRET_SUFFIX
static String	PROPERTIES_KEY_PROJECT_KEY_SUFFIX
static String	PROPERTIES_KEY_SCOPES_SUFFIX

Method Summary

Modifier and Type	Method and Description
String	getApiUrl()
String	getAuthUrl() The url of the OAuth server including http protocol and ports.
String	getClientId()
String	getClientSecret()
CorrelationIdGenerator	getCorrelationIdGenerator()
String	getProjectKey()
List<String>	getRawScopes() Gets the scopes which have a more complex structure then the scopes returned by SphereAuthConfig.getScopes().
List<String>	getScopes() Gets the scopes which are permitted.
static SphereClientConfig	of(String projectKey, String clientId, String clientSecret)
static SphereClientConfig	of(String projectKey, String clientId, String clientSecret, String authUrl, String apiUrl)
static SphereClientConfig	of(String projectKey, String clientId, String clientSecret, String authUrl, String apiUrl, CorrelationIdGenerator correlationIdGenerator)
static SphereClientConfig	of(String projectKey, String clientId, String clientSecret, String authUrl, String apiUrl, List<String> scopes)
static SphereClientConfig	ofEnvironmentVariables(String prefix) Creates a SphereClientConfig out of environment variables using prefix as namespace parameter.
static SphereClientConfig	ofProperties(Properties properties, String prefix) Creates a SphereClientConfig using Properties using prefix as namespace parameter.
SphereClientConfig	withApiUrl(String apiUrl)
SphereClientConfig	withAuthUrl(String authUrl)

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

Methods inherited from interface io.sphere.sdk.client.SphereAuthConfig

of

Methods inherited from interface io.sphere.sdk.client.SphereApiConfig

of, of, of

Field Detail

ENVIRONMENT_VARIABLE_API_URL_SUFFIX

public static final String ENVIRONMENT_VARIABLE_API_URL_SUFFIX

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_AUTH_URL_SUFFIX

public static final String ENVIRONMENT_VARIABLE_AUTH_URL_SUFFIX

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_PROJECT_KEY_SUFFIX

public static final String ENVIRONMENT_VARIABLE_PROJECT_KEY_SUFFIX

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_CLIENT_ID_SUFFIX

public static final String ENVIRONMENT_VARIABLE_CLIENT_ID_SUFFIX

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_CLIENT_SECRET_SUFFIX

public static final String ENVIRONMENT_VARIABLE_CLIENT_SECRET_SUFFIX

See Also:

Constant Field Values

ENVIRONMENT_VARIABLE_SCOPES_SUFFIX

public static final String ENVIRONMENT_VARIABLE_SCOPES_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_API_URL_SUFFIX

public static final String PROPERTIES_KEY_API_URL_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_AUTH_URL_SUFFIX

public static final String PROPERTIES_KEY_AUTH_URL_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_PROJECT_KEY_SUFFIX

public static final String PROPERTIES_KEY_PROJECT_KEY_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_CLIENT_ID_SUFFIX

public static final String PROPERTIES_KEY_CLIENT_ID_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_CLIENT_SECRET_SUFFIX

public static final String PROPERTIES_KEY_CLIENT_SECRET_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY_SCOPES_SUFFIX

public static final String PROPERTIES_KEY_SCOPES_SUFFIX

See Also:

Constant Field Values

Method Detail

of

public static SphereClientConfig of(String projectKey,
                                    String clientId,
                                    String clientSecret)

Specified by:

of in interface SphereAuthConfig

of

public static SphereClientConfig of(String projectKey,
                                    String clientId,
                                    String clientSecret,
                                    String authUrl,
                                    String apiUrl)

of

public static SphereClientConfig of(String projectKey,
                                    String clientId,
                                    String clientSecret,
                                    String authUrl,
                                    String apiUrl,
                                    CorrelationIdGenerator correlationIdGenerator)

of

public static SphereClientConfig of(String projectKey,
                                    String clientId,
                                    String clientSecret,
                                    String authUrl,
                                    String apiUrl,
                                    List<String> scopes)

getApiUrl

public String getApiUrl()

Specified by:

getApiUrl in interface SphereApiConfig

getAuthUrl

public String getAuthUrl()

Description copied from interface: SphereAuthConfig

The url of the OAuth server including http protocol and ports.

Specified by:

getAuthUrl in interface SphereAuthConfig

Returns:

url

getClientId

public String getClientId()

Specified by:

getClientId in interface SphereAuthConfig

getClientSecret

public String getClientSecret()

Specified by:

getClientSecret in interface SphereAuthConfig

getProjectKey

public String getProjectKey()

Specified by:

getProjectKey in interface SphereApiConfig

Specified by:

getProjectKey in interface SphereAuthConfig

getCorrelationIdGenerator

public CorrelationIdGenerator getCorrelationIdGenerator()

Specified by:

getCorrelationIdGenerator in interface SphereCorrelationIdConfig

getScopes

public List<String> getScopes()

Gets the scopes which are permitted.

final SphereClientConfig config = SphereClientConfigBuilder
        .ofKeyIdSecret("projectKey", "clientId", "clientSecret")
        .scopes(asList(SphereProjectScope.MANAGE_CUSTOMERS, SphereProjectScope.VIEW_ORDERS))
        .build();
assertThat(config.getScopes()).containsExactly("manage_customers", "view_orders");
See the test code.

Specified by:

getScopes in interface SphereAuthConfig

Returns:

scopes

getRawScopes

public List<String> getRawScopes()

Description copied from interface: SphereAuthConfig

Gets the scopes which have a more complex structure then the scopes returned by SphereAuthConfig.getScopes(). Whereas SphereAuthConfig.getScopes() returns scopes that have a specific simple structure which contains only {projectKey} (e.g manage_project:{projectKey}), this method can also return scopes with different structure (e.g manage_orders:{projectKey}:{storeKey}).

Specified by:

getRawScopes in interface SphereAuthConfig

Returns:

scopes

withApiUrl

public SphereClientConfig withApiUrl(String apiUrl)

withAuthUrl

public SphereClientConfig withAuthUrl(String authUrl)

ofEnvironmentVariables

public static SphereClientConfig ofEnvironmentVariables(String prefix)

Creates a SphereClientConfig out of environment variables using prefix as namespace parameter. An example environment variable initialization with "EXAMPLE" as prefix:

    export EXAMPLE_PROJECT_KEY="YOUR project key"
    export EXAMPLE_CLIENT_ID="YOUR client id"
    export EXAMPLE_CLIENT_SECRET="YOUR client secret"
    export EXAMPLE_AUTH_URL="https://auth.europe-west1.gcp.commercetools.com" #optional parameter
    export EXAMPLE_API_URL="https://api.europe-west1.gcp.commercetools.com" #optional parameter
    export EXAMPLE_SCOPES="manage_project" #optional parameter
    #separate multiple elements with a comma
    #export EXAMPLE_SCOPES="manage_customers,view_orders"
    

The possible suffixes are "PROJECT_KEY", "CLIENT_ID", "CLIENT_SECRET", "AUTH_URL", "API_URL" and "SCOPES".

Parameters:

prefix - prefix of the environment variables

Returns:

a new SphereClientConfig containing the values of the environment variables.

ofProperties

public static SphereClientConfig ofProperties(Properties properties,
                                              String prefix)

Creates a SphereClientConfig using Properties using prefix as namespace parameter. An example properties file with "commercetools." (including the dot) as prefix:

    commercetools.projectKey=YOUR project key without quotes
    commercetools.clientId=YOUR client id without quotes
    commercetools.clientSecret=YOUR client secret without quotes
    #optional:
    commercetools.authUrl=https://auth.europe-west1.gcp.commercetools.com
    commercetools.apiUrl=https://api.europe-west1.gcp.commercetools.com
    commercetools.scopes=manage_project
    #separate multiple scopes with a comma
    #commercetools.scopes=manage_customers,view_orders
    

The possible suffixes are "projectKey", "clientId", "clientSecret", "authUrl", "apiUrl" and "scopes".

Parameters:

properties - properties containing the Composable Commerce HTTP API credentials

prefix - prefix of the property keys

Returns:

a new SphereClientConfig containing the values of the properties.