io.sphere.sdk.client.SphereAuthConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-base Show documentation
The newest version!
package io.sphere.sdk.client;

import java.util.List;
import java.util.stream.Collectors;

import static io.sphere.sdk.client.ClientPackage.AUTH_URL;
import static io.sphere.sdk.client.ClientPackage.DEFAULT_SCOPES;

/**
 * Contains the configuration to fetch access keys for the Composable Commerce API.
 *
 * @see SphereAuthConfigBuilder
 */
public interface SphereAuthConfig {
    /**
     * The url of the OAuth server including http protocol and ports.
     * @return url
     */
    String getAuthUrl();

    String getClientId();

    String getClientSecret();

    String getProjectKey();

    /**
     * Gets the scopes which are permitted.
     *
     * {@include.example io.sphere.sdk.client.SphereAuthConfigBuilderTest#scopes()}
     *
     * On insufficient permissions on executing requests {@link ForbiddenException} will be thrown:
     *
     * {@include.example io.sphere.sdk.errors.SphereExceptionIntegrationTest#permissionsExceeded()}
     *
     * @return scopes
     */
    default List getScopes() {
        return DEFAULT_SCOPES;
    }

    /**
     * Gets the scopes which have a more complex structure then the scopes returned by {@link SphereAuthConfig#getScopes()}.
     * Whereas {@link 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}).
     * @return scopes
     */
    default List getRawScopes() {
        return DEFAULT_SCOPES.stream().map(s -> s + ":" + getProjectKey()).collect(Collectors.toList());
    }

    static SphereAuthConfig of(final String projectKey, final String clientId, final String clientSecret) {
        return of(projectKey, clientId, clientSecret, AUTH_URL);
    }

    static SphereAuthConfig of(final String projectKey, final String clientId, final String clientSecret, final String authUrl) {
        return new SphereAuthConfigImpl(projectKey, clientId, clientSecret, authUrl, DEFAULT_SCOPES);
    }
}