com.sap.cloud.sdk.cloudplatform.security

Interface OAuth2ServiceProvider.OAuth2ServiceProviderBuilder

Enclosing interface:

OAuth2ServiceProvider

public static interface OAuth2ServiceProvider.OAuth2ServiceProviderBuilder

Builder type to customize OAuth2 service specific settings.

Method Summary

Modifier and Type	Method and Description
OAuth2ServiceProvider	build() Finilize builder, instantiate the object.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder	platform(CloudPlatform platform) Set a static platform object.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder	serviceSettings(OAuth2ServiceSettings serverSettings) Set custom OAuth service settings.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder	staticAccessToken(com.auth0.jwt.interfaces.DecodedJWT accessToken) Set a static access token.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder	staticCredentials(Credentials credentials) Set a static credentials object.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder	tokenServiceCache(OAuth2TokenServiceCache cache) Set a token service cache.

Method Detail

build

@Nonnull
OAuth2ServiceProvider build()

Finilize builder, instantiate the object.

Returns:

A new instance of OAuth2ServiceProvider.

staticCredentials

@Nonnull
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder staticCredentials(@Nullable
                                                                              Credentials credentials)

Set a static credentials object. The client identity will not be derived automatically any longer.

Parameters:

credentials - The Credentials object.

Returns:

The same builder.

serviceSettings

@Nonnull
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder serviceSettings(@Nullable
                                                                            OAuth2ServiceSettings serverSettings)

Set custom OAuth service settings. Use this method to customize service endpoints.

Parameters:

serverSettings - The OAuth2ServiceSettings object, containing base url and OAuth related paths.

Returns:

The same builder.

staticAccessToken

@Nonnull
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder staticAccessToken(@Nullable
                                                                              com.auth0.jwt.interfaces.DecodedJWT accessToken)

Set a static access token. The current user access token will no longer be used to derive service binding.

Parameters:

accessToken - The DecodedJWT object.

Returns:

The same builder.

platform

@Nonnull
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder platform(@Nullable
                                                                     CloudPlatform platform)

Set a static platform object. When using this method, the platform will no longer be derived automatically.

Parameters:

platform - The CloudPlatform object.

Returns:

The same builder.

tokenServiceCache

@Nonnull
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder tokenServiceCache(@Nullable
                                                                              OAuth2TokenServiceCache cache)

Set a token service cache. If this property remains null, then a new cache will be instantiated by default.

Parameters:

cache - The OAuth2TokenServiceCache object.

Returns:

The same builder.