net.leanix.dropkit.apiclient.ApiClientBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of leanix-mtm-sdk-java Show documentation
SDK for Java to access leanIX MTM REST API
There is a newer version: 1.7.25
package net.leanix.dropkit.apiclient;

import java.net.URI;

/**
 * Convenient Builder classed which helps to create and setup a new {@linkplain ApiClient} instance.
 * 
 *  * e.g. Create a ApiClient for metrics service using a personal access token for authorization:
 * 
 * String host = "test-app.leanix.net";
 * ApiClient apiClient = new ApiClientBuilder()
 *              .withBasePath(String.format("https://%s/services/metrics/v1", host))
 *              .withTokenProviderHost(host)
 *              .withPersonalAccessToken("my Personal Access Token")
 *              .withDebugging(true).build();
 * 
 * 
 * @author ralfwehner
 *
 */
public class ApiClientBuilder {

    private String basePath;

    private URI oauth2TokenUri;

    private String clientId;
    private String clientSecret;

    private String apiToken;

    private boolean debugging = false;

    public ApiClient build() {

        if (basePath == null) {
            throw new RuntimeException("Missing to specify the base path of ApiClient!");
        }
        ApiClient apiClient = new ApiClient();

        apiClient.setDebugging(debugging);
        if (apiToken != null && !apiToken.isEmpty()) {
            apiClient.setApiToken(apiToken, oauth2TokenUri);
        } else if (clientId != null && clientSecret != null) {
            apiClient.setClientCredentials(clientId, clientSecret, oauth2TokenUri);
        }
        apiClient.setBasePath(basePath);

        return apiClient;
    }

    /**
     * Sets the base url that is used to access your service. EG: https://test-app.leanix.net/services/metrics/v1
     * 
     * @param basePath
     * @return
     */
    public ApiClientBuilder withBasePath(String basePath) {
        this.basePath = basePath;
        return this;
    }

    /**
     * Specifies all urls needed to get an access token based on given host name and common url naming convention.
     * 
     * @param host
     * @return
     */
    public ApiClientBuilder withTokenProviderHost(String host) {
        withOAuth2TokenUrl(URI.create(String.format("https://%s/services/mtm/v1/oauth2/token", host)));
        return this;
    }

    /**
     * Sets your client Id and client Secret.
     * 
     * @param clientId
     * @param clientSecret
     * @return
     */
    public ApiClientBuilder withClientCredentials(String clientId, String clientSecret) {
        this.clientId = clientId;
        this.clientSecret = clientSecret;
        return this;
    }

    /**
     * Set the API token that is used to retrieve an access token.
     *
     * @return this
     */
    public ApiClientBuilder withApiToken(String apiToken) {
        this.apiToken = apiToken;
        return this;
    }

    /**
     * Set the personal access token that is used to retrieve an access token. Only for backward compatibility, use withApiToken instead.
     *
     * @param personalAccessToken
     * @return this
     * @deprecated use {@linkplain #withApiToken(String)} instead
     */
    public ApiClientBuilder withPersonalAccessToken(String personalAccessToken) {
        this.apiToken = personalAccessToken;
        return this;
    }

    /**
     * Sets the url that is used when a new access token will be fetched with specified client id and client secret. This oauth2TokenUri
     * must only be set if the automatically created url in {@linkplain #withTokenProviderHost(String)} does not fit.
     * 
     * @param uri
     * @return
     */
    public ApiClientBuilder withOAuth2TokenUrl(URI uri) {
        this.oauth2TokenUri = uri;
        return this;
    }

    public ApiClientBuilder withDebugging(boolean debugging) {
        this.debugging = debugging;
        return this;
    }
}