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

Class DestinationServiceOptionsAugmenter

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.DestinationServiceOptionsAugmenter

All Implemented Interfaces:

DestinationOptionsAugmenter

public class DestinationServiceOptionsAugmenter
extends Object
implements DestinationOptionsAugmenter

Handles the getting and setting of DestinationOptions parameters specific to SCP Cloud Foundry platform.

Constructor Summary

Constructors

Constructor	Description
DestinationServiceOptionsAugmenter()

Method Summary

Modifier and Type	Method	Description
void	augmentBuilder(DestinationOptions.Builder builder)	Use this class to set configuration parameters that are specific to a platform/environment/etc.
static DestinationServiceOptionsAugmenter	augmenter()	Creates instances of DestinationServiceOptionsAugmenter in a builder-like style.
DestinationServiceOptionsAugmenter	fragmentName(String fragmentName)	Fragment that should enhance the destination to be fetched.
static io.vavr.control.Option<DestinationServiceRetrievalStrategy>	getRetrievalStrategy(DestinationOptions options)	Retrieves the configured strategy to use when loading destinations in a multi-tenant subscription environment.
static io.vavr.control.Option<DestinationServiceTokenExchangeStrategy>	getTokenExchangeStrategy(DestinationOptions options)	Retrieves the configured DestinationServiceTokenExchangeStrategy to use when loading destinations.
DestinationServiceOptionsAugmenter	refreshToken(String refreshToken)	Refresh token to be sent for destination of type AuthenticationType.OAUTH2_REFRESH_TOKEN.
DestinationServiceOptionsAugmenter	retrievalStrategy(DestinationServiceRetrievalStrategy strategy)	Sets the strategy to use when loading destinations in a multi-tenant subscription environment.
DestinationServiceOptionsAugmenter	tokenExchangeStrategy(DestinationServiceTokenExchangeStrategy strategy)	Sets the DestinationServiceTokenExchangeStrategy to use when loading destinations.

Methods inherited from class java.lang.Object

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

Constructor Details

DestinationServiceOptionsAugmenter

public DestinationServiceOptionsAugmenter()

Method Details

augmenter

@Nonnull
public static DestinationServiceOptionsAugmenter augmenter()

Creates instances of DestinationServiceOptionsAugmenter in a builder-like style.

Returns:

A new augmenter instance.

retrievalStrategy

@Nonnull
public DestinationServiceOptionsAugmenter retrievalStrategy(@Nonnull
 DestinationServiceRetrievalStrategy strategy)

Sets the strategy to use when loading destinations in a multi-tenant subscription environment. Not setting this value or setting to null results in platform default behaviour.

Parameters:

strategy - Strategy to use when loading destinations.

Returns:

The same augmenter that called this method.

tokenExchangeStrategy

@Nonnull
public DestinationServiceOptionsAugmenter tokenExchangeStrategy(@Nonnull
 DestinationServiceTokenExchangeStrategy strategy)

Sets the DestinationServiceTokenExchangeStrategy to use when loading destinations. Not setting this value results in the platform default behavior.

Parameters:

strategy - Strategy to use when loading destinations.

Returns:

The same augmenter that called this method.

refreshToken

@Beta
@Nonnull
public DestinationServiceOptionsAugmenter refreshToken(@Nonnull
 String refreshToken)

Refresh token to be sent for destination of type AuthenticationType.OAUTH2_REFRESH_TOKEN.

Parameters:

refreshToken - Refresh token as encoded string.

Returns:

The same augmenter that called this method.

Since:

5.9.0

fragmentName

@Beta
@Nonnull
public DestinationServiceOptionsAugmenter fragmentName(@Nonnull
 String fragmentName)

Fragment that should enhance the destination to be fetched.

Parameters:

fragmentName - The fragment name.

Returns:

The same augmenter that called this method.

Since:

5.11.0

augmentBuilder

public void augmentBuilder(@Nonnull
 DestinationOptions.Builder builder)

Description copied from interface: DestinationOptionsAugmenter

Use this class to set configuration parameters that are specific to a platform/environment/etc. Once called, any parameter setting methods of this class will affect the provided DestinationOptions.Builder and the resulting DestinationOptions object that the builder creates.

Specified by:

augmentBuilder in interface DestinationOptionsAugmenter

Parameters:

builder - The builder to attach this augmenter to

getRetrievalStrategy

@Nonnull
public static io.vavr.control.Option<DestinationServiceRetrievalStrategy> getRetrievalStrategy(@Nonnull
 DestinationOptions options)

Retrieves the configured strategy to use when loading destinations in a multi-tenant subscription environment.

Parameters:

options - The destination options instance that stores the key/value pair.

Returns:

An Option wrapping the retrieval strategy if the parameter is present, otherwise a Option.None.

getTokenExchangeStrategy

@Nonnull
public static io.vavr.control.Option<DestinationServiceTokenExchangeStrategy> getTokenExchangeStrategy(@Nonnull
 DestinationOptions options)

Retrieves the configured DestinationServiceTokenExchangeStrategy to use when loading destinations.

Parameters:

options - The destination options instance that stores the key/value pair.

Returns:

An Option wrapping the token exchange strategy if the parameter is present, otherwise a Option.None.