com.sap.cloud.sdk.cloudplatform.connectivity

Class DestinationAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.DestinationAccessor

public final class DestinationAccessor
extends Object

Wrapper for an DestinationLoader, offering platform agnostic access to destinations.

Method Summary

Modifier and Type	Method and Description
static Destination	getDestination(String destinationName) Loads the destination with the given name.
static DestinationLoader	getLoader() The loader containing the platform specific logic to retrieve destinations.
static void	setLoader(DestinationLoader loader) Sets the loader to be used for all future method invocations on this DestinationAccessor.
static io.vavr.control.Try<Destination>	tryGetDestination(String destinationName) Loads the destination with the given name.

Methods inherited from class java.lang.Object

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

Method Detail

setLoader

public static void setLoader(@Nullable
                             DestinationLoader loader)

Sets the loader to be used for all future method invocations on this DestinationAccessor.

If null is provided this will fallback to the default loader, which has the following priority list:

1. Read the destination from the destinations environment variable
2. Read the destination with the loader found via the ServiceLoader pattern

If the ServiceLoader finds multiple DestinationLoader it will behave as if none was given, as no deterministic order of resolution could be identified. Use the DestinationLoaderChain to create your own priority.

Parameters:

loader - The new loader to be used. If null is provided the default loader will be used instead.

getDestination

@Nonnull
public static Destination getDestination(@Nonnull
                                                  String destinationName)
                                           throws DestinationAccessException

Loads the destination with the given name.

Parameters:

destinationName - The name of the destination to search for.

Returns:

The loaded destination.

Throws:

DestinationAccessException - Exception describing what went wrong.

tryGetDestination

@Nonnull
public static io.vavr.control.Try<Destination> tryGetDestination(@Nonnull
                                                                          String destinationName)

Loads the destination with the given name.

Parameters:

destinationName - The name of the destination to search for.

Returns:

A Try containing either the destination or an exception describing what went wrong.

getLoader

@Nonnull
public static DestinationLoader getLoader()

The loader containing the platform specific logic to retrieve destinations.