com.sap.cloud.sdk.cloudplatform.connectivity

Class DestinationAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.DestinationAccessor

public final class DestinationAccessor
extends Object

Wrapper for an DestinationFacade, offering methods to conveniently declare and get destinations.

Constructor Summary

Constructors

Constructor and Description
DestinationAccessor()

Method Summary

Modifier and Type	Method and Description
static void	declareDestinations(Collection<String> destinationNames) Declares the given destination names.
static void	declareDestinations(String... destinationNames) Delegates to declareDestinations(Collection).
static Destination	getDestination(String destinationName) Returns the Destination for the given name.
static DestinationFacade	getDestinationFacade() Returns the DestinationFacade instance.
static Map<String,Destination>	getDestinationsByName() Returns all known Destinations that are of type DestinationType.HTTP by their names.
static DestinationType	getDestinationType(String destinationName) Returns the DestinationType of the destination with the given name.
static GenericDestination	getGenericDestination(String destinationName) Returns the GenericDestination for the given name.
static Map<String,GenericDestination>	getGenericDestinationsByName() Returns all known destinations by their names, irrespective of their type.
static DestinationRetrievalStrategy	getRetrievalStrategy(String destinationName) Gets the configured retrieval strategy for a given destination name.
static RfcDestination	getRfcDestination(String destinationName) Returns the RfcDestination for the given name.
static Map<String,RfcDestination>	getRfcDestinationsByName() Returns all known RfcDestinations that are of type DestinationType.RFC by their names.
static void	setDestinationFacade(DestinationFacade destinationFacade) Replaces the default DestinationFacade instance.
static void	setRetrievalStrategy(String destinationName, DestinationRetrievalStrategy strategy) For a given destination name, the way how it is loaded in a multi-tenant application can be configured using this method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DestinationAccessor

public DestinationAccessor()

Method Detail

setDestinationFacade

public static void setDestinationFacade(@Nonnull
                                        DestinationFacade destinationFacade)

Replaces the default DestinationFacade instance. This method is for internal use only.

Parameters:

destinationFacade - The facade to replace the default/current one with.

declareDestinations

public static void declareDestinations(String... destinationNames)

Delegates to declareDestinations(Collection).

Parameters:

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

declareDestinations

public static 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:

• Calls to this methods are idempotent. In particular, declaring a destination multiple times results in the destination being declared once without any side effects.
• Declared destinations do not require an existing configuration, however, a missing destination configuration for a declared destination can result in certain warnings being logged.

Parameters:

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

See Also:

DestinationDeclarator, DestinationsRequestContextListener

setRetrievalStrategy

public static void setRetrievalStrategy(@Nonnull
                                        String destinationName,
                                        @Nonnull
                                        DestinationRetrievalStrategy strategy)

For a given destination name, the way how it is loaded in a multi-tenant application can be configured using this method. Once set, it is applied globally to the running application for all tenants until it is restarted.

Parameters:

destinationName - Name of destination to set retrieval strategy for.

strategy - The retrieval strategy to use - see DestinationRetrievalStrategy for details on available strategies.

getRetrievalStrategy

@Nonnull
public static DestinationRetrievalStrategy getRetrievalStrategy(@Nonnull
                                                                         String destinationName)

Gets the configured retrieval strategy for a given destination name.

Parameters:

destinationName - Name of destination to get the retrieval strategy for.

Returns:

The retrieval strategy that was set previously with setRetrievalStrategy, or DestinationRetrievalStrategy.PLATFORM_DEFAULT if no strategy was set.

getDestinationType

@Nonnull
public static 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

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

Returns the GenericDestination 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 GenericDestination cannot be found.

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

getDestination

@Nonnull
public static 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

@Nonnull
public static 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

@Nonnull
public static Map<String,GenericDestination> getGenericDestinationsByName()
                                                                            throws DestinationAccessException

Returns all known destinations by their names, irrespective of their type.

Returns:

A map containing all destinations indexed by their name.

Throws:

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

getDestinationsByName

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

Returns all known 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

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

Returns all known RfcDestinations 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.

getDestinationFacade

@Nullable
public static DestinationFacade getDestinationFacade()

Returns the DestinationFacade instance. For internal use only.