Package com.sap.cloud.sdk.cloudplatform.connectivity

Class OAuth2Options.Builder

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder

Enclosing class:

OAuth2Options

public static class OAuth2Options.Builder
extends Object

A builder implementation that helps with creating customized OAuth2Options instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OAuth2Options	build()	Creates a new OAuth2Options instance.
OAuth2Options.Builder	withClientKeyStore(KeyStore clientKeyStore)	Sets the KeyStore to use for building an mTLS connection towards the target system.
OAuth2Options.Builder	withSkipTokenRetrieval(boolean skipTokenRetrieval)	Indicates whether to skip the OAuth2 token flow.
OAuth2Options.Builder	withTimeLimiter(ResilienceConfiguration.TimeLimiterConfiguration timeLimiter)	Set a custom timeout for token retrieval.
OAuth2Options.Builder	withTokenCacheParameters(OAuth2Options.TokenCacheParameters tokenCacheParameters)	Set a custom token cache configuration.
OAuth2Options.Builder	withTokenRetrievalParameter(String key, String value)	Adds (or overwrites) the provided key-value-pair to the OAuth2Options.getAdditionalTokenRetrievalParameters() of the to-be-created OAuth2Options instance.
OAuth2Options.Builder	withTokenRetrievalParameters(Map<String,String> parameters)	Adds (or overwrites) the provided parameters to the OAuth2Options.getAdditionalTokenRetrievalParameters() of the to-be-created OAuth2Options instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

withSkipTokenRetrieval

@Nonnull
public OAuth2Options.Builder withSkipTokenRetrieval(boolean skipTokenRetrieval)

Indicates whether to skip the OAuth2 token flow.

Parameters:

skipTokenRetrieval - true if the token retrieval should be skipped, false otherwise.

Returns:

This OAuth2Options.Builder.

withTokenRetrievalParameter

@Nonnull
public OAuth2Options.Builder withTokenRetrievalParameter(@Nonnull
 String key,
 @Nonnull
 String value)

Adds (or overwrites) the provided key-value-pair to the OAuth2Options.getAdditionalTokenRetrievalParameters() of the to-be-created OAuth2Options instance.

Parameters:

key - The parameter key.

value - The parameter value.

Returns:

This OAuth2Options.Builder.

withTokenRetrievalParameters

@Nonnull
public OAuth2Options.Builder withTokenRetrievalParameters(@Nonnull
 Map<String,String> parameters)

Adds (or overwrites) the provided parameters to the OAuth2Options.getAdditionalTokenRetrievalParameters() of the to-be-created OAuth2Options instance.

Parameters:

parameters - The parameters to add.

Returns:

This OAuth2Options.Builder.

withClientKeyStore

@Nonnull
public OAuth2Options.Builder withClientKeyStore(@Nonnull
 KeyStore clientKeyStore)

Sets the KeyStore to use for building an mTLS connection towards the target system. This KeyStore is not used to build an mTLS connection towards the OAuth2 token service.

Parameters:

clientKeyStore - The KeyStore to use for building an mTLS connection towards the target system.

Returns:

This OAuth2Options.Builder.

withTimeLimiter

@Nonnull
public OAuth2Options.Builder withTimeLimiter(@Nonnull
 ResilienceConfiguration.TimeLimiterConfiguration timeLimiter)

Set a custom timeout for token retrieval. OAuth2Options.DEFAULT_TIMEOUT by default.

Parameters:

timeLimiter - The custom timeout configuration.

Returns:

This OAuth2Options.Builder.

Since:

5.12.0

withTokenCacheParameters

@Nonnull
public OAuth2Options.Builder withTokenCacheParameters(@Nonnull
 OAuth2Options.TokenCacheParameters tokenCacheParameters)

Set a custom token cache configuration. OAuth2Options.DEFAULT_TOKEN_CACHE_PARAMETERS by default.

Parameters:

tokenCacheParameters - The custom token cache parameters.

Returns:

This OAuth2Options.Builder.

Since:

5.21.0

build

@Nonnull
public OAuth2Options build()

Creates a new OAuth2Options instance.

Returns:

A new OAuth2Options instance.