com.sap.cloud.sdk.cloudplatform.connectivity

Class AbstractDestinationFacade

java.lang.Object

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

All Implemented Interfaces:

DestinationFacade

Direct Known Subclasses:

ScpCfDestinationFacade, ScpNeoDestinationFacade

public abstract class AbstractDestinationFacade
extends Object
implements DestinationFacade

Abstract base class for DestinationFacades that allows to use the environment variable "destinations" as fallback, for example for local testing. The environment variable is expected to be in JSON format.

Example for environment variable "destinations":

 
 [{
     "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
AbstractDestinationFacade()

Method Summary

Modifier and Type	Method and Description
protected void	assertDestinationType(GenericDestination destination, DestinationType expectedType)
void	declareDestinations(Collection<String> destinationNames) Declares the given destination names.
Destination	getDestination(String destinationName) Returns the Destination for the given name.
Map<String,Destination>	getDestinationsByName() Returns all destinations that are of type DestinationType.HTTP by their names.
protected <DestinationT extends GenericDestination> Map<String,DestinationT>	getDestinationsForType(DestinationType destinationType)
protected Map<String,com.google.gson.JsonObject>	getDestinationsFromEnvironmentVariable()
protected Map<String,GenericDestination>	getDestinationsFromEnvironmentVariable(com.sap.cloud.sdk.cloudplatform.connectivity.DestinationFactory destinationFactory)
DestinationType	getDestinationType(String destinationName) Returns the DestinationType of the destination with the given name.
GenericDestination	getGenericDestination(String destinationName) Returns the GenericDestination for the given name.
RfcDestination	getRfcDestination(String destinationName) Returns the RfcDestination for the given name.
Map<String,RfcDestination>	getRfcDestinationsByName() Returns all destinations that are of type DestinationType.RFC by their names.

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.DestinationFacade

getDestinationClass, getGenericDestinationClass, getGenericDestinationsByName, getRfcDestinationClass

Constructor Detail

AbstractDestinationFacade

public AbstractDestinationFacade()

Method Detail

getDestinationsFromEnvironmentVariable

@Nullable
protected Map<String,com.google.gson.JsonObject> getDestinationsFromEnvironmentVariable()
                                                                                            throws DestinationAccessException

Throws:

DestinationAccessException

getDestinationsFromEnvironmentVariable

@Nonnull
protected Map<String,GenericDestination> getDestinationsFromEnvironmentVariable(com.sap.cloud.sdk.cloudplatform.connectivity.DestinationFactory destinationFactory)
                                                                                   throws DestinationAccessException

Throws:

DestinationAccessException

declareDestinations

public void declareDestinations(@Nonnull
                                Collection<String> destinationNames)

Declares the given destination names. Among potential pre-fetching of configurations for performance optimizations, declaring destinations is used to ensure that destinations can be retrieved correctly on all supported Cloud platforms when working with non-container managed threads. It should always be invoked before any calls to DestinationFacade.getDestination(String) and DestinationFacade.getDestinationsByName(), for example, during application startup within a ServletContextListener.

Notes:

• Implementations must ensure that calls to this methods are idempotent. In particular, declaring a destination multiple times must result in the destination being declared once without any side effects.
• Declared destinations should not require an existing configuration. However, a missing destination configuration for a declared destination may result in certain warnings being logged.

Specified by:

declareDestinations in interface DestinationFacade

Parameters:

destinationNames - The collection of all destination names that should get declared.

See Also:

DestinationDeclarator, DestinationsRequestContextListener

getDestinationType

@Nonnull
public DestinationType getDestinationType(@Nonnull
                                                    String destinationName)
                                             throws DestinationNotFoundException,
                                                    DestinationAccessException

Returns the DestinationType of the destination with the given name.

Specified by:

getDestinationType in interface DestinationFacade

Parameters:

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

Returns:

The type of the destination with the given name.

Throws:

DestinationNotFoundException - If no destination with the given name can be found.

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

getGenericDestination

@Nonnull
public GenericDestination getGenericDestination(@Nonnull
                                                          String destinationName)
                                                   throws DestinationNotFoundException,
                                                          DestinationAccessException

Returns the GenericDestination for the given name.

Specified by:

getGenericDestination in interface DestinationFacade

Parameters:

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

Returns:

The destination with the given name.

Throws:

DestinationNotFoundException - If the GenericDestination cannot be found.

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

getDestination

@Nonnull
public Destination getDestination(@Nonnull
                                            String destinationName)
                                     throws DestinationNotFoundException,
                                            DestinationAccessException

Returns the Destination for the given name.

Note: The destination must be of type DestinationType.HTTP, otherwise an exception is thrown. You can check the type of the destination with DestinationFacade.getDestinationType(String).

Specified by:

getDestination in interface DestinationFacade

Parameters:

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

Returns:

The HTTP-destination for the given destination name.

Throws:

DestinationNotFoundException - If the Destination cannot be found.

DestinationAccessException - If the destination is not of type DestinationType.HTTP or there is an issue while accessing destination information.

getRfcDestination

@Nonnull
public RfcDestination getRfcDestination(@Nonnull
                                                  String destinationName)
                                           throws DestinationNotFoundException,
                                                  DestinationAccessException

Returns the RfcDestination for the given name.

Note: The destination must be of type DestinationType.RFC, otherwise an exception is thrown. You can check the type of the destination with DestinationFacade.getDestinationType(String).

Specified by:

getRfcDestination in interface DestinationFacade

Parameters:

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

Returns:

The RFC-destination for the given destination name.

Throws:

DestinationNotFoundException - If the RfcDestination cannot be found.

DestinationAccessException - If the destination is not of type DestinationType.RFC or there is an issue while accessing destination information.

assertDestinationType

protected void assertDestinationType(@Nonnull
                                     GenericDestination destination,
                                     @Nonnull
                                     DestinationType expectedType)
                              throws DestinationAccessException

Throws:

DestinationAccessException

getDestinationsForType

@Nonnull
protected <DestinationT extends GenericDestination> Map<String,DestinationT> getDestinationsForType(@Nonnull
                                                                                                              DestinationType destinationType)

getDestinationsByName

@Nonnull
public Map<String,Destination> getDestinationsByName()
                                                        throws DestinationAccessException

Returns all destinations that are of type DestinationType.HTTP by their names.

To get all destinations, irrespective of their type, use DestinationFacade.getGenericDestinationsByName().

Specified by:

getDestinationsByName in interface DestinationFacade

Returns:

A map containing all HTTP-destinations indexed by their name.

Throws:

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

getRfcDestinationsByName

@Nonnull
public Map<String,RfcDestination> getRfcDestinationsByName()
                                                              throws DestinationAccessException

Returns all destinations that are of type DestinationType.RFC by their names.

To get all destinations, irrespective of their type, use DestinationFacade.getGenericDestinationsByName().

Specified by:

getRfcDestinationsByName in interface DestinationFacade

Returns:

A map containing all RFC-destinations indexed by their name.

Throws:

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