Package com.sap.cloud.sdk.cloudplatform.connectivity

Interface Summary

Interface	Description
Destination	Platform independent representation of a destination as a collection of key-value pairs, potentially decoratable as a HttpDestination or a RfcDestination.
DestinationHeaderProvider	Allows to provide additional headers for a specific destination.
DestinationLoader	This describes the interface used to retrieve destinations from some source via the DestinationAccessor.
DestinationOptionsAugmenter	Represents a class that can set specialized configuration parameters.
DestinationProperties	Interface representing the minimal information an arbitrary destination needs to implement.
HttpClientCache	Provides caching functionality to the HttpClientAccessor.
HttpClientFactory	Factory class that creates HttpClient instances based on the given Destination.
HttpClientListener	Listener interface to be called when an HttpClient is about to be executed in the HttpClientWrapper.
HttpDestination	Platform independent representation of a HTTP destination as a collection of key-value pairs.
HttpDestinationProperties	Adds HTTP relevant fields to the "generic" destination.
RfcDestination	Platform independent representation of a rfc destination as a collection of key-value pairs.
RfcDestinationProperties	Adds RFC relevant fields to the "generic" destination.
ScpVcapDestinationLoader.ScpVcapServiceData	Destination specific structure of the JSON data contained within the VCAP lookup.
WithDestinationName	Interface indicating that a class contains a destination name.

Class Summary

Class	Description
AbstractHttpClientCache	Provides caching functionality to the HttpClientAccessor.
AbstractHttpDestination	Abstract implementation of the HttpDestination interface that delegates all interface methods to a base HttpDestinationProperties object.
AbstractScpDestination	AbstractScpDestination implements behaviour shared by all SCP destinations.
AccessToken	Access Token with expiry date.
ClientCredentialsHttpDestination	HttpDestination implementation automatically adding an authentication header retrieved from an XSUAA service with client credentials.
CustomTokenHttpDestination	HTTP destination that adds a custom access token as authorization header at runtime.
DefaultDestination	Immutable default implementation of the Destination interface to be used as the "single source of truth".
DefaultDestination.Builder	Builder class to allow for easy creation of an immutable DefaultDestination instance.
DefaultHttpClientFactory	Default implementation of HttpClientFactory based on instances of HttpClientBuilder.
DefaultHttpDestination	Immutable default implementation of the HttpDestination interface.
DefaultHttpDestination.Builder	Builder class to allow for easy creation of an immutable DefaultHttpDestination instance.
DefaultRfcDestination	Immutable default implementation of the RfcDestination interface.
DefaultRfcDestination.Builder	Builder class to guide and simplify the construction of a new RfcDestination.
DestinationAccessor	Wrapper for an DestinationLoader, offering platform agnostic access to destinations.
DestinationLoaderChain	Immutable implementation of the DestinationLoader interface providing a way to define a chain DestinationLoaders to go through until a destination was found.
DestinationLoaderChain.DestinationLoaderChainBuilder	Builder class to construct a DestinationLoaderChain.
DestinationOptions	Contains parameters to configure the behaviour of destination loaders.
DestinationOptions.Builder	Used for setting up new DestinationOptions instances.
EnvVarDestinationLoader	DestinationLoader implementation reading the destination from an environment variable.
Header	A name-value pair representing a header (for example, an HTTP header).
HttpClientAccessor	Accessor for HttpClients.
HttpClientsThreadContextListener	Implementation of ThreadContextListener that enables the correct use of Destinations when working with non-container managed threads on all supported Cloud platforms.
HttpEntityUtil	Util class extracting the entity of an HttpResponse, unzipping it if necessary, and finally consuming the response.
ProxyConfiguration	Proxy configuration.
RequestScopedHttpClientCache	Implementation of the HttpClientCache, caching the HttpClients for the life time of the request.
ScpCfDestination	SCP Cloud Foundry specific representation of a destination as a collection of key-value pairs, potentially decoratable as a ScpCfHttpDestination or a ScpCfRfcDestination.
ScpCfDestination.Builder	Builder class to allow for easy creation of an immutable ScpCfDestination instance.
ScpCfDestinationLoader	Retrieves destination information from the SCP destination service on Cloud Foundry.
ScpCfDestinationOptionsAugmenter	Handles the getting and setting of DestinationOptions parameters specific to SCP Cloud Foundry platform.
ScpCfHttpDestination	SCP Cloud Foundry specific representation of a HTTP destination as a collection of key-value pairs.
ScpCfHttpDestination.Builder	Builder class to allow for easy creation of an immutable ScpCfHttpDestination instance.
ScpCfRfcDestination	SCP Cloud Foundry specific implementation of the RfcDestination interface.
ScpCfRfcDestination.Builder	Builder class to allow for easy creation of an immutable ScpCfRfcDestination instance.
ScpCfService	A facilitation of access to the SAP CP services with OAuth auth listed in VCAP_SERVICES.
ScpNeoDestination	SCP Neo specific representation of a destination as a collection of key-value pairs, potentially decoratable as a ScpNeoHttpDestination or a ScpNeoRfcDestination.
ScpNeoDestination.Builder	Builder class to allow for easy creation of an immutable ScpNeoDestination instance.
ScpNeoDestinationLoader	This DestinationLoader implementation manages destinations from the SAP Cloud Platform Neo.
ScpNeoDestinationOptionsAugmenter	Handles the getting and setting of DestinationOptions parameters specific to SCP Neo platform.
ScpNeoDestinationsThreadContextListener	Implementation of ThreadContextListener that performs the JNDI lookup of the connectivity configuration and authentication header service objects on SAP CP Neo.
ScpNeoHttpDestination	SCP Neo specific representation of a HTTP destination as a collection of key-value pairs.
ScpNeoHttpDestination.Builder	Builder class to allow for easy creation of an immutable ScpNeoHttpDestination instance.
ScpNeoRfcDestination	SCP Neo specific implementation of the RfcDestination interface.
ScpNeoRfcDestination.Builder	Builder class to allow for easy creation of an immutable ScpNeoRfcDestination instance.
ScpVcapDestinationLoader<VcapDataT extends ScpVcapDestinationLoader.ScpVcapServiceData>	This generic type is used to retrieve destinations from VCAP environment variable via the DestinationAccessor.
ScpVcapDestinationOptionAugmenter<VcapDataT extends ScpVcapDestinationLoader.ScpVcapServiceData>
ScpVcapLoaderUtils	Utility class to load VCAP data.
ScpXfDestinationData	Helper class to represent the destination specific structure of the JSON data referenced to Extension Factory.
ScpXfDestinationLoader	This destination loader can be used to resolve destinations dedicated to a specific Extension Factory service instance, given the destination name.
TimeScopedHttpClientCache	Implementation of the HttpClientCache, caching the HttpClients for the amount of time given in the constructor.
UriBuilder	A builder for the URI class, taking several optional parameter, constructing a valid URI out of them.
UriPathMerger	Utility class offering the ability to merge two URIs.
XsuaaService	This class handles the communication (and the caching of the responses) with an XSUAA service instance.

Enum Summary

Enum	Description
AuthenticationType	Enum representing different ways a user may be authenticated .
ClientCredentialsGrantType	Enum representing the different types client credentials can be retrieved from an XSUAA Service.
DestinationType	Enum representing the types a destination can be of.
PrincipalPropagationStrategy	The principal propagation strategy decides on what request headers are attached for on-premise communication.
ProxyType	Enum representing the type of a remote installation.
ScpCfDestinationRetrievalStrategy	Enumeration which represents the strategies for loading destinations in a multi-tenant application on SCP Cloud Foundry.
ScpNeoDestinationRetrievalStrategy	Enumeration which represents the strategies for loading destinations in a multi-tenant application on SCP Neo.

Exception Summary

Exception	Description
ScpCfServiceAuthorizationFailedException	Thrown if the service access cannot be secured, either because oauth token grant was denied, request failed, or token was rejected.
ScpCfServiceCreationFailedException	Thrown if the service cannot be found or there is another kind of problem preventing its creation.