com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpCfDestinationFacade

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.AbstractDestinationFacade

com.sap.cloud.sdk.cloudplatform.connectivity.ScpCfDestinationFacade

All Implemented Interfaces:

DestinationFacade

public class ScpCfDestinationFacade
extends AbstractDestinationFacade

Implementation of Cloud platform abstraction for destinations on SAP Cloud Platform, Cloud Foundry.

In addition to reading destinations via the SCP CF destination service REST API , this class provides the ability to read HTTP destination information from the environment variable "destinations". The environment variable is expected to be in JSON format.

Example:

 
 [{
 "name": "ErpQueryEndpoint",
 "url": "https://my-erp.com",
 "username": "username",
 "password": "password",
 "properties": [
 {
 "key": "proxyHost",
 "value": "my-proxy.com"
 },
 {
 "key": "proxyPort",
 "value": "8080"
 },
 {
 "key": "TrustAll",
 "value": "false"
 }
 ]
 }]
 
 

Constructor Summary

Constructors

Constructor and Description
ScpCfDestinationFacade() Creates a new facade based on the XsuaaService.
ScpCfDestinationFacade(com.sap.cloud.sdk.cloudplatform.connectivity.DestinationService destinationService) Creates a new facade based on the given destination service.

Method Summary

Modifier and Type	Method and Description
GenericDestination	getGenericDestination(String destinationName) Returns the GenericDeclaration for the given name.
Map<String,? extends GenericDestination>	getGenericDestinationsByName() Returns all destinations by their names.

Methods inherited from class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractDestinationFacade

declareDestinations, getDestination, getDestinationsByName, getDestinationType, getRfcDestination, getRfcDestinationsByName

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCfDestinationFacade

public ScpCfDestinationFacade()

Creates a new facade based on the XsuaaService.

ScpCfDestinationFacade

public ScpCfDestinationFacade(@NonNull
                              com.sap.cloud.sdk.cloudplatform.connectivity.DestinationService destinationService)

Creates a new facade based on the given destination service.

Parameters:

destinationService - The destination service to be used by this facade.

Method Detail

getGenericDestination

public GenericDestination getGenericDestination(String destinationName)
                                         throws DestinationNotFoundException,
                                                DestinationAccessException

Returns the GenericDeclaration for the given name.

Parameters:

destinationName - The destination name to get the associated destination for.

Returns:

The destination with the given name.

Throws:

DestinationNotFoundException - If the GenericDeclaration cannot be found.

DestinationAccessException - If there is an issue while accessing destination information.

getGenericDestinationsByName

public Map<String,? extends GenericDestination> getGenericDestinationsByName()
                                                                      throws DestinationAccessException

Returns all destinations by their names.

Returns:

A map containing all destinations indexed by their name.

Throws:

DestinationAccessException - If there is an issue while accessing destination information.