net.leanix.api.common

Class ApiClientBuilder

java.lang.Object

net.leanix.api.common.ApiClientBuilder

public class ApiClientBuilder
extends Object

Convenient Builder classed which helps to create and setup a new 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

Constructor Summary

Constructors

Constructor and Description
ApiClientBuilder()

Method Summary

Modifier and Type	Method and Description
ApiClient	build()
ApiClientBuilder	withApiKey(String apiKey)
ApiClientBuilder	withApiToken(String apiToken) Set the API token that is used to retrieve an access token.
ApiClientBuilder	withBasePath(String basePath) Set the base url that is used to access your service.
ApiClientBuilder	withClientCredentials(String clientId, String clientSecret) Sets your client Id and client Secret.
ApiClientBuilder	withDebugging(boolean debugging)
ApiClientBuilder	withOAuth2TokenUrl(URI uri) Sets the url that is used when a new access token will be fetched with specified client id and client secret.
ApiClientBuilder	withPersonalAccessToken(String personalAccessToken) Deprecated. use withApiToken(String) instead
ApiClientBuilder	withTokenProviderHost(String host) Specifies all urls needed to get an access token based on given host name and common url naming convention.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiClientBuilder

public ApiClientBuilder()

Method Detail

build

public ApiClient build()

withBasePath

public ApiClientBuilder withBasePath(String basePath)

Set the base url that is used to access your service. EG: https://test-app.leanix.net/services/metrics/v1

Parameters:

basePath -

Returns:

withTokenProviderHost

public ApiClientBuilder withTokenProviderHost(String host)

Specifies all urls needed to get an access token based on given host name and common url naming convention.

Parameters:

host -

Returns:

withClientCredentials

public ApiClientBuilder withClientCredentials(String clientId,
                                              String clientSecret)

Sets your client Id and client Secret.

Parameters:

clientId -

clientSecret -

Returns:

withApiToken

public ApiClientBuilder withApiToken(String apiToken)

Set the API token that is used to retrieve an access token.

Returns:

this

withPersonalAccessToken

public ApiClientBuilder withPersonalAccessToken(String personalAccessToken)

Deprecated. use withApiToken(String) instead

Set the personal access token that is used to retrieve an access token. Only for backward compatibility, use withApiToken instead.

Parameters:

personalAccessToken -

Returns:

withOAuth2TokenUrl

public ApiClientBuilder withOAuth2TokenUrl(URI uri)

Sets the url that is used when a new access token will be fetched with specified client id and client secret.

Parameters:

uri -

Returns:

withDebugging

public ApiClientBuilder withDebugging(boolean debugging)

withApiKey

public ApiClientBuilder withApiKey(String apiKey)