ClientBuilder (rmf-java-base 6.2.3 API)

java.lang.Object
- io.vrap.rmf.base.client.ClientBuilder

All Implemented Interfaces:

Builder<ApiHttpClient>
```
public class ClientBuilder
extends Object
implements Builder<ApiHttpClient>
```
The ClientBuilder is used to configure and create an ApiHttpClient. As the ApiHttpClient uses a stack of middlewares the Builder comes with methods to configure and attach new middlewares. Also it ensures that some default used middlewares are instantiated at the correct location in the middleware stack.

The default middlewares and services are added as Supplier to be able to override the ones provided by e.g.: defaultClient(URI)

Field Summary

Fields
Modifier and Type Field and Description

static String COMMERCETOOLS

Fields
Modifier and Type	Field and Description
`static String`	`COMMERCETOOLS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientBuilder`	`addAcceptGZipMiddleware()`
`ClientBuilder`	`addCorrelationIdProvider(CorrelationIdProvider correlationIdProvider)`
`ClientBuilder`	`addMiddleware(Middleware middleware, Middleware... middlewares)` adds the middlewares to be configured for the client.
`ClientBuilder`	`addMiddlewares(List<Middleware> middlewares)` adds the middlewares to be configured for the client.
`ApiHttpClient`	`build()`
`static String`	`buildDefaultUserAgent()`
`ClientBuilder`	`defaultClient(ClientCredentials credentials, ServiceRegionConfig serviceRegionConfig)`
`ClientBuilder`	`defaultClient(String apiBaseUrl)`
`ClientBuilder`	`defaultClient(String apiBaseUrl, ClientCredentials credentials, String tokenEndpoint)`
`ClientBuilder`	`defaultClient(URI apiBaseUrl)` Configures a client with the default middlewares and the given baseUrl
`static ClientBuilder`	`of()` Creates a default client builder
`static ClientBuilder`	`of(HandlerStack stack)` Creates a client builder with a specifig `HandlerStack`
`static ClientBuilder`	`of(VrapHttpClient httpClient)` Creates a client builder with a specific or preconfigured `VrapHttpClient` instance.
`ClientBuilder`	`withAnonymousSessionFlow(ClientCredentials credentials, String tokenEndpoint)`
`ClientBuilder`	`withAnonymousSessionFlow(ClientCredentials credentials, String tokenEndpoint, VrapHttpClient httpClient)`
`ClientBuilder`	`withApiBaseUrl(String apiBaseUrl)`
`ClientBuilder`	`withApiBaseUrl(URI apiBaseUrl)`
`ClientBuilder`	`withClientCredentials(ClientCredentials credentials, String tokenEndpoint)` Deprecated. use withClientCredentialsFlow instead
`ClientBuilder`	`withClientCredentials(ClientCredentials credentials, String tokenEndpoint, VrapHttpClient httpClient)` Deprecated. use withClientCredentialsFlow instead
`ClientBuilder`	`withClientCredentialsFlow(ClientCredentials credentials, String tokenEndpoint)`
`ClientBuilder`	`withClientCredentialsFlow(ClientCredentials credentials, String tokenEndpoint, VrapHttpClient httpClient)`
`ClientBuilder`	`withClientCredentialsFlow(ClientCredentials credentials, URI tokenEndpoint)`
`ClientBuilder`	`withClientCredentialsFlow(ClientCredentials credentials, URI tokenEndpoint, VrapHttpClient httpClient)`
`ClientBuilder`	`withErrorMiddleware()`
`ClientBuilder`	`withErrorMiddleware(ErrorMiddleware errorMiddleware)`
`ClientBuilder`	`withErrorMiddleware(Supplier<ErrorMiddleware> errorMiddleware)`
`ClientBuilder`	`withGlobalCustomerPasswordFlow(ClientCredentials credentials, String email, String password, String tokenEndpoint)`
`ClientBuilder`	`withGlobalCustomerPasswordFlow(ClientCredentials credentials, String email, String password, String tokenEndpoint, VrapHttpClient httpClient)`
`ClientBuilder`	`withHandlerStack(HandlerStack stack)`
`ClientBuilder`	`withHttpClient(VrapHttpClient httpClient)`
`ClientBuilder`	`withHttpExceptionFactory(Function<ResponseSerializer,HttpExceptionFactory> factory)`
`ClientBuilder`	`withHttpExceptionFactory(HttpExceptionFactory factory)`
`ClientBuilder`	`withHttpExceptionFactory(Supplier<HttpExceptionFactory> factory)` configures the Factory for HTTP exception in case.
`ClientBuilder`	`withInternalLoggerFactory(InternalLoggerFactory internalLoggerFactory)`
`ClientBuilder`	`withInternalLoggerMiddleware(InternalLoggerMiddleware internalLoggerMiddleware)`
`ClientBuilder`	`withMiddleware(Middleware middleware, Middleware... middlewares)` sets the middlewares to be configured for the client.
`ClientBuilder`	`withMiddlewares(List<Middleware> middlewares)` sets the middlewares to be configured for the client.
`ClientBuilder`	`withOAuthMiddleware(OAuthMiddleware oAuthMiddleware)`
`ClientBuilder`	`withOAuthMiddleware(Supplier<OAuthMiddleware> oAuthMiddleware)`
`ClientBuilder`	`withRetryMiddleware(int maxRetries)`
`ClientBuilder`	`withRetryMiddleware(int maxRetries, List<Integer> statusCodes)`
`ClientBuilder`	`withRetryMiddleware(RetryMiddleware retryMiddleware)`
`ClientBuilder`	`withRetryMiddleware(Supplier<RetryMiddleware> retryMiddleware)`
`ClientBuilder`	`withSerializer(ResponseSerializer serializer)`
`ClientBuilder`	`withSerializer(Supplier<ResponseSerializer> serializer)`
`ClientBuilder`	`withStaticTokenFlow(AuthenticationToken token)`
`ClientBuilder`	`withTokenSupplier(TokenSupplier tokenSupplier)`
`ClientBuilder`	`withUserAgentSupplier(Supplier<String> userAgentSupplier)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- COMMERCETOOLS
```
public static final String COMMERCETOOLS
```
  See Also:
  
  Constant Field Values

Method Detail

of
```
public static ClientBuilder of()
```
Creates a default client builder

Returns:

ClientBuilder instance

of
```
public static ClientBuilder of(VrapHttpClient httpClient)
```
Creates a client builder with a specific or preconfigured VrapHttpClient instance. Uses defaults for the HandlerStack

Parameters:

httpClient - the HTTP client to be used

Returns:

ClientBuilder instance

of
```
public static ClientBuilder of(HandlerStack stack)
```
Creates a client builder with a specifig HandlerStack

Parameters:

stack - the HandlerStack to be used

Returns:

ClientBuilder instance

withHandlerStack

public ClientBuilder withHandlerStack(HandlerStack stack)

withHttpClient

public ClientBuilder withHttpClient(VrapHttpClient httpClient)

withSerializer

public ClientBuilder withSerializer(ResponseSerializer serializer)

withSerializer

public ClientBuilder withSerializer(Supplier<ResponseSerializer> serializer)

withHttpExceptionFactory

public ClientBuilder withHttpExceptionFactory(HttpExceptionFactory factory)

withHttpExceptionFactory

public ClientBuilder withHttpExceptionFactory(Function<ResponseSerializer,HttpExceptionFactory> factory)

withHttpExceptionFactory
```
public ClientBuilder withHttpExceptionFactory(Supplier<HttpExceptionFactory> factory)
```
configures the Factory for HTTP exception in case.

Parameters:

factory -

Returns:

defaultClient
```
public ClientBuilder defaultClient(URI apiBaseUrl)
```
Configures a client with the default middlewares and the given baseUrl

The following middlewares and services are configured:
Parameters:

apiBaseUrl - base URI for the API

Returns:

ClientBuilder instance

defaultClient

public ClientBuilder defaultClient(String apiBaseUrl)

defaultClient

public ClientBuilder defaultClient(String apiBaseUrl,
                                   ClientCredentials credentials,
                                   String tokenEndpoint)

defaultClient

public ClientBuilder defaultClient(ClientCredentials credentials,
                                   ServiceRegionConfig serviceRegionConfig)

withClientCredentials

@Deprecated
public ClientBuilder withClientCredentials(ClientCredentials credentials,
                                                       String tokenEndpoint)

Deprecated. use withClientCredentialsFlow instead

Parameters:: credentials - OAuth credentials; tokenEndpoint - OAuth endpoint
Returns:: client builder

withClientCredentials

@Deprecated
public ClientBuilder withClientCredentials(ClientCredentials credentials,
                                                       String tokenEndpoint,
                                                       VrapHttpClient httpClient)

Deprecated. use withClientCredentialsFlow instead

Parameters:: credentials - OAuth credentials; tokenEndpoint - OAuth endpoint; httpClient - HTTP client to be used
Returns:: client builder

withClientCredentialsFlow

public ClientBuilder withClientCredentialsFlow(ClientCredentials credentials,
                                               URI tokenEndpoint)

withClientCredentialsFlow

public ClientBuilder withClientCredentialsFlow(ClientCredentials credentials,
                                               URI tokenEndpoint,
                                               VrapHttpClient httpClient)

withClientCredentialsFlow

public ClientBuilder withClientCredentialsFlow(ClientCredentials credentials,
                                               String tokenEndpoint)

withClientCredentialsFlow

public ClientBuilder withClientCredentialsFlow(ClientCredentials credentials,
                                               String tokenEndpoint,
                                               VrapHttpClient httpClient)

withStaticTokenFlow

public ClientBuilder withStaticTokenFlow(AuthenticationToken token)

withAnonymousSessionFlow

public ClientBuilder withAnonymousSessionFlow(ClientCredentials credentials,
                                              String tokenEndpoint)

withAnonymousSessionFlow

public ClientBuilder withAnonymousSessionFlow(ClientCredentials credentials,
                                              String tokenEndpoint,
                                              VrapHttpClient httpClient)

withGlobalCustomerPasswordFlow

public ClientBuilder withGlobalCustomerPasswordFlow(ClientCredentials credentials,
                                                    String email,
                                                    String password,
                                                    String tokenEndpoint)

withGlobalCustomerPasswordFlow

public ClientBuilder withGlobalCustomerPasswordFlow(ClientCredentials credentials,
                                                    String email,
                                                    String password,
                                                    String tokenEndpoint,
                                                    VrapHttpClient httpClient)

addAcceptGZipMiddleware

public ClientBuilder addAcceptGZipMiddleware()

withErrorMiddleware

public ClientBuilder withErrorMiddleware(Supplier<ErrorMiddleware> errorMiddleware)

withErrorMiddleware

public ClientBuilder withErrorMiddleware()

withErrorMiddleware

public ClientBuilder withErrorMiddleware(ErrorMiddleware errorMiddleware)

withRetryMiddleware

public ClientBuilder withRetryMiddleware(Supplier<RetryMiddleware> retryMiddleware)

withRetryMiddleware

public ClientBuilder withRetryMiddleware(RetryMiddleware retryMiddleware)

withRetryMiddleware

public ClientBuilder withRetryMiddleware(int maxRetries)

withRetryMiddleware

public ClientBuilder withRetryMiddleware(int maxRetries,
                                         List<Integer> statusCodes)

withOAuthMiddleware

public ClientBuilder withOAuthMiddleware(Supplier<OAuthMiddleware> oAuthMiddleware)

withOAuthMiddleware

public ClientBuilder withOAuthMiddleware(OAuthMiddleware oAuthMiddleware)

withTokenSupplier

public ClientBuilder withTokenSupplier(TokenSupplier tokenSupplier)

withInternalLoggerMiddleware

public ClientBuilder withInternalLoggerMiddleware(InternalLoggerMiddleware internalLoggerMiddleware)

withInternalLoggerFactory

public ClientBuilder withInternalLoggerFactory(InternalLoggerFactory internalLoggerFactory)

withApiBaseUrl

public ClientBuilder withApiBaseUrl(String apiBaseUrl)

withApiBaseUrl

public ClientBuilder withApiBaseUrl(URI apiBaseUrl)

withUserAgentSupplier

public ClientBuilder withUserAgentSupplier(Supplier<String> userAgentSupplier)

addCorrelationIdProvider

public ClientBuilder addCorrelationIdProvider(@Nullable
                                              CorrelationIdProvider correlationIdProvider)

withMiddlewares
```
public ClientBuilder withMiddlewares(List<Middleware> middlewares)
```
sets the middlewares to be configured for the client.

Parameters:

middlewares - Middleware instances

Returns:

ClientBuilder instance

withMiddleware

public ClientBuilder withMiddleware(Middleware middleware,
                                    Middleware... middlewares)

sets the middlewares to be configured for the client.

Parameters:: middlewares - Middleware instances
Returns:: ClientBuilder instance

addMiddlewares
```
public ClientBuilder addMiddlewares(List<Middleware> middlewares)
```
adds the middlewares to be configured for the client.

Parameters:

middlewares - Middleware instances

Returns:

ClientBuilder instance

addMiddleware

public ClientBuilder addMiddleware(Middleware middleware,
                                   Middleware... middlewares)

adds the middlewares to be configured for the client.

Parameters:: middlewares - Middleware instances
Returns:: ClientBuilder instance

build
```
public ApiHttpClient build()
```
Specified by:

build in interface Builder<ApiHttpClient>

buildDefaultUserAgent

public static String buildDefaultUserAgent()

Class ClientBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMERCETOOLS

Method Detail

of

of

of

withHandlerStack

withHttpClient

withSerializer

withSerializer

withHttpExceptionFactory

withHttpExceptionFactory

withHttpExceptionFactory

defaultClient

defaultClient

defaultClient

defaultClient

withClientCredentials

withClientCredentials

withClientCredentialsFlow

withClientCredentialsFlow

withClientCredentialsFlow

withClientCredentialsFlow

withStaticTokenFlow

withAnonymousSessionFlow

withAnonymousSessionFlow

withGlobalCustomerPasswordFlow

withGlobalCustomerPasswordFlow

addAcceptGZipMiddleware

withErrorMiddleware

withErrorMiddleware

withErrorMiddleware

withRetryMiddleware

withRetryMiddleware

withRetryMiddleware

withRetryMiddleware

withOAuthMiddleware

withOAuthMiddleware

withTokenSupplier

withInternalLoggerMiddleware

withInternalLoggerFactory

withApiBaseUrl

withApiBaseUrl

withUserAgentSupplier

addCorrelationIdProvider

withMiddlewares

withMiddleware

addMiddlewares

addMiddleware

build

buildDefaultUserAgent