com.sap.cloud.sdk.cloudplatform.connectivity

Interface Destination

All Superinterfaces:

DestinationProperties

All Known Implementing Classes:

DefaultDestination, ScpCfDestination, ScpNeoDestination

public interface Destination
extends DestinationProperties

Platform independent representation of a destination as a collection of key-value pairs, potentially decoratable as a HttpDestination or a RfcDestination.

Additionally provides an easy way to decorate itself with a given decorator function.

Method Summary

Modifier and Type	Method and Description
HttpDestination	asHttp() Decorates this object as a HttpDestination,
RfcDestination	asRfc() Decorates this object as a RfcDestination,
default <TargetT extends DestinationProperties> TargetT	decorate(Function<DestinationProperties,TargetT> decorator) Provides an convenient way to decorate this destination with a custom class.
boolean	isHttp() Verifies that this object can be converted to a HttpDestination.
boolean	isRfc() Verifies that this object can be converted to a RfcDestination.

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

get, get, get, get

Method Detail

decorate

@Nonnull
default <TargetT extends DestinationProperties> TargetT decorate(@Nonnull
                                                                          Function<DestinationProperties,TargetT> decorator)

Provides an convenient way to decorate this destination with a custom class.

Example usage:

 {
     CustomDestination customDestination = destination.decorate(CustomDestination::new);
 }
 

Type Parameters:

TargetT - The type of the decorated destination.

Parameters:

decorator - The decorator function to apply. Should not return null.

Returns:

The return value of this destination applied to the given decorator function.

Throws:

IllegalArgumentException - if the provided decorator returns null.

asHttp

@Nonnull
HttpDestination asHttp()
                         throws IllegalArgumentException

Decorates this object as a HttpDestination,

Returns:

The decorated destination.

Throws:

IllegalArgumentException - if this object cannot be decorated as a HttpDestination.

isHttp

boolean isHttp()

Verifies that this object can be converted to a HttpDestination.

Returns:

true, if a call to asHttp() will succeed; false otherwise.

asRfc

@Nonnull
RfcDestination asRfc()
                       throws IllegalArgumentException

Decorates this object as a RfcDestination,

Returns:

The decorated destination.

Throws:

IllegalArgumentException - if this object cannot be decorated as a RfcDestination.

isRfc

boolean isRfc()

Verifies that this object can be converted to a RfcDestination.

Returns:

true, if a call to asRfc() ()} will succeed; false otherwise.