com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpNeoDestinationFacade

java.lang.Object

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

com.sap.cloud.sdk.cloudplatform.connectivity.ScpNeoDestinationFacade

All Implemented Interfaces:

DestinationFacade

public class ScpNeoDestinationFacade
extends AbstractDestinationFacade

Facade providing access to destinations on SAP Cloud Platform Neo.

In addition to reading destinations via the SCP Neo destination service 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 (see AbstractDestinationFacade).

Constructor Summary

Constructors

Constructor and Description
ScpNeoDestinationFacade()

Method Summary

Modifier and Type	Method and Description
void	declareDestinations(Collection<String> destinationNames) Declares the given destination names.
Class<? extends Destination>	getDestinationClass() Returns the platform-specific implementation class of Destination.
GenericDestination	getGenericDestination(String destinationName) Returns the GenericDestination for the given name.
Class<? extends GenericDestination>	getGenericDestinationClass() Returns the platform-specific implementation class of GenericDestination.
Map<String,GenericDestination>	getGenericDestinationsByName() Returns all destinations by their names.
Class<? extends RfcDestination>	getRfcDestinationClass() Returns the platform-specific implementation class of RfcDestination.

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

assertDestinationType, getDestination, getDestinationsByName, getDestinationsForType, getDestinationsFromEnvironmentVariable, getDestinationsFromEnvironmentVariable, getDestinationType, getRfcDestination, getRfcDestinationsByName

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpNeoDestinationFacade

public ScpNeoDestinationFacade()

Method Detail

getGenericDestinationClass

@Nonnull
public Class<? extends GenericDestination> getGenericDestinationClass()

Returns the platform-specific implementation class of GenericDestination. For internal use only.

Returns:

The type of the platform-specific implementation.

getDestinationClass

@Nonnull
public Class<? extends Destination> getDestinationClass()

Returns the platform-specific implementation class of Destination. For internal use only.

Returns:

The type of the platform-specific implementation.

getRfcDestinationClass

@Nonnull
public Class<? extends RfcDestination> getRfcDestinationClass()

Returns the platform-specific implementation class of RfcDestination. For internal use only.

Returns:

The type of the platform-specific implementation.

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

Overrides:

declareDestinations in class AbstractDestinationFacade

Parameters:

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

See Also:

DestinationDeclarator, DestinationsRequestContextListener

getGenericDestination

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

Returns the GenericDestination for the given name.

Specified by:

getGenericDestination in interface DestinationFacade

Overrides:

getGenericDestination in class AbstractDestinationFacade

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.

getGenericDestinationsByName

@Nonnull
public Map<String,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.