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

Class OAuth2Options

java.lang.Object

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

@Beta
public final class OAuth2Options
extends Object

Represents various configuration parameters for the OAuth2 destination creation.

Since:

5.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2Options.Builder	A builder implementation that helps with creating customized OAuth2Options instances.
static class	OAuth2Options.TokenRetrievalTimeout	Configure the timeout applied to token retrieval.

Field Summary

Fields

Modifier and Type	Field	Description
static final OAuth2Options	DEFAULT	The default OAuth2Options instance that does not alter the token retrieval process and does not use mTLS for the target system connection.
static final ResilienceConfiguration.TimeLimiterConfiguration	DEFAULT_TIMEOUT	The default timeout of 10 seconds for token retrieval.

Method Summary

Modifier and Type	Method	Description
static OAuth2Options.Builder	builder()	Returns a new OAuth2Options.Builder instance that can be used to create a customized OAuth2Options instance.
boolean	equals(Object o)
Map<String,String>	getAdditionalTokenRetrievalParameters()	Returns additional parameters for the OAuth2 token flow.
KeyStore	getClientKeyStore()	The KeyStore to use for building an mTLS connection towards the target system.
ResilienceConfiguration.TimeLimiterConfiguration	getTimeLimiter()	A timeout to be applied for token retrieval.
int	hashCode()
boolean	skipTokenRetrieval()	Indicates whether to skip the OAuth2 token flow.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMEOUT

public static final ResilienceConfiguration.TimeLimiterConfiguration DEFAULT_TIMEOUT

The default timeout of 10 seconds for token retrieval.

Since:

5.12.0

DEFAULT

public static final OAuth2Options DEFAULT

The default OAuth2Options instance that does not alter the token retrieval process and does not use mTLS for the target system connection.

Method Details

skipTokenRetrieval

public boolean skipTokenRetrieval()

Indicates whether to skip the OAuth2 token flow.

Returns:

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

getAdditionalTokenRetrievalParameters

@Nonnull
public Map<String,String> getAdditionalTokenRetrievalParameters()

Returns additional parameters for the OAuth2 token flow. These parameters will be put into the URL-form-encoded body in addition to the regular authentication information (such as the clientid).

Returns:

Additional parameters for the OAuth2 token request.

builder

@Nonnull
public static OAuth2Options.Builder builder()

Returns a new OAuth2Options.Builder instance that can be used to create a customized OAuth2Options instance.

Returns:

A new OAuth2Options.Builder.

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTimeLimiter

@Nonnull
public ResilienceConfiguration.TimeLimiterConfiguration getTimeLimiter()

A timeout to be applied for token retrieval.

Since:

5.12.0

getClientKeyStore

@Nullable
public KeyStore getClientKeyStore()

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.