com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpVcapDestinationLoader<VcapDataT extends ScpVcapDestinationLoader.ScpVcapServiceData>

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.ScpVcapDestinationLoader<VcapDataT>

Type Parameters:

VcapDataT - The destination specific structure of the JSON data contained within the VCAP lookup.

All Implemented Interfaces:

DestinationLoader

Direct Known Subclasses:

ScpXfDestinationLoader

public abstract class ScpVcapDestinationLoader<VcapDataT extends ScpVcapDestinationLoader.ScpVcapServiceData>
extends Object
implements DestinationLoader

This generic type is used to retrieve destinations from VCAP environment variable via the DestinationAccessor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScpVcapDestinationLoader.ScpVcapServiceData Destination specific structure of the JSON data contained within the VCAP lookup.

Constructor Summary

Constructors

Constructor and Description
ScpVcapDestinationLoader()

Method Summary

Modifier and Type	Method and Description
protected abstract Destination	createDestination(VcapDataT vcapData, DestinationOptions options) Create an instance of Destination from the structured data, which was retrieved from the VCAP lookup
io.vavr.control.Try<Destination>	tryGetDestination(String destinationName, DestinationOptions options) Retrieves a destination for the given name and configuration options.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.connectivity.DestinationLoader

tryGetDestination

Constructor Detail

ScpVcapDestinationLoader

public ScpVcapDestinationLoader()

Method Detail

tryGetDestination

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

Retrieves a destination for the given name and configuration options.

The returned Try object will contain a DestinationNotFoundException in case the destination could not be found or a DestinationAccessException with more details in case something else went wrong.

If the returned Try object contains no Exception it will always contain a non-null Destination value.

Specified by:

tryGetDestination in interface DestinationLoader

Parameters:

destinationName - The name of the destination to obtain.

options - Additional settings to modify the behaviour of the destination loader.

Returns:

A Try object containing either the non-null Destination value or an exception.

createDestination

@Nonnull
protected abstract Destination createDestination(@Nonnull
                                                          VcapDataT vcapData,
                                                          @Nonnull
                                                          DestinationOptions options)

Create an instance of Destination from the structured data, which was retrieved from the VCAP lookup

Parameters:

vcapData - The structured data which could be serialized from the JSON response of the VCAP lookup.

options - Additional settings to modify the behaviour of the destination creation.

Returns:

A new instance of Destination.