com.sap.cloud.sdk.cloudplatform.connectivity

Interface DestinationFacade

All Known Implementing Classes:

AbstractDestinationFacade, ScpCfDestinationFacade, ScpNeoDestinationFacade

public interface DestinationFacade

Cloud platform abstraction facade for accessing Destinations and RfcDestinations.

Method Summary

Modifier and Type	Method and Description
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.
DestinationType	getDestinationType(String destinationName) Returns the DestinationType of the destination with the given name.
GenericDestination	getGenericDestination(String destinationName) Returns the GenericDeclaration for the given name.
Map<String,? extends GenericDestination>	getGenericDestinationsByName() Returns all destinations by their names.
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.

Method Detail

declareDestinations

void declareDestinations(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 getDestination(String) and 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.

Parameters:

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

See Also:

DestinationDeclarator, RequestContext, DestinationsRequestContextListener

getDestinationType

DestinationType getDestinationType(String destinationName)
                            throws DestinationNotFoundException,
                                   DestinationAccessException

Returns the DestinationType of the destination with the given name.

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

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.

getDestination

Destination getDestination(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 getDestinationType(String).

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

RfcDestination getRfcDestination(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 getDestinationType(String).

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.

getGenericDestinationsByName

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.

getDestinationsByName

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 getGenericDestinationsByName().

Returns:

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

Throws:

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

getRfcDestinationsByName

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 getGenericDestinationsByName().

Returns:

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

Throws:

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