Index
All Classes and Interfaces|All Packages
B
- build() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
-
Creates a new
OAuth2Optionsinstance. - builder() - Static method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
-
Returns a new
OAuth2Options.Builderinstance that can be used to create a customizedOAuth2Optionsinstance. - Builder() - Constructor for class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
C
- com.sap.cloud.sdk.cloudplatform.connectivity - package com.sap.cloud.sdk.cloudplatform.connectivity
- credentials - Variable in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
The credentials contained in the service binding.
D
- DEFAULT - Static variable in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
-
The default
OAuth2Optionsinstance that does not alter the token retrieval process and does not use mTLS for the target system connection. - DEFAULT_UAA_CREDENTIAL_PATH - Static variable in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
By default, the oauth client details are expected to be contained in a
uaablock of thecredentialsof the service binding. - DefaultOAuth2PropertySupplier - Class in com.sap.cloud.sdk.cloudplatform.connectivity
-
A default strategy to extract OAuth client information from service bindings.
- DefaultOAuth2PropertySupplier(ServiceBindingDestinationOptions) - Constructor for class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Create a new instance to parse the given service binding.
- DefaultOAuth2PropertySupplier(ServiceBindingDestinationOptions, List<String>) - Constructor for class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Create a new instance to parse the given service binding.
E
- equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
F
- forTargetUrl(String) - Static method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2DestinationBuilder
-
Static factory method to initialize a fluent API builder.
G
- getAdditionalTokenRetrievalParameters() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
-
Returns additional parameters for the OAuth2 token flow.
- getClientIdentity() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
- getClientIdentity() - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2PropertySupplier
-
OAuth client identity to be used for obtaining a token.
- getClientKeyStore() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
-
The
KeyStoreto use for building an mTLS connection towards the target system. - getCredential(Class<T>, String...) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Obtain an entry from the credentials block of the service binding.
- getCredentialOrThrow(Class<T>, String...) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Obtain an entry from the credentials block of the service binding.
- getOAuth2Options() - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2PropertySupplier
-
Returns additional configuration for the OAuth2 destination that is to be created.
- getOAuthCredential(Class<T>, String...) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Obtain an oauth property from the credentials block of the service binding.
- getOAuthCredentialOrThrow(Class<T>, String...) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Obtain an oauth property from the credentials block of the service binding.
- getOAuthPropertyPath() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
Get the path under which the oauth properties are stored in the service binding credentials.
- getServiceUri() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
- getServiceUri() - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2PropertySupplier
-
URL that the OAuth client should authenticate to.
- getTokenUri() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
- getTokenUri() - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2PropertySupplier
-
URL of the OAuth token service.
H
- hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
I
- isOAuth2Binding() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
- isOAuth2Binding() - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2PropertySupplier
-
Indicates if the binding is supported by this supplier.
O
- OAuth2DestinationBuilder - Class in com.sap.cloud.sdk.cloudplatform.connectivity
-
Utility class to conveniently create an
HttpDestinationinstance while automatically adding an authentication header retrieved from an OAuth2 service. - OAuth2DestinationBuilder() - Constructor for class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2DestinationBuilder
- OAuth2DestinationBuilder.BuilderWithTargetUrl - Interface in com.sap.cloud.sdk.cloudplatform.connectivity
-
Helper interface to serve mandatory input for OAuth2 token endpoint.
- OAuth2DestinationBuilder.BuilderWithTokenEndpoint - Interface in com.sap.cloud.sdk.cloudplatform.connectivity
-
Helper interface to serve mandatory input for OAuth2 client identity and OAuth2 token representative.
- OAuth2Options - Class in com.sap.cloud.sdk.cloudplatform.connectivity
-
Represents various configuration parameters for the OAuth2 destination creation.
- OAuth2Options.Builder - Class in com.sap.cloud.sdk.cloudplatform.connectivity
-
A builder implementation that helps with creating customized
OAuth2Optionsinstances. - OAuth2PropertySupplier - Interface in com.sap.cloud.sdk.cloudplatform.connectivity
-
A supplier of OAuth client information.
- OAuth2ServiceBindingDestinationLoader - Class in com.sap.cloud.sdk.cloudplatform.connectivity
-
An implementation of the
ServiceBindingDestinationLoaderinterface that is capable of producing OAuth2 basedHttpDestinationinstances. - OAuth2ServiceBindingDestinationLoader() - Constructor for class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2ServiceBindingDestinationLoader
-
Default constructor.
- options - Variable in class com.sap.cloud.sdk.cloudplatform.connectivity.DefaultOAuth2PropertySupplier
-
The
ServiceBindingDestinationOptionscontaining the service binding to interpret.
R
- registerPropertySupplier(ServiceIdentifier, Function<ServiceBindingDestinationOptions, OAuth2PropertySupplier>) - Static method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2ServiceBindingDestinationLoader
-
Adds the given
OAuth2PropertySupplierto handle matchingServiceBindingDestinationOptionsaccording to the providedServiceIdentifier. - registerPropertySupplier(Predicate<ServiceBindingDestinationOptions>, Function<ServiceBindingDestinationOptions, OAuth2PropertySupplier>) - Static method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2ServiceBindingDestinationLoader
-
Adds the given
OAuth2PropertySupplierto handle matchingServiceBindingDestinationOptions.
S
- skipTokenRetrieval() - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options
-
Indicates whether to skip the OAuth2 token flow.
T
- tryGetDestination(ServiceBindingDestinationOptions) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2ServiceBindingDestinationLoader
W
- withClient(ClientIdentity, OnBehalfOf) - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2DestinationBuilder.BuilderWithTokenEndpoint
-
Apply the OAuth2 client identity and representative.
- withClientKeyStore(KeyStore) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
-
Sets the
KeyStoreto use for building an mTLS connection towards the target system. - withSkipTokenRetrieval(boolean) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
-
Indicates whether to skip the OAuth2 token flow.
- withTokenEndpoint(String) - Method in interface com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2DestinationBuilder.BuilderWithTargetUrl
-
Apply the OAuth2 token URL.
- withTokenRetrievalParameter(String, String) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
-
Adds (or overwrites) the provided key-value-pair to the
OAuth2Options.getAdditionalTokenRetrievalParameters()of the to-be-createdOAuth2Optionsinstance. - withTokenRetrievalParameters(Map<String, String>) - Method in class com.sap.cloud.sdk.cloudplatform.connectivity.OAuth2Options.Builder
-
Adds (or overwrites) the provided parameters to the
OAuth2Options.getAdditionalTokenRetrievalParameters()of the to-be-createdOAuth2Optionsinstance.
All Classes and Interfaces|All Packages