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

Interface ServiceBindingDestinationLoader

All Known Implementing Classes:

IdentityAuthenticationServiceBindingDestinationLoader, MegacliteServiceBindingDestinationLoader, OAuth2ServiceBindingDestinationLoader

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Beta
public interface ServiceBindingDestinationLoader

Represents a class that is capable of transforming a ServiceBinding and ServiceBindingDestinationOptions into an HttpDestination.

Since:

4.16.0

Method Summary

Modifier and Type	Method	Description
static ServiceBindingDestinationLoader	defaultLoaderChain()	Returns the default loader chain instance.
default HttpDestination	getDestination(ServiceBindingDestinationOptions options)	Tries to transform the given options into an HttpDestination.
static ServiceBindingDestinationLoader	newLoaderChain(List<ServiceBindingDestinationLoader> delegateLoaders)	Returns a new loader chain instance that will query the provided delegateLoaders in the provided order to try to transform the provided ServiceBindingDestinationOptions into an HttpDestination.
io.vavr.control.Try<HttpDestination>	tryGetDestination(ServiceBindingDestinationOptions options)	Tries to transform the given serviceBinding and options into an HttpDestination.

Method Details

defaultLoaderChain

@Nonnull
static ServiceBindingDestinationLoader defaultLoaderChain()

Returns the default loader chain instance. This instance will locate all available ServiceBindingDestinationLoader implementations (using the service loader pattern) on the classpath. Those instances will be queried in no particular order to try to transform the provided ServiceBindingDestinationOptions into an HttpDestination.

Returns:

The default loader chain instance.

newLoaderChain

@Nonnull
static ServiceBindingDestinationLoader newLoaderChain(@Nonnull
 List<ServiceBindingDestinationLoader> delegateLoaders)

Returns a new loader chain instance that will query the provided delegateLoaders in the provided order to try to transform the provided ServiceBindingDestinationOptions into an HttpDestination.

Parameters:

delegateLoaders - The ServiceBindingDestinationLoader instances that should be used.

Returns:

A new loader chain instance.

tryGetDestination

@Nonnull
io.vavr.control.Try<HttpDestination> tryGetDestination(@Nonnull
 ServiceBindingDestinationOptions options)

Tries to transform the given serviceBinding and options into an HttpDestination.

Parameters:

options - The ServiceBindingDestinationOptions that contain further context information about how the transformation process should be done.

Returns:

Either a Try.success(Object) if the transformation succeeded, Try.failure(Throwable) otherwise.

In case of a Try.failure(Throwable), the cause will either be a DestinationAccessException or a DestinationNotFoundException.

getDestination

@Nonnull
default HttpDestination getDestination(@Nonnull
 ServiceBindingDestinationOptions options)
                                throws DestinationAccessException,
DestinationNotFoundException

Tries to transform the given options into an HttpDestination.

This method is equivalent to tryGetDestination(options).get();.

Parameters:

options - The ServiceBindingDestinationOptions that contain further context information (such as the ServiceBinding that should be transformed) for the transformation process.

Returns:

An HttpDestination that can be used to connect to be bound service.

Throws:

DestinationAccessException - Thrown if the provided options couldn't be transformed into an HttpDestination.

DestinationNotFoundException - Thrown if no HttpDestination could be found for the provided options.