All Classes and Interfaces
Class
Description
Abstract base class to be used to easily parse fields which can be read as a
Calendar
object as a Gson
TypeAdapter
.Deprecated.
This module will be discontinued, along with its classes and methods.
Provides caching functionality to the
HttpClientAccessor
.Abstract implementation of
HttpClientFactory
.Abstract base class to be used to easily read fields which can be read as a
Calendar
object as a Jackson
StdDeserializer
.Abstract base class to be used to easily write fields which can be read as a
Calendar
object as a Jackson
StdSerializer
.Represents an abstract base implementation of the
NamingStrategy
.Abstract class to build parameter expressions for the URL path.
Represents an OpenAPI API
AbstractRemoteFunctionRequest<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
AbstractRemoteFunctionRequestResult<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
AbstractRequestSerializer<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Abstract type converter base class for converting types to and from their domain-specific counterparts.
Abstract implementation that creates an
SSLContext
based on an X509 certificate and private key.Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown when a parameter is invalid.
The Access Denied Exception Factory.
Representation of an Action OData request as a fluent interface for further configuring the request and
executing
it.Generic OData service response wrapper for action requests.
Generic OData service response wrapper for action requests.
Implementation of GSON
ExclusionStrategy
excluding all fields not annotated with the given
annotation.Data structure to represent a Java annotation and its parameters.
Data structure to represent a Java annotation and its parameters.
Data structure to represent a parameter of a Java annotation.
Data structure to represent a parameter of a Java annotation.
Implementations of this interface instruct the VDM generator on which annotations to apply to the generated Java
code.
Implementations of this interface instruct the VDM generator on which annotations to apply to the generated Java
code.
Accessor for
HttpClient
s.Provides caching functionality to the
HttpClient5Accessor
.Builder class for a default implementation of the
ApacheHttpClient5Cache
interface.Factory class that creates
HttpClient
instances based on the given Destination
.Builder class for a default implementation of the
ApacheHttpClient5Factory
interface.Enum to control the automatic TLS upgrade feature for insecure connections.
Used by the OpenAPI VDM to access HTTP-related information, such as the target URL of the headers.
Enum representing the delimiter of a given collection.
Authentication at the REST API by providing an API key
Represents the maturity of the API to generate code for.
Metadata about API usage.
Method invocation type.
A method argument.
A method argument as variable reference.
A method argument as static code.
Provides convenience to remove non-printable characters from a String.
Representing a method to authenticate at the REST API
Enum representing different ways a user may be authenticated .
Class providing access to the authorization token of a request.
Thrown if the authorization token cannot be accessed.
Accessor for retrieving the current
AuthToken
.Facade for retrieving the current
AuthToken
.Implementation of
ThreadContextListener
that ensures the correct initialization of AuthToken
s when
working with non-container managed threads on all supported Cloud platforms.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown if the BasicAuthentication credentials cannot be accessed.
Static accessor to retrieve the BasicCredentials of the currently incoming request.
Facade for retrieving the current
BasicCredentials
.ThreadContextListener
implementation reading the Basic Authentication Header from the incoming request and
storing it in the current ThreadContext
.Encoder to used to encode user credentials in Base64.
Simple credential implementation based on a username and password.
Representation of any changeset in a OData batch request as a fluent interface.
BatchFluentHelperBasic<FluentHelperBatchT extends FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>,FluentHelperBatchChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperBatchT>>
Representation of any OData batch request as a fluent interface for managing changesets and
executing
them in a single query.Representation of an OData Batch request as a fluent interface for combining multiple data reading and modifying
operations in one HTTP request.
Interface to access the OData batch response.
Generic OData service response wrapper for Batch response.
Interface to evaluate the response of a single changeset from an OData batch response.
Interface to expose the batch feature for service class.
Simple credential implementation based on a single token.
GSON type adapter for parsing and serialization of
BigDecimal
.Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a BigDecimal
.Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a BigInteger
.GSON type adapter for parsing and serialization of
byte[]
.Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Boolean
.Interface representing an action bound to a specific type.
Specific
action
operating on a collection of element and returning a collection of objects.Specific
action
operating on a collection of elements and returning an object, if any.Specific
action
operating on a single element and returning a collection of objects.Specific
action
operating on a single element and returning an object, if any.Interface representing a function bound to a specific type.
Specific
function
operating on a collection of elements returning a collection of elements.Specific
function
operating on a collection of elements and returning a collection of
complex objects.Specific
function
operating on a collection of elements and returning a collection of
entities.Class representing a composable bound function
Specific
function
operating on a collection of elements and returning a collection of
primitives.Specific
function
operating on a collection of elements returning a single element.Specific
function
operating on a collection of elements and returning a complex object.Specific
function
operating on a collection of elements and returning an entity.Class representing a composable bound function
Specific
function
operating on a collection of elements and returning a primitive.Interface representing a composable bound function
Specific
function
operating on a single element returning a collection of elements.Specific
function
operating on a single element and returning a collection of complex
objects.Specific
function
operating on a single element and returning a collection of entities.Class representing a composable bound function
Specific
function
operating on a single element and returning a collection of primitives.Specific
function
operating on a single element returning a single element.Specific
function
operating on a single element and returning a complex type.Specific
function
operating on a single element and returning an entity.Class representing a composable bound function
Specific
function
operating on a single element and returning a primitive.Interface representing OData operations (functions and actions) bound to a specific type.
Options that can be used in a
ServiceBindingDestinationOptions
to configure the destinations for specific
services.Factory class for common Authentication Service options.
An
ServiceBindingDestinationOptions.OptionsEnhancer
that contains the target URI for an IAS or XSUAA-based destination.Enhancer that allows to include configuration specific to the SAP Business Logging Service.
Enhancer that allows to include configuration specific to the
SAP Business Rules Service for Cloud Foundry
Factory class for Identity Authentication Service
(
ServiceIdentifier.IDENTITY_AUTHENTICATION
) options.An
ServiceBindingDestinationOptions.OptionsEnhancer
that contains the communication options for an IAS-based destination.Deprecated.
since 5.9.0.
An
ServiceBindingDestinationOptions.OptionsEnhancer
that indicates whether no token is required for authenticating at the
target system iff the authentication happens on behalf of a technical provider user.Enhancer that allows to include configuration specific to the
SAP Workflow Service for Cloud Foundry.
Provider for bulkheads.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Byte
.Determines the type of expiry strategy for a cache configuration.
Represents a filter function to select specific parts of a cache depending on a
ResilienceConfiguration
, a
GenericCacheKey
, and a cache entry.CacheKey with either global visibility, tenant isolation, or tenant and principal isolation.
Grants bulk processing for all (statically) registered caches.
Exception class dedicated to failing cache calls.
POJO implmentation of the
CacheStatsMXBean
interface.JMX wrapper interface for the Guava
CacheStats
.Util class containing helper methods to work with caches.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Character
.Provider for circuit breakers.
Simple credential implementation based on a clientId and certificate.
Simple credential implementation based on a clientId and clientSecret.
Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown for issues that are related to a Cloud platform.
A collection consisting of elements collected by their
ElementName
via the
ResultCollection.collect(String)
method.Functional interface handling the type-safe transformation of a
ResultElement
to a collections of a specific
type.Representation of an OData action request as a fluent interface for further configuring the request and
executing
it.Representation of any OData function import as a fluent class for further configuring the request and
executing
it.This is specifically for functions that return either a collection
of primitive values or entitiesRepresentation of an OData function request as a fluent interface for further configuring the request and
executing
it.Deprecated.
This module will be discontinued, along with its classes and methods.
Interface representing a complex property of
ComplexProperty
that holds a complex type of ComplexProperty
.A collection of complex objects.
A navigational property to a single other entity reference.
Implementation that represents read queries and holds their state at runtime.
Wrapper class enclosing the result of a conversion.
Representation of an OData request as a fluent interface for further configuring the request and
executing
it.Representation of an OData request as a fluent interface for further configuring the request and
executing
it.Marker interface representing credentials needed to log in to a remote.
CSRF token wrapper type.
Indicates an error during the retrieval of an CSRF token.
Retrieves a CSRF token from a given remote system.
Builder for the
ODataToVdmGenerator
, gathering all relevant parameter or providing default values for
unspecified ones.Builder for the
ODataToVdmGenerator
, gathering all relevant parameter or providing default values for
unspecified ones.Delegates code generation to the public open-source OpenAPI Generator at https://openapi-generator.tech/.
Mojo used in the OData Generator Maven Plugin.
Mojo used in the OData V4 Generator Maven Plugin.
Mojo used in the REST Generator Maven Plugin.
Generates metadata about the Virtual Data Model.
Metadata about the Virtual Data Model.
Deprecated.
This module will be discontinued, along with its classes and methods.
Annotation indicating the precision and scale of a decimal field
Default implementation of
AnnotationStrategy
that applies the necessary annotations for the full set of
generated VDM classes (POJOs, fluent helpers, service classes, etc.), which uses the SAP Cloud SDK to access OData
services.Default implementation of
AnnotationStrategy
that applies the necessary annotations for the full set of
generated VDM classes (POJOs, fluent helpers, service classes, etc.), which uses the SAP Cloud SDK to access OData
services.Facade for retrieving the current
AuthToken
.Default implementation of the
BasicAuthenticationAccessor
reading the username and password from the current
ThreadContext
or, after that, from the currently incoming request and returning it as a
BasicCredentials
object.Generic OData service response wrapper for Batch response.
Default implementation for bulkhead provider.
Default caching decorator.
Default implementation for circuit breaker provider.
Default implementation of the
CollectedResultCollection
interface, allowing strongly typed access to specific
fields annotated with ElementName
in elements of a ResultCollection
.Default implementation for retrieving a CSRF token from a given remote system.
Immutable default implementation of the
Destination
interface to be used as the "single source of truth".Builder class to allow for easy creation of an immutable
DefaultDestination
instance.Default implementation of a
DestinationLoader
with convenience methods to add HTTP
and RFC
destinations.Implementation of the
HttpClientCache
, caching the HttpClient
s for the amount of time given in the
constructor.Default implementation of
HttpClientFactory
.Immutable default implementation of the
HttpDestination
interface.Builder class to allow for easy creation of an immutable
DefaultHttpDestination
instance.Facade for accessing
Locale
information.NameFormattingStrategy used by default in the
NamingContext
.NameFormattingStrategy used by default in the
NamingContext
.A default strategy to extract OAuth client information from service bindings.
This implementation of
Principal
represents the information available for an authenticated entity.Default implementation of
PrincipalFacade
encapsulating the logic to access Principal
information.Decorates a callable with a rate limiter based on a provided resilience configuration.
Default implementation of the
RequestHeaderContainer
interface.Implementation of the
RequestHeaderContainer.Builder
interface that is able to construct and manipulate
DefaultRequestHeaderContainer
s.Default implementation of the
RequestHeaderFacade
interface.This class provides an abstraction of a collection of result elements
Default implementation for a provider of retries.
Deprecated.
Please use
DefaultDestination
instead.Implementation of
Tenant
which can be used on SAP Business Technology Platform Cloud Foundry.Default implementation of
TenantFacade
which provides access to tenant information on SAP Business Technology
Platform Cloud Foundry.This class represents the default implementation of
ThreadContext
.Default ThreadContext decorator chain.
This class represents the default implementation of
ThreadContextExecutorService
.Default ThreadContext listener chain.
Decorates a callable with a time limiter based on a provided resilience configuration.
Representation of an OData delete request as a fluent interface for further configuring the request and
executing
it.Platform independent representation of a destination as a collection of key-value pairs, can be converted to a
HttpDestination
or a RfcDestination
.Thrown if a destination cannot be accessed, is not configured correctly, or does not fulfill certain prerequisites.
Wrapper for an
DestinationLoader
, offering platform agnostic access to destinations.Allows to provide additional headers for a specific destination.
This describes the interface used to retrieve destinations from some source via the
DestinationAccessor
.Immutable implementation of the
DestinationLoader
interface providing a way to define a chain
DestinationLoader
s to go through until a destination was found.Builder class to construct a
DestinationLoaderChain
.Runtime exception indicating that a destination cannot be found.
This exception is thrown, when the authentication failed because of problems in OAuth.
Contains parameters to configure the behaviour of destination loaders.
Used for setting up new
DestinationOptions
instances.Represents a class that can set specialized configuration parameters.
This exception is thrown if destination URI paths cannot be merged.
Interface representing the minimal information an arbitrary destination needs to implement.
Class that holds the PropertyKeys which can be used to access properties of destinations.
Class used as key to access destination properties, which are stored as key-value-pairs.
The destination and request specific context.
Retrieves destination information from the SCP destination service on Cloud Foundry.
Static builder class.
Helper class that encapsulates all caching related configuration options.
Handles the getting and setting of
DestinationOptions
parameters specific to SCP Cloud Foundry platform.Enumeration which represents the strategies for loading destinations in a multi-tenant application on SCP Cloud
Foundry.
Enumeration which represents the strategies for performing a user token exchange, if necessary, upon retrieving a
destination from the Destination service on BTP Cloud Foundry.
Serializable and deserializable response type for SCP CF Destination Service queries.
Destination authentication token with optional error message and expiration value.
Named destination certificate containing optional base64 encoded binary content.
Owner of the destination object with SCP CF subaccount and instance identifier reference.
Enum representing the types a destination can be of.
This exception is thrown if a
DestinationType
is not supported by a method.Utility class for destination related functionality.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Double
.Deprecated.
This module will be discontinued, along with its classes and methods.
GSON type adapter for parsing and serialization of
Duration
.Auth token facade for Deploy with Confidence (DwC) environment.
Represents an
Throwable
that is thrown if a specific Deploy with Confidence header was not found.Utility class to get all SAP Deploy with Confidence related headers from the current request.
Utility class to extract specific values from the SAP Deploy with Confidence request headers.
Represents a specific
DefaultPrincipalFacade
that is used when running on the SAP Deploy with Confidence
stack.Represents a specific
DefaultTenantFacade
that is used when running on the SAP Deploy with Confidence stack.Utility class to enable validity checks for OData specifications from EDMX files.
OData version to manage different validation steps.
Annotation indicating the name of an element.
Implementation of GSON
FieldNamingStrategy
using the value from annotation ElementName
when
serializing field names.Data structure representing an OData entity or complex type.
Data structure representing an OData entity or complex type.
Template class to represent entity fields.
OData selector for entities to select each and every field, i.e. star selector.
EntityLink<LinkT extends EntityLink<LinkT,EntityT,SubEntityT>,EntityT extends VdmObject<?>,SubEntityT extends VdmObject<?>>
Helper class for representing links (navigation properties) between entities.
Data structure representing an OData property of an entity or complex type.
Data structure representing an OData property of an entity or complex type.
Generic interface to provide the original entity class reference.
Interface to enable management of OData entity selectors.
DestinationLoader
implementation reading the destination from an environment variable.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Adds the headers "sap-client" and "sap-language", if the respective properties are present on a destination.
ErpHttpRequestExecutor<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Strategy options for sending IF-MATCH headers.
An class for executing code while allowing throwing checked exceptions.
Template class that represents query expressions.
Wrapper class for expression types.
Generic OData filter expression operand.
OData filter collection expression operand.
Singular OData filter expression operand.
This class is for internal use only.
Performs the facade lookup within the
FacadeLocator
.Represents an asc/desc ordering of an entity via a property.
OData filter expression operand for a generic entity field reference.
Deprecated.
This module will be discontinued, along with its classes and methods.
OData filter expression operand for an untyped entity field reference.
Boolean operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by Boolean.
Wrapper expression class, which delegates to another operation.
Collection operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by Collection.
Wrapper expression class, which delegates to another operation.
Logical operations for generic OData filter expression operands.
Logical operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by an OData complex property.
Date operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by Date.
Wrapper expression class, which delegates to another operation.
Fluent helper class to provide filter functions to OData expressions referenced by DateTime.
Wrapper expression class, which delegates to another operation.
Date-Time-Offset operations for generic OData filter expression operands.
Duration operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by Duration.
Wrapper expression class, which delegates to another operation.
Fluent helper class to provide filter functions to OData expressions referenced by Enum.
Fluent helper class to provide filter functions to OData expressions referenced by Guid.
Numeric operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by Number.
Fluent helper class to provide filter functions to OData expressions referenced by Integer.
Wrapper expression class, which delegates to another operation.
Fluent helper class to provide filter functions to OData expressions referenced by Integer.
Wrapper expression class, which delegates to another operation.
String operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by String.
Wrapper expression class, which delegates to another operation.
Fluent helper class to provide filter functions to OData expressions referenced by Time.
Wrapper expression class, which delegates to another operation.
Time-of-day operations for generic OData filter expression operands.
Fluent helper class to provide filter functions to OData expressions referenced by all value types.
Generic interface to describe an OData filter expression.
Set of OData filter functions for arithmetic types.
Set of OData filter functions for collection types.
Set of OData filter functions for logical types.
Set of OData filter functions for string types.
Set of OData filter functions for temporal types.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Float
.Representation of any OData request as a fluent interface for further configuring the request and
executing
it.Contains methods applicable to enrich the currently open change set.
Interface to finish the definition of a single changeset.
Representation of an OData request to retrieve an entity by its key as a fluent interface for further configuring the
request and
executing
it.Representation of an OData query for count, as a fluent interface for further configuring the request and
executing
it.Representation of an OData create request as a fluent interface for further configuring the request and
executing
it.Representation of an OData delete request as a fluent interface for further configuring the request and
executing
it.Representation of any OData V2 request that can be executed.
Representation of any OData function import as a fluent interface for further configuring the request and
executing
it.Representation of an OData modification request (Create, Update, Delete) as a fluent interface for further
configuring the request and
executing
it.Representation of an OData query as a fluent interface for further configuring the request and
executing
it.FluentHelperServiceBatch<FluentHelperT,FluentHelperChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperT>>
Interface to the batch object of an OData service.
Interface to provide execute methods.
Representation of an OData update request as a fluent interface for further configuring the request and
executing
it.Representation of a non-CRUD OData request as a fluent interface for further configuring the request and
executing
it.Stores configuration parameters for the code generation performed by
DataModelGenerator
.Stores the result of the code generation performed by
DataModelGenerator
.GenericCacheKey interface for providing access to tenant and principal data, as well as a list of appended
components.
Extracts a
Collection
out of a given ResultElement
by wrapping the result of an
ObjectExtractor
into a singletonList
.Interface to decorate a function with resilient properties.
Extractor trying to generically extract an object out of a given
ResultElement
.Representation of an OData request as a fluent interface for further configuring the request and
executing
it.Representation of an OData request to retrieve an entity by its key as a fluent interface for further configuring the
request and
executing
it.For internal use only by data model classes.
Factory implementation that creates a
ResultElement
, based on a given JsonElement
.ResultObject
implementation based on a JsonObject
.ResultPrimitive
implementation based on a JsonPrimitive
.General purpose VDM adapter factory.
For internal use only by data model classes
For internal use only by data model classes.
A name-value pair representing a header (for example, an HTTP header).
Authentication at the OpenAPI API by providing username and password
Accessor for
HttpClient
s.Provides caching functionality to the
HttpClientAccessor
.Factory class that creates
HttpClient
instances based on the given Destination
.This exception is thrown if the HTTP Client could not be build.
Platform independent representation of a HTTP destination as a collection of key-value pairs.
Adds HTTP relevant fields to the "generic" destination.
Util class extracting the entity of an
HttpResponse
, unzipping it if necessary, and finally consuming the
response.A
ServiceBindingDestinationLoader
that loads destinations from service bindings backed by the Identity
Authentication Service (IAS).Default implementation of the
TypeConverter
interface, returning all given objects unchanged.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Integer
.Thrown when a parameter is invalid.
The Invalid Parameter Exception Factory.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Jackson deserializer that is able to read
LocalDateTime
fields, based on a common logic reading from
Calendar
.Jackson deserializer that is able to write
LocalDateTime
fields, based on a common logic writing a
Calendar
.Jackson deserializer adapter for
VdmEnum
types.Jackson serializer adapter for
VdmEnum
types.Jackson deserializer that is able to read
ZonedDateTime
fields, based on a common logic reading from
Calendar
.Jackson deserializer that is able to write
ZonedDateTime
fields, based on a common logic writing a
Calendar
.Helper class to resolve service method and return type from existing Java code.
Helper class to store additional service method invocations, grouped by method name prefix.
Deprecated.
This module will be discontinued, along with its classes and methods.
JCoTransaction<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
An ordered collection of
JsonPath
.A simple JSON Path.
Annotation to mark a field in a VDM entity as being a key field.
Helper class that enables finding the correct order of parameters for get-by-key and function/actions.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Gson adapter to (de-)serialize fields of type
LocalDateTime
from and to Json.Converts between the deprecated
Calendar
type and the new LocalDateTime
.GSON type adapter for parsing and serialization of
LocalDate
.Accessor for retrieving the current
Locale
.Deprecated.
This module will be discontinued, along with its classes and methods.
Facade interface to provide access to single and multiple current locales.
Gson adapter to (de-)serialize fields of type
LocalTime
from and to Json.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
GSON type adapter for parsing and serialization of
LocalTime
.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Long
.The NameFormattingStrategy used when processing an entity's properties.
The NameFormattingStrategy used when processing an entity's properties.
Coordinate for a Maven module, consisting of group id and artifact id.
Represents a (remote) service that is bound to Megaclite.
First builder step to construct new
MegacliteServiceBinding
instances.Second builder step to construct new
MegacliteServiceBinding
instances.Third builder step to construct new
MegacliteServiceBinding
instances.Fourth builder step to construct new
MegacliteServiceBinding
instances.Implementation of the
ServiceBindingAccessor
interface that keeps track of MegacliteServiceBinding
instances.Representation of the Megaclite service as provided in Deploy with Confidence landscapes.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Wrapper for the
LoggerFactory
, collecting all logged messages.Wrapper for the
LoggerFactory
, collecting all logged messages.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Indicates an error during VDM metadata generation.
Thrown when an ERP configuration prevents an action (e.g. workflow not enabled).
The Missing ERP Configuration Exception Factory.
Thrown when a mandatory parameter is missing.
The Missing Parameter Exception Factory.
Interface to mark OData request types as modifying operation.
Generic OData service response wrapper for data modification requests.
Generic OData service response wrapper for data modification requests.
Thrown if multiple bindings are found to a service on SAP Business Technology Platform Cloud Foundry.
NameFormattingStrategy that can be used in the
NamingContext
in the OData VDM generator.NameFormattingStrategy that can be used in the
NamingContext
in the OData VDM generator.An enum representing the logic to be used by the
NamingStrategy
for determining the source for the java
namings.Represents a strategy for generating various types of Java names from OData entity/property names and labels.
Utility class, that bundles various naming related operations.
Related interface to provide access to type-safe request builders for the generic entity type.
Related interface to provide access to type-safe request builders for the generic entity type.
Interface representing a navigational property of
NavigationProperty
that points towards an entity of NavigationProperty
.A navigational property to a Collection of another entity reference.
A navigational property to a single other entity reference.
Data structure representing an OData navigation property.
Data structure representing an OData navigation property.
Abstract class representing the query capabilities of a collection of structured properties of
NavigationPropertyCollection
with a
type of NavigationPropertyCollection
.Implementation that represents read queries and holds their state at runtime.
Implementation that represents read queries and holds their state at runtime.
Empty implementation of the
Credentials
interface to be used for a user having no credentials.Function decorator which does not change the call.
Thrown if no binding is found to a service on SAP Business Technology Platform Cloud Foundry.
Throws if a certain field cannot be found for an entity.
Thrown when a method is not implemented.
The Not Implemented Exception Factory.
Number deserialization strategy to determine behavior for JSON numbers without target type references.
Authentication at the REST API via an OAuth access token
Utility class to conveniently create an
HttpDestination
instance while automatically adding
an authentication header retrieved from an OAuth2 service.Helper interface to serve mandatory input for OAuth2 token endpoint.
Helper interface to serve mandatory input for OAuth2 client identity and OAuth2 token representative.
Represents various configuration parameters for the OAuth2 destination creation.
A builder implementation that helps with creating customized
OAuth2Options
instances.Configure the timeout applied to token retrieval.
A supplier of OAuth client information.
An implementation of the
ServiceBindingDestinationLoader
interface that is capable of producing OAuth2 based
HttpDestination
instances.Supported OAuth flows to authenticate at the REST API
Functional interface handling the type-safe transformation of a
ResultElement
to a specific type.Thrown if the lookup of an object fails.
Constructor used to indicate that the access to the contained value in a
ConvertedObject
failed, as the value
could not be converted.Metadata about OData API usage.
For internal use only by data model classes
For internal use only by data model classes
OData connection exception indicating errors when trying to establish a service connection.
For internal use only by data model classes
OData deserialization exception type to focus on deserialization errors when parsing the service response.
Fluent API class to build and hold entity keys.
The generic OData exception.
Its sub-types will be thrown in the following scenarios:
If entity cannot be serialized for HTTP request.
When the HTTP connection cannot be established.
When the OData request could not be sent due to a generic reason.
If the response code infers an unhealthy state, i.e. when >= 400
When deserialization process failed for the OData response object.
If the response contains an OData error in the payload.
Its sub-types will be thrown in the following scenarios:
ODataSerializationException
If entity cannot be serialized for HTTP request.
ODataConnectionException
When the HTTP connection cannot be established.
ODataRequestException
When the OData request could not be sent due to a generic reason.
ODataResponseException
If the response code infers an unhealthy state, i.e. when >= 400
ODataDeserializationException
When deserialization process failed for the OData response object.
ODataServiceErrorException
If the response contains an OData error in the payload.
Annotation to be used to link fields to their OData property as well as converting between the domain type of a field
and the actually exposed type.
Fluent API class to build and hold function parameters.
Custom runtime exception that is thrown in cases of unrecoverable errors.
Custom runtime exception that is thrown in cases of unrecoverable errors.
Factory class to manage GSON references.
Descriptor for protocol specific information on serializing type literals for filter expressions and entity keys.
GSON serializer that transforms numbers to their JSON representation according to the OData V2 standard.
ODataPayloadParsingFailedException will be thrown whenever the VDM encounters errors during parsing that cannot be
recovered from.
The
ODataProtocol
defines all necessary information that is needed in order to differentiate between
different OData protocol versions.OData protocol v2.
OData protocol v4.
The executable OData action request.
The OData Batch request.
The Changeset representation of the OData Batch operation.
The result type of the OData Count request.
The executable OData create request.
The executable OData delete request.
Generic OData request exception indicating errors while trying to request a service resource.
General interface for executable OData Requests.
The executable OData function request.
Generic OData request class to provide default features for service requests.
Consumer class for the Listener Pattern to monitor and react on OData actions.
The result type of the OData Read request.
The result type of the OData read by key request.
Generic type of an OData request result.
Generic type of an OData request result.
OData request result for reading entities.
Generic type of an OData request result.
OData request result for reading entities.
This class provides methods to lazily iterate through the pages of an OData read request result-set.
The executable OData patch update request.
A class that assembles resource references into a URL path.
Descriptor for protocol specific information on deserializing OData responses.
Implementation to deserialize OData responses based on a given
ODataProtocol
.A generic
ODataException
representing an erroneous service response.OData serialization exception type to focus on serialization errors when creating the service request.
OData error to serve the standard specification.
Interface that resembles which information OData errors must contain and which information is optional.
An
ODataException
representing an erroneous response from the service where the payload contained detailed
OData error information.Builds up OData URLs and ensures correct encoding.
For internal use only by data model classes
For internal use only by data model classes.
For internal use only by data model classes
GSON type adapter for parsing and serialization of
OffsetDateTime
.Represents the behalf upon which an outbound request can be made.
Interface designed to be implemented by
EntityLink
class in order to provide a filter function.Custom runtime exception that is thrown in cases of unrecoverable errors.
Thrown if an error occurs during the invocation of a OpenAPI service.
Response object for OpenAPI calls containing status code
Marker interface to tag a OpenAPI service as part of the SAP Cloud SDK.
Invoke actions and functions on OData collections
Used with orderBy methods in entity fluent helper objects to set the sorting order of field values.
Used with orderBy methods in entity fluent helper objects to set the sorting order of field values.
A class representing order expressions over fields, maintaining an order over them.
Deprecated.
This module will be discontinued, along with its classes and methods.
The Parameter Not Found Exception.
The Parameter Not Found Exception Factory.
Creates an SslContext based on properties of the platform.
This class implements the basic
ObjectExtractor
interface, offering a method to create an object by
extracting arbitrary input data of type ResultElement
.This represents the information available an authenticated entity.
An exception that is thrown in case of any errors in the
PrincipalFacade
.Accessor for retrieving the current
Principal
.Facade interface encapsulating the logic to access
Principal
information.Represents the mode of principal propagation.
Implementation of
ThreadContextListener
that ensures the correct initialization of Principal
s when
working with non-container managed threads on all supported Cloud platforms.Represents a
ThreadContext
property with a given value (or exception, if the value could not be determined).Generic entity property.
Protocol-specific Datamodel Metadata.
Proxy configuration.
Enum representing the type of a remote installation.
Utility class offering the ability to get Query Parameters from Destination Properties.
A serializable query interface to serve an encoded and not-encoded String representation.
Provider for rate limiters.
Interface to mark OData request types as reading operation.
Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown when the commit during the invocation of a remote function fails.
Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown when something goes wrong during the invocation of a remote function.
The Remote Function Exception Factory.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
RemoteFunctionRequestExecutor<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Thrown when the rollback during the invocation of a remote function fails.
Request<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Servlet filter for storing the current
HttpServletRequest
in the current thread context.Representation of a generic OData request builder as a fluent interface.
Representation of a generic executable OData request builder as a fluent interface.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
RequestExecutor<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Accessor for retrieving the
RequestHeaderContainer
of the current context.Represents an immutable container for multiple HTTP headers.
Convenience class for constructing and manipulating
RequestHeaderContainer
s.This class provides access to the
RequestHeaderContainer
for the current context.Thrown if the request headers cannot be accessed.
Implementation of
ThreadContextListener
that ensures the correct initialization of the
RequestHeaderContainer
when working with non-container managed threads on all supported Cloud platforms.Deprecated.
This module will be discontinued, along with its classes and methods.
RequestResult<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
RequestSerializer<RequestT extends Request<RequestT,RequestResultT>,RequestResultT extends RequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Configurable implementation of ResilienceDecorationStrategy using Resilience4j.
Builder class for custom instances of
Resilience4jDecorationStrategy
.This type provides options to configure the resilience function decoration.
Provides options specific to bulkheads.
Provides options specific to caching.
Builder class for cache configuration.
Provides options specific to circuit breakers.
Provides options specific to rate limits.
Provides options specific to retries, which will reattempt failed requests a limited amount of times.
Provides options specific to timeouts.
Generic interface to decorate functions with non-functional requirements.
Accessor class for decorating functions with resilient properties.
Isolation key to manage optional tenant and principal values.
Determines how to further isolate resilience constructs such as timeouts, circuit breakers, and bulkheads.
Exception class dedicated to failing resilient functions.
Metadata about REST API Usage.
Interface representing one collection of result elements (e.g. a list of complex business objects) resulting from a
call to an external service (e.g. after invoking a BAPI or a remote-enabled function module).
Class representing one resulting element from a call to an external service (e.g. after invoking a BAPI or a
remote-enabled function module).
Factory interface to encapsulating different ways to create a
ResultElement
from an arbitrary object.Interface representing one structured object (e.g one complex business object) resulting from a call to an external
service (e.g. after invoking a BAPI or a remote-enabled function module).
Class representing an unstructured result primitive resulting from a call to an external service (e.g. after invoking
a BAPI or a remote-enabled function module).
Provider for retries.
Date format according to the RFC3339.
Deprecated.
Please use
Destination
instead.Deprecated.
Please use
DefaultDestination
instead.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Represents a
NamingStrategy
, which removes pre- and suffixes from the generated Java identifiers that are
typically used in S4Hana service definitions.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Representation of a OData query parameter for Search Modifier
Defines from where the HTTP Security Configuration for outbound HTTP calls is determined from.
Implementation of
ThreadContextDecorator
that ensures the correct initialization of
Tokens
when working with non-container managed threads on Cloud Foundry.SerializableCacheKey with either global visibility, tenant isolation, or tenant and principal isolation.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Represents a class that is capable of transforming a
ServiceBinding
and
ServiceBindingDestinationOptions
into an HttpDestination
.Representation of parameters and context information for the
ServiceBindingDestinationLoader
API.Builder class to construct a
ServiceBindingDestinationOptions
instance.A set of further options that can be configured using
ServiceBindingDestinationOptions.Builder.withOption(OptionsEnhancer)
.An enhancer that can add and retrieve additional options from
ServiceBindingDestinationOptions
.The Service Type denotes the protocol of the service, like OData V2, OData V4, REST or SOAP.
Deprecated.
This module will be discontinued, along with its classes and methods.
OData Service interface to provide type-safe and recursive access to nested entities and their navigation properties.
Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a Short
.Thrown in case of an exception that should not happen.
Represents the default
NamingStrategy
implementation, which generates syntactically correct Java names
without doing any additional modifications.Simple property.
A pseudo property referencing all fields.
A Binary property.
A Boolean property.
A composite property holding a collection of values.
A Date property.
A DateTime property.
A Duration property.
A property with predefined possible values.
A Guid property.
A Decimal property.
An Integer property.
A String property.
A Time property.
Representation of an OData action request as a fluent interface for further configuring the request and
executing
it.Representation of any OData function import as a fluent class for further configuring the request and
executing
it.Representation of an OData function request as a fluent interface for further configuring the request and
executing
it.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
SoapRemoteFunctionRequestSerializer<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
SoapRequest<ServiceT extends org.apache.axis2.client.Stub>
Deprecated.
This module will be discontinued, along with its classes and methods.
SoapTransaction<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
The casing of the contained value to be used by a
StringBasedErpType
.The strategy to be used to fill the String representation of a
StringBasedErpType
to the length specified
by StringBasedErpType.getMaxLength()
.Deprecated.
This module will be discontinued, along with its classes and methods.
ObjectExtractor
implementation transforming a given ResultElement
to a String
.Deprecated.
This module will be discontinued, along with its classes and methods.
StructuredQuery
acts as a builder for OData 2.0 or 4.0 queries.Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
An interface representing a Tenant on the SAP Business Technology Platform.
Runtime exception indicating an issue while accessing a tenant.
Accessor for retrieving the current
Tenant
.Facade for accessing the current
Tenant
.Implementation of
ThreadContextListener
that ensures the correct initialization of Tenant
s when
working with non-container managed threads on all supported Cloud platforms.Represents a {@link Tenant) that can be accessed through a subdomain.
This class represents the context of a thread, allowing to access and share information transparently across threads.
Exception indicating an issue while accessing a ThreadContext.
Accessor for the current
ThreadContext
.Enables decorating a callable before it is scheduled for asynchronous execution by the
DefaultThreadContextExecutorService
.Defines the default priorities for decorators.
Chain of
ThreadContextDecorator
s.Exception indicating an issue while running in a ThreadContext.
Convenience class, giving static access to the functionality of a
ThreadContextExecutorService
, using a
configurable instance.This class provides an abstraction for accessing the current
ThreadContext
.Enables listening to lifecycle events of a
ThreadContext
.The priorities used to order the default listeners provided by the SDK.
Chain of
ThreadContextListener
s.Exception indicating an issue with a ThreadContext property.
Exception indicating a ThreadContext property not being found.
Implementation of
ThreadContextFacade
that internally uses ThreadLocal
to provide access to the
respective ThreadContext
.Provider for time limiters.
Exception that is thrown in case the request to receive an authentication token fails due to authentication issues
with the XSUAA service.
Exception that is thrown in case the request to receive an authentication token fails for any reason that is not
related with authentication issues with the XSUAA service.
Transaction<RequestT extends AbstractRemoteFunctionRequest<RequestT,RequestResultT>,RequestResultT extends AbstractRemoteFunctionRequestResult<RequestT,RequestResultT>>
Deprecated.
This module will be discontinued, along with its classes and methods.
Type converter for converting types to and from their domain-specific counterparts.
Implementation of
JsonDeserializer
deserializing a JsonPrimitive
to an object of type T
using
the given TypeConverter
.Representation of an OData request as a fluent interface for further configuring the request and
executing
it.The strategy to use when updating existing entities.
A builder for the
URI
class, taking several optional parameter, constructing a valid URI out of them.Encoding strategy.
Utility class offering the ability to merge two URIs.
GSON type adapter for parsing and serialization of
UUID
.OData filter expression operand of type Edm.String
OData expression for binary values.
OData filter expression operand of type Edm.Boolean
Implementation with literal number value.
OData filter expression for a generic collection.
OData expression for generic value collections.
OData filter expression operand of type Edm.Date
OData expression for date values.
OData filter expression operand of type Edm.DateTime (OData 2.0 only)
OData expression for date time values.
OData filter expression operand of type Edm.DateTimeOffset
OData expression for date time offset values.
OData filter expression operand of type Edm.Duration
OData expression for duration values.
OData filter expression operand of enumeration type
OData filter expression operand of type Edm.Guid
OData filter expression operand of type Edm.Int32, ...
OData expression on numeric values.
OData filter expression operand of type Edm.String
OData expression on string values.
OData filter expression operand of type Edm.TimeOfDay in case of OData 4.0 or Edm.Time in case of OData 2.0.
OData expression for time of day values.
Complex type in the virtual data model.
Complex type in the virtual data model.
Represents a
VdmObject
which is an entity.Base class for an OData entity.
Empty interface to indicate operative support for querying the OData service for the related EntitySet.
Utility class to manage OData entity deserialization.
Interface to manage the different properties an Edm.Enum literal contains.
Represents a media entity which exposes additional data under a
$value
endpoint.Superclass of all entities which contains common elements such as a generic representation of custom fields.
Superclass of all entities which contains common elements such as a generic representation of custom fields.
The Wrong Customizing Exception.
The Wrong Customizing Exception Factory.
Deprecated.
This module will be discontinued, along with its classes and methods.
Deprecated.
This module will be discontinued, along with its classes and methods.
Implementation to access X.509 certificates provided by the Zero Trust Identity Service (ZTIS).
Gson adapter to (de-)serialize fields of type
ZonedDateTime
from and to Json.Converts between the deprecated
Calendar
type and the new ZonedDateTime
.