SAP Cloud SDK for Java – Release Notes

These are the release notes of the SAP Cloud SDK for Java. You may also be interested in the release notes of the SDK for JavaScript.

Note: The SAP Cloud SDK was previously known as SAP S/4HANA Cloud SDK.

Version 3.22.0

June 18, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Introduce an experimental API to run generic OData batch requests using ODataRequestBatch in version agnostic module odata-client. This implementation combined batching of entity read and modification requests. Modifications are grouped within changesets and, depending on the service implementation, they are expected to rollback if a change in the set was unsuccessful. Multiple changesets and read requests can be attached. The class supports entity request handling for create, read, update and delete, as well as service specific functions and actions.
• The API is not considered final yet. The class is annotated as @Beta. Please refrain from using it in productive application code.
• There are no helper methods on the result object yet to conveniently parse the multipart response. However the HttpResponse object can be accessed.
• The order of method invocations defines how the individual requests are serialized, when constructing the multipart batch request.
• Sample code:

  HttpClient httpClient = getHttpClient();
          ODataRequestRead read1 = getReadReq();
          ODataRequestCreate create2 = getCreateReq();
          ODataRequestUpdate update3 = getUpdateReq();
          
          ODataRequestBatch batchRequest =
            new ODataRequestBatch( "service-path/", ODataProtocol.V4 )
              .addRead( read1 )
              .beginChangeset()
              .addCreate( create2 )
              .addUpdate( update3 )
              .endChangeset();
          
          batchRequest.execute( httpClient );
        

• Add the method ScpCfDestinationLoader.tryGetAllDestinations(DestinationOptions options) to fetch all Cloud Foundry destinations. Destinations at service instance level are prioritized over destinations on subaccount level in case of a name conflict.

Fixed Issues

• Fix an issue where subscriber tenant and principal information would not be available in asynchronous threads running on SAP Cloud Platform Neo.

Version 3.21.0

June 4, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Enhance the interface CloudPlatform with the method setEnvironmentVariableReader(Function<String, String>) allowing adjustments in the way how environment variables are read.
• Add experimental filter expressions in OData client value types of package com.sap.cloud.sdk.datamodel.odata.client.expression allowing custom requests to have entity-independent, yet type-safe query filters.

Improvements

• Update dependencies:
• Update Java JWT from 3.10.2 to 3.10.3
• Update Junit Pioneer from 0.5.6 to 0.6.0
• Update AssertJ from 3.15.0 to 3.16.1
• Update Spring from 5.2.5.RELEASE to 5.2.6.RELEASE
• Update Spring Security from 5.3.1.RELEASE to 5.3.2.RELEASE
• Update Hibernate Validator from 6.1.2.Final to 6.1.5.Final
• Update Netty BOM from 4.1.49.Final to 4.1.50.Final
• Update Stax2 api from 4.2to 4.2.1
• Update Protocol Buffers Java from 3.11.4 to3.12.1
• Update dependencies in maven archetypes:
• Update spring-boot in archetype scp-cf-spring from 2.2.6.RELEASE to 2.3.0.RELEASE
• Update scp.sdkVersion in archetype scp-neo-javaee7 from 1.72.13 to 1.74.10

Fixed Issues

• Fix an issue in the realm of HTTP destinations created through the SAP Cloud Platform Extension Factory where a DestinationAccessException occured.

Version 3.20.0

May 21, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Add a new builder pattern for type Resilience4jDecorationStrategy to enable custom function decoration properties.
• Introduce the experimental interface ServiceWithNavigableEntities for recursive traversal of navigation properties in entity sets that are part of an OData v4 virtual data model (VDM). This generic type offers type-safe methods to create a request along chained entities with their navigation properties. By delegating to the existing request builder classes, the interface supports all basic CRUD operations (create, read, update, delete), plus count. All existing request modifiers are supported (e.g. filter or select statements in Read). The methods and sub-types in this interface are still open for changes in the future.
• Example: Create a new Trip in Vacation (id 2020) of Person (username "John")
• HTTP request: POST /ODataService/People('John')/Vacations(2020)/Trips
• Sample code:

  Trip tripItem = createTrip();
  
          CreateRequestBuilder createRequest = service
            .forEntity( Person.builder().username("John").build() )
            .navigateTo( Person.VACATIONS )
            .forEntity( Vacation.builder().id(2020).build() )
            .navigateTo( Vacation.TRIPS )
            .create( tripItem );
          
          createRequest.execute( destination );
        

• Include the methods getApplicationUrl() and getApplicationProcessId() in the interface CloudPlatform and add implementation for Cloud Foundry in the implementing class ScpCfCloudPlatform to partially match the existing public API of the inplementing class for NEO ScpNeoCloudPlatform.

Improvements

• Rename module odata-v4-client to odata-client and packages contained from c.s.c.s.datamodel.odatav4.client to c.s.c.s.datamodel.odata.client. Only API that is declared unstable is affected. Changes in your projects are only required if unstable parts of the API are being used explicitly.
• The OData generator (modules odata-generator, odata-generator-cli, and odata-generator-maven-plugin) is now able to parse swagger files according to the OpenAPI v3 specification.

Version 3.19.1

May 7, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• OData client: Update the OData VDM to the newest release 2005 of SAP S/4HANA Cloud. SAP Cloud SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Update the Message VDM to the newest release 2005 of SAP S/4HANA Cloud.
• Introduce the client library for the Workflow Service API on SAP Cloud Platform, Cloud Foundry
• Example usage:

  final HttpDestination httpDestination = DestinationAccessor.getDestination(destinationName).asHttp();
  final List<WorkflowDefinition> workflowDefinitions =
          new WorkflowDefinitionsApi(httpDestination).getWorkflowDefinitions();

• Maven dependency:

  <dependency>
          <groupId>com.sap.cloud.sdk.services</groupId>
          <artifactId>scp-workflow-cf</artifactId>
  </dependency>

• Introduce new VDM request builder for OData v4 to fetch the count of entries from an entity collection endpoint. The result is a non-null Long, which is the number of matching entries according to optional filter and search expressions.
• Example for the VDM usage:

  long numEntries = new DefaultEntityService()
          .countEntities()
          .filter(SomeEntity.FIELDNAME.contains("foo"))
          .search("bar")
          .execute(someDestination);

• Example for the generic usage:

  long numEntries = new CountRequestBuilder<>("/odata/service/path/", SomeEntity.class)
          .filter(SomeEntity.FIELDNAME.contains("foo"))
          .search("bar")
          .execute(someDestination);

• Provide support for unbound actions in OData v4. The OData v4 generator generates unbound actions at the service level. Etag handling in actions is not supported at this time.
• Note: To enable this feature, regeneration of the VDM classes is required.
• Introduce support for controlling the version identifier (ETag) submission when using the VDM request builders for OData v4 for deleting and updating entities DeleteRequestBuilder and UpdateRequestBuilder.
• The method disableVersionIdentifier() allows to avoid that the request header If-Match is sent at all.
• The method matchAnyVersionIdentifier() allows to control that the request header If-Match is sent with the value *.
• Note: If both methods are invoked on the same request builder, the latest invocation takes precedence.
• Example for the VDM usage to delete an entity without sending a version identifier:

  new DefaultEntityService()
          .deleteEntity(entity)
          .disableVersionIdentifier()
          .execute(destination);

• Example for the VDM usage to update an entity while sending the * value in the request header:

      new DefaultEntityService()
          .updateEntity(entity)
          .matchAnyVersionIdentifier()
          .execute(destination);

Improvements

• Update dependencies:
• Guava from 28.2-jre to 29.0-jre
• Apache CXF from 3.3.5 to 3.3.6
• SAP Cloud Security Client from 2.6.1 to 2.6.2
• Jackson from 2.10.3 to 2.11.0
• Resilience4J from 1.3.1 to 1.4.0
• AssertJ Guava from 3.3.0 to 3.4.0
• Spring Security OAuth from 2.4.0.RELEASE to 2.4.1.RELEASE
• Fabric SDK from 2.0.0 to 2.1.0
• Netty BOM from 4.1.48.Final to 4.1.49.Final
• Update Maven plugins in archetype scp-cf-tomee:
• tomee-maven-plugin from 7.0.5 to 8.0.1
• Update Maven plugins in archetype scp-cf-spring:
• spring-boot-maven-plugin from 2.2.5.RELEASE to 2.2.6.RELEASE
• Update Maven plugins in archetype scp-neo-javaee7:
• jacoco-maven-plugin from 0.8.2 to 0.8.5
• maven-surefire-plugin from 3.0.0-M3 to 3.0.0-M4

Version 3.18.0

April 23, 2020 - Maven Central - Javadoc - Release blog

Improvements

• Update Dependencies:
• Spring Security from 5.3.0.RELEASE to 5.3.1.RELEASE
• JUnit Pioneer from 0.5.5 to 0.5.6
• Java JWT from 3.10.1 to 3.10.2
• SAP Cloud Security Client from 2.5.3 to 2.6.0

Version 3.17.2

April 15, 2020 - Maven Central - Javadoc -

Fixed Issues

• Fix an issue with access token validation in a provider/subscriber setup, when having multiple XSUAA service bindings, e.g. one with service plan broker and one with service plan application.

Version 3.17.1

April 9, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Introduce support for OData v4 - Deep Update.
• Single and collection-based entity navigation properties can be used when updating a base entity. This way nested entities can be updated and created, while performing a single OData request.
• Note: This feature can only be used with modifyingEntity() and not with replacingEntity().
• Note: Removing an existing element from a collection-based entity navigation property is not yet supported.

Improvements

• The OData v4 Virtual Data Model (VDM) now allows for ordering by multiple fields through calling orderBy() and passing fields to it with the corresponding order.
  getPersons().orderBy(Person.FIRST_NAME.asc(), Person.LAST_NAME.desc());
• The interface ResilienceDecorationStrategy now provides an additional optional argument to pass a custom ExecutorService in methods decorateCallable() and decorateSupplier(). This way the thread pool and task execution can be adjusted upon decoration. If the time limiter is enabled, it will be running in a thread through the passed executor. If Callable or Supplier lambda is queued, then the asynchronous task will be run with the given ExecutorService as well.
• Update dependencies:
• Java JWT from 3.10.0 to 3.10.1
• Mockito from 3.3.0 to 3.3.1
• Wiremock from 2.26.2 to 2.26.3
• Spring Security from 5.2.2.RELEASE to 5.3.0.RELEASE
• Netty BOM from 4.1.47.Final to 4.1.48.Final
• Apache TomEE libraries from version 7.0.6 to 7.0.7
• SAP Cloud Application Programming Model from version 1.38.0 to 1.39.0
• SAP Cloud Security Client from 2.5.1 to 2.5.3
• Apache Commons Lang from version 3.9 to 3.10
• JUnit from version 5.6.0 to 5.6.1
• JUnit Pioneer from version 0.5.4 to 0.5.5
• Spring from version 5.2.4.RELEASE to 5.2.5.RELEASE
• Update dependencies and Maven plugin versions in the archetypes scp-cf-spring, scp-cf-tomee, and scp-neo-javaee7:
• jacoco-maven-plugin to 0.8.5
• maven-surefire-plugin to 3.0.0-M4
• maven-enforcer-plugin to 3.0.0-M3
• maven-war-plugin to 3.2.3
• maven-dependency-plugin to 3.1.2
• Spring Boot from 2.2.1.RELEASE to 2.2.5.RELEASE

Fixed Issues

• Fix a bug in odata-v4-generator where the field type Edm.TimeOfDay was not recognized and not generated properly, leading to missing SimpleProperty fields on the generated entity.
• Fix a regression introduced in 3.16.1 where public keys for token validation were not cached.

Version 3.16.1

March 26, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Introduce the module SCP Blockchain Client Fabric for easy interaction with a Hyperledger Fabric network using all necessary configuration and credentials from a standardized user-provided service in the Cloud Foundry environment.
• JSON Web Tokens (JWT) are now validated using their issuer and jku properties. Public keys for signature verification are fetched from the URL specified by the jku property. This only works if the issuer domain matches the domain of the XSUAA service. In case this fails or if the properties are not set, the implementation falls back to the previous validation mechanisms (e.g. verification key of XSUAA service binding, XSUAA token endpoint provider).

Improvements

• SAP Cloud SDK can now be used with Java 11. To try out if your project works with Java 11, you can update the Java version in the pom.xml and recompile. If everything compiles and behaves as expected locally, you can configure Cloud Foundry to use Java 11 too. See this page for more details how to do that.
• Update Dependencies
• Update Slf4J from version 1.7.26 to 1.7.30
• Update Jackson from version 2.10.2 to 2.10.3
• Update Wiremock from version 2.26.1 to 2.26.2
• Update Jetty from version 9.4.26.v20200117 to 9.4.27.v20200227
• Update Spring from version 5.2.3.RELEASE to 5.2.4.RELEASE
• Update Apache HttpComponents from version 4.5.11 to 4.5.12

Fixed Issues

• Fix an issue where the authorization header was missing when using Principal Propagation for on-premises connectivity on Cloud Foundry.
• Fix some special characters escaping and encoding issues.
• ? in the service path
• # and & in filter and select expressions
• ' in string literals and in string parameters being passed in functions and GetByKey requests
• " and \ in search expressions

Version 3.15.1

March 12, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• execute() on all request builders (e.g., CreateRequestBuilder)
• select(), filter(), top(), skip(), and search() on GetAllRequestBuilder
• GetByKeyRequestBuilder.select()
• of(), and(), or(), not() for defining a SearchExpression
• includingFields(), replacingEntity(), modifyingEntity() on UpdateRequestBuilder
• The generic exception class ODataException
• The classes NavigationProperty, ComplexProperty and SimpleProperty
• The OData v4 generator now generates ComplexProperty fields on entities that can be used to build queries. Single instances and collections of complex types are supported.
• Provide support for unbound functions in OData v4. The Odata v4 generator generates unbound functions at the service level.
• The OData v4 generator now creates entity classes that are only referenced by navigation properties and functions (not part of an entity set).

Improvements

• Introduce snakeyaml version 1.26 as direct dependency and exclude the one used by the jackson library to overcome the security vulnerability CVE-2017-18640.
• Replace the SAP Cloud SDK implementation for handling authentication and authorization within the SAP Cloud Platform landscape by the library XSUAA Token Client and Token Flow API version 2.5.1. See the compatibility notes for details.
• Update Dependencies
• SAP Cloud Application Programming Model from version 1.37.1 to 1.38.0
• Lombok from version 1.18.10 to 1.18.12
• Caffeine from version 2.8.0 to 2.8.1
• Commons CSV from version 1.7 to 1.8
• Apache HTTP Components CSV from version 4.5.10 to 4.5.11
• EclipseLink CSV from version 2.7.5 to 2.7.6
• Liquibase CSV from version 3.6.3 to 3.8.6
• Resilience4J CSV from version 1.2.0 to 1.3.1
• JUnit CSV from version 5.5.2 to 5.6.0
• JUnit Pioneer from version 0.5.1 to 0.5.4
• Jetty from version 9.4.25.v20191220 to 9.4.26.v20200117
• Spring Security from version 5.2.1.RELEASE to 5.2.2.RELEASE
• Hibernate Validator from version 6.0.17.Final to 6.1.2.Final
• Java JWT from version 3.9.0 to 3.10.0
• AssertJ from version 3.14.0 to 3.15.0
• Mockito from version 3.2.4 to 3.3.0
• Wiremock from version 2.20.0 to 2.26.1
• SAP Cloud Platform SDK For Neo Environment (Java EE 7 Web Profile TomEE 7) to version 1.69.18

Fixed Issues

• Fix an issue where the OData v2 URL query generation was not escaping single-quotes ' in String literals correctly. This character can now be used as part of entity keys and filter expressions.
• Fix an issue with Decimal OData values being formatted in unexpected scientific notation (e.g. 4.2e-7) instead of expected decimal form (e.g. 0.00000042). The solution is provided for serializing entity properties of Java type BigDecimal.

Version 3.14.0

February 27, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM client: Add preview support for OData v4 services.
• The new OData client implementation is capable of the basic Create, Read, Update, Delete (CRUD) operations on OData v4 services.
• Include an updated, dedicated generator that is capable of creating virtual data models through a command line interface or Maven plugin. Reference the artifact id odata-v4-generator in your .pom file.
• Advanced features like functions, actions or batch requests are not yet supported.
• The implementation is initially in beta and thus does not guarantee a stable API.

Improvements

• Update SAP Cloud Application Programming Model from version 1.36.2 to 1.37.1

Version 3.13.0

February 13, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• OData client: Update the OData VDM to the newest release 2002 of SAP S/4HANA Cloud. This includes completely new services (available as usual in package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Improvements

• Update the Spring dependency for the SAP Cloud Platform multitenancy implementation module to version 4.3.26.RELEASE to overcome the security vulnerability CVE-2020-5397.

Version 3.12.0

January 30, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• SCP Blockchain Module: Allow the usage of custom HTTP clients by adding support for a custom HTTP request factory for the rest template in MultichainRequest.
• When creating a MultichainService instance using a SAP Cloud Platform destination, the destination's HTTP client will now be used as a pre-configured HttpClient instance with authentication, HTTP connection pooling, etc. for each MultichainRequest.

Improvements

• Update dependencies:
• Jackson from version 2.10.1 to 2.10.2
• Commons Codec from version 1.13 to 1.14
• Apache HttpComponents Core from version 4.4.12 to 4.4.13.
• Apache CXF from version 3.3.4 to 3.3.5
• JUnit Pioneer from version 0.4.2 to 0.5.1
• Spring from version 5.2.2.RELEASE to 5.2.3.RELEASE

Fixed Issues

• OData Generator: Fix an issue where if only some of the declared EntitySets contained related service operations annotations in the .edmx file, the ones without such annotations got no operations resolved at all.
• Fix an issue with BapiRequest where a NoSuchElementException was thrown in case a Destination without a name was used.
• Fix an issue concerning the encoding of special characters such as #, &, etc. in OData filter expressions.

Version 3.11.0

January 16, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• Introduce a new BasicAuthenticationAccessor to read the username and password from the Basic Authentication header of the currently incoming request on Cloud Foundry.
• Enable the PrincipalAccessor to also read the current principal from the newly introduced BasicAuthenticationAccessor, in addition to the already existing way to read it from the current JWT. This functionality applies to Cloud Foundry. A valid JWT takes precedence over a Basic Authentication header.
• Support self-signed certificates (file extensions .cer, .crt, and .der) as trust store locations for HTTPS destinations.

Improvements

• The connectivity to on-premise systems from SCP Cloud Foundry is updated, so that the authentication now follows the recommended protocol for principal propagation.
• Instead of populating two headers SAP-Connectivity-Authentication and Proxy-Authorization for on-premise requests, the SAP Cloud SDK now takes the recommended approach of just using Proxy-Authorization with a dynamicly resolved User Exchange Access Token.
• Introduce PrincipalPropagationStrategy for configuring that the previous behavior should be used.
• Support reading the principal from an OAuth SAML Bearer token on Cloud Foundry.
• Update dependencies:
• Apache TomEE libraries from version 7.0.5 to 7.0.6
• SAP Cloud Application Programming Model from version 1.36.1 to 1.36.2
• AssertJ Vavr from version 0.1.0 to 0.2.0
• Mockito from version 3.2.0 to 3.2.4
• Spring from version 5.2.1.RELEASE to 5.2.2.RELEASE
• Guava from version 28.1-jre to 28.2-jre
• Java JWT from version 3.8.3 to 3.9.0
• JUnit from version 4.12 to 4.13
• Jetty from version 9.4.19.v20190610 to 9.4.25.v20191220
• SAP Cloud Platform Neo Environment SDK for Java EE 7 Web Profile TomEE 7 from version 1.44.12 to 1.65.15

Fixed Issues

• Fix an issue with the cache of ResilienceDecorator invalidating itself upon calling, when using a JCache SPI different from JCache RI.
• OData VDM client: Fix an issue concerning update requests with PATCH semantics where null values were being filtered out before the update. Explicitly set null values are being retained now.
• Fix an issue with the deserialization of function import responses returning objects creatable by a single String parameter as reported here.
• Fix a regression in the OData VDM Generator where anotations within EDMX metadata files were interpreted in an unexpected way leading to missing operations in the generated classes as reported here.

Version 3.10.0

December 19, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies:
• SAP Cloud Application Programming Model from version 1.35.2 to 1.36.1
• Spring from version 5.1.2-RELEASE to 5.2.1-RELEASE
• Spring Security OAuth from version 2.3.6-RELEASE to 2.4.0-RELEASE
• Eclipse Link from version 2.7.4 to 2.7.5
• Resilience4J from version 1.1.0 to 1.2.0
• JUnit Pioneer from version 0.3.3 to 0.4.2
• Mockito from version 2.22.0 to 3.2.0
• Spring Boot from version 2.1.1-RELEASE to 2.2.1-RELEASE
• Introduce more consistency in builders for destinations.
• Add builder methods in ScpCfHttpDestination for the properties header, user, password.
• Add builder methods in ScpNeoHttpDestination for the properties user, password, trustAllCertificates, header, authenticationHeaders, basicCredentials, authenticationType, proxyType, proxyConfiguration.
• Add builder methods in DefaultHttpDestination and DefaultErpHttpDestination for the properties basicCredentials, proxyType.

Fixed Issues

• Fix an issue concerning HTTP destinations on Cloud Foundry where the default JDK trust store was mistakenly taken into account even if an own trust store is defined.
• Fix OData query formatting for filter expressions with temporal values. This affects queries comparing entity properties based on Edm.Time, Edm.DateTime or Edm.DateTimeOffset.

Version 3.9.0

December 5, 2019 - Maven Central - Javadoc - Release blog

Improvements

• SCP blockchain: Add support for Basic Authentication to MultichainRequest, allowing the request to be used with AWS and Azure Multichain nodes.
• Resilience framework: Use new name format for threads spawned by asynchronous calls: cloudsdk-resilience-<number>
• Add new method DestinationProperties.getPropertyNames() to retrieve the set of properties of a destination. This allows you to enumerate the names of all properties retrieved from the destination service and their values.
• Update dependencies:
• Jackson from version 2.10.0 to 2.10.1, fixing the vulnerabilities CVE-2019-17267 and CVE-2019-17531
• SAP Cloud Application Programming Model from version 1.33.0 to 1.35.2
• Joda Time from version 2.10.4 to 2.10.5
• Vavr from version 0.9.3 to 0.10.2
• Commons CSV from version 1.6 to 1.7
• Java JSON from version 20180813 to 20190722
• Apache CXF from version 3.3.2 to 3.3.4
• AssertJ Core from version 3.13.2 to 3.14.0
• AssertJ Guava from version 3.2.1 to 3.3.0
• JUnit Pioneer from version 0.3.0 to 0.3.3

Fixed Issues

• Fix an issue that caused the OData VDM generator to wrongly identify available operations on a service entity.
• Fix an issue where special characters (e.g. /) were incorrectly escaped in OData requests made when dynamically fetching a navigation property of an entity whose key contains such characters.

Version 3.8.0

November 21, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData client: Update the OData VDM to the newest release 1911 of SAP S/4HANA Cloud. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Fixed Issues

• Fix an issue that caused unnecessary requests to the XSUAA service when accessing auth tokens in requests.

Version 3.7.0

November 7, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Allow clearing the cache for future requests when using a ResilienceConfiguration with a CacheConfiguration in place. Use ResilienceDecorator.invalidateCache(configuration) to clear the cache associated with a specific configuration.
• OData VDM generator: allow to specify the copyright header for generated files by supplying the parameter --copyright-header your-custom-header. By default, no header is generated.

Improvements

• Allow to explicitly specify buffer sizes for the circuit breaker in CircuitBreakerConfiguration. Use CircuitBreakerConfiguration.closedBufferSize and CircuitBreakerConfiguration.halfOpenBufferSize to provide custom values for the respective buffer size.
• Allow to specify the cache expiration strategy for a CacheConfiguration in ResilienceConfiguration. Use withExpirationStrategy(strategy) on the builder for a CacheConfiguration with the enum constants available from CacheExpirationStrategy. WHEN_LAST_MODIFIED remains the default value for the expiration strategy.
• Allow to initialize a resilience configuration with disabled individual properties by providing methods for instantiating a invidual configuration as disabled. Introduce the following factory methods in addition to the previously existing ones that instantiate an enabled configuration:
  • CircuitBreakerConfiguration.disabled()
  • TimeLimiterConfiguration.disabled()
  • BulkheadConfiguration.disabled()
  • RetryConfiguration.disabled()
  • CacheConfiguration.disabled()
• Provide method ResilienceConfiguration.empty to initialize a new resilience configuration with all properties being disabled by default.
• Provide method TimeLimiterConfiguration.of(duration) as a convenience instead of TimeLimiterConfiguration.of().timeoutDuration(duration).

Version 3.6.0

October 24, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Offer retries as part of ResilienceConfiguration via a RetryConfiguration.
  • Retries allow for re-attempting a request in case it fails a limited number of times.
  • The feature offers to specify the maximum amount of attempts, a wait duration between attempts and a predicate that determines, whether or not a failure should be retried.

Improvements

• OData VDM generator: Mark generated sources for compilation when using odata-generator-maven-plugin. For this feature just add the property <compileScope>...</compileScope> with the compilation phase to your configuration. Valid values are COMPILE, TEST_COMPILE, and NONE, representing the different compile phases or no automatic compilation at all. The default value (for backwards compatibility reasons) is NONE.
• Update dependencies:
  • Jackson from version 2.9.10 to 2.10.0.
  • Lombok from version 1.18.8 to 1.18.10.
  • Guava from version 28.0-jre to 28.1-jre.
  • GSON from version 2.8.5 to 2.8.6.
  • Java JWT from version 3.8.1 to 3.8.3.
  • Commons-Text from version 1.7 to 1.8.
  • Http Core from version 4.4.11 to 4.4.12.
  • Http Components Client from version 4.5.9 to 4.5.10.
  • Resilience4J from version 0.17.0 to 1.1.0.

Fixed Issues

• OData VDM: Fix an issue where the response of function imports was not correctly handled. The response is now parsed according to OData specification. The deviating behavior of OData services in some SAP solution is still supported as in previous versions, via a (modifiable) refinement step.
• OData VDM generator: Parse allowed requests in a more careful manner when handling an EDMX file. The generator will no longer throw an exception for missing XML attributes.
• Fix an issue regarding timeouts in the execution of resilient requests. The issue prevented threads from being terminated when a timeout occurs.

Version 3.5.0

October 10, 2019 - Maven Central - Javadoc - Release blog

Improvements

• No longer require a binding to an XSUAA service instance when consuming the destination or connectivity service via the SDK.
• Automatically read the principal ID from the user_name claim of the current JWT in ScpCfPrincipalFacade when the JWT has the user_token grant type.
• Update dependencies on Jackson from 2.9.9/2.9.9.2 to 2.9.10.
• Verify that the Maven artifactId does not contain an underscore character when creating a project using the scp-cf-spring and scp-cf-tomee archetypes. This is necessary as the artifact ID will also be used as Cloud Foundry application name and the deployment to Cloud Foundry will fail if the application name contains an underscore.

Version 3.4.0

September 26, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Validate user access tokens issued by XSUAA with the verification key retrieved from the XSUAA service, instead of relying on a verification key present in the XSUAA service binding credentials. The retrieved key is cached for 5 minutes (depending on feedback, the cache duration may change in the future).
• Support SystemUser property in destinations with authentication type "OAuth2SAMLBearerAssertion". The system user will be used instead of the currently logged in principal to retrieve an access token to the destination. That is, no principal propagation takes place. As a consequence, no user JWT is required.

Version 3.3.1

September 12, 2019 - Maven Central - Javadoc - Release blog

Improvements

• OData VDM Generator: use the service name from the namespace provided in the metadata file to construct the service name part of the OData request URL. Fall back to the filename of the metadata file as the service name only if the namespace information is not available.
• Update dependency to Java libraries of SAP Cloud Application Programming Model (com.sap.cloud.servicesdk.*) from version 1.32.5 to 1.33.0.
• Update transitive dependencies to commons-beanutils to 1.9.4 (from 1.9.3) in order to fix CVE-2019-10086.
• Remove listeners-all dependencies from projects generated via archetypes since the SAP Cloud SDK Pipeline will inject this dependency during a pipeline run.

Version 3.2.0

August 29, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Execute code asynchronously while making it resilient, using the new methods queueCallable and queueSupplier of ResilienceDecorator that return instances of CompletableFuture. Corresponding methods are also available from ResilienceDecorationStrategy.

Improvements

• OData VDM Generator: add deprecation information contained in the provided Swagger file of a service to generated service classes.
• Update dependencies:
  • Java libraries of SAP Cloud Application Programming Model (com.sap.cloud.servicesdk.*) from version 1.32.0 to 1.32.5
  • Caffeine from 2.7.0 to 2.8.0
  • Commons Codec from 1.12.0 to 1.13.0
  • CXF from 3.2.6 to 3.3.2
  • Resilience4J from 0.16.0 to 0.17.0
  • JUnit from 5.5.0-M1 to 5.5.1
  • AssertJ Core from 3.12.2 to 3.13.2
  • Joda Time from 2.10.2 to 2.10.3
• Reduce log verbosity of ThreadContextExecutor and the accessor classes that use it (e.g. execute... methods in TenantAccessor).

Fixed Issues

• OData VDM: Fix an issue with function imports where special characters in query parameters, e.g. spaces, led to wrong URLs.
• Fix an issue with XsuaaService where it always forcibly used the provider tenant when calling retrieveAccessToken... methods. Now the methods retrieve access tokens for the tenant that called the method.
• Fix an issue with error handling in functions of MultichainService so that it appropriately throws instances of MultichainException.

Version 3.1.0

August 15, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Update the OData virtual data model to the newest release 1908 of SAP S/4HANA Cloud. This includes completely new services (available as usual as from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Message VDM: Update the message virtual data model for the newest release 1908 of SAP S/4HANA Cloud. This includes 21 new message types to reflect the new event types added in SAP S/4HANA Cloud (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.messaging.api.message). The SDK supports all event types listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Improvements

• Update dependency to Jackson Databind to version 2.9.9.2 (from 2.9.9.1) in order to fix reported security vulnerabilities.

Fixed Issues

• Fix an issue where DefaultHttpDestination failed to load the authentication type, so that authentication was not correctly applied when loading destinations from environment variable or instantiating DefaultHttpDestination manually.
• Fix issues with HTTP destinations in the SAP Cloud Platform Neo environment when using EJBs to run code on server startup.

Version 3.0.0

August 1, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Provide builders to construct destinations explicitly by providing values for properties in code, for example, DefaultHttpDestination.builder or ScpCfHttpDestination.builder.
• Give more control when loading a destination by providing DestinationOptions.
  • Different destination loaders such as ScpCfDestinationLoader or ScpNeoDestinationLoader will consider different options that give fine-granular control over the behavior when loading the destination (for example, if provider or subscriber destinations shall take precedence).
  • Construct a DestinationOptions instance via the builder method.
  • Use the augmentBuilder method to set configuration parameters that are specific to a loader (platform or environment) using an appropriate class implementing DestinationOptionsAugmenter.
• Execute code (given as Callable or Executable) by overriding (that is, "on-behalf of") the Tenant, Principal, or AuthToken of the context in TenantAccessor, PrincipalAccessor, and AuthTokenAccessor.
  • At the example of TenantAccessor.executeWithTenant, the given callable/executable will be executed in a context where the given tenant is set as the current tenant.
  • In addition to overriding, provide the option to set a fallback for a single execution (for example, with TenantAccessor.executeWithFallbackTenant) or globally (for example, with TenantAccessor.setFallbackTenant). Whenever, for example, a tenant is requested but not available, the SDK will retrieve a fallback tenant from the given supplier.
• Offer access to the current request, if available, via the new RequestAccessor and allow overriding the request and providing a fallback request when executing code.
• Make XsuaaService public for communicating with a given XSUAA service on SAP Cloud Platform, Cloud Foundry.

Improvements

• Decouple the implementation of resilient behavior from a concrete framework with the generic functional-style adapters in com.sap.cloud.sdk.cloudplatform.resilience. Provide a default implementation of resilience using resilience4j as underlying library.
  • Provide ResilienceDecorator as the entry point for wrapping any code (callabe or supplier) with resilient behavior.
  • Provide ResilienceConfiguration
• Allow using any JSR-107 (JCache) compliant library for caching as part of resilience.
• Allow nesting of ThreadContexts.
• Improve log output on log level "debug" for DefaultMessageDelegator to improve error inspection in the messaging core module.

Version 2.28.0

February 13, 2020 - Maven Central - Javadoc - Release blog

New Functionality

• OData client: Update the OData VDM to the newest release 2002 of SAP S/4HANA Cloud. This includes completely new services (available as usual in package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Improvements

• Update dependencies:
• Apache CXF from version 3.2.11 to 3.2.12 to overcome the security vulnerability CVE-2019-17573.
• Jetty from version 9.4.25.v20191220 to 9.4.26.v20200117 to overcome the security vulnerability CVE-2018-12536.
• Update the Spring dependency for the SAP Cloud Platform multitenancy implementation module to version 4.3.26.RELEASE to overcome the security vulnerability CVE-2020-5397.

Version 2.27.0

January 30, 2020 - Maven Central - Javadoc - Release blog

Improvements

• Enrich the header for HTTP requests issued using the ODataRequestBuilder of OData V2 Connectivity API by the additional fields sap-client and sap-language if corresponding destination properties are defined. You might need to remove the calls to withHeader() to have these headers set automatically.
• Update dependencies:
• Spring from version 5.1.2 to 5.1.13 fixing the vulnerability CVE-2020-5398
• Spring Security from version 5.1.2 to 5.1.7

Version 2.26.0

January 16, 2020 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies:
• Apache TomEE libraries from version 7.0.5 to 7.0.6
• Apache HttpComponents Core from version 4.4.10 to 4.4.12, client from version 4.5.6 to 4.5.10
• Jetty from version 9.4.17.v20190418 to 9.4.25.v20191220

Fixed Issues

• Fix an issue concerning HTTP destinations on Cloud Foundry where the default JDK trust store was mistakenly taken into account even if an own trust store is defined.
• OData VDM client: Fix an issue concerning update requests with PATCH semantics where null values were being filtered out before the update. Explicitly set null values are being retained now.

Version 2.25.0

December 19, 2019 - Maven Central - Javadoc - Release blog

Fixed Issues

• Fix a problem in the retrieval of destinations from the destination service occurring when the subscriber in a provider/subscriber setup has it's own XSUAA service configured.
• Resolve an issue with the headers added to all outgoing connections to on-premise destinations. In the past always the current JWT is used, which caused problems in certain configurations. Now the current JWT is only used if the on-premise destination triggers user propagation.
• Fix OData query formatting for filter expressions with temporal values. This affects queries comparing entity properties based on Edm.Time, Edm.DateTime or Edm.DateTimeOffset.

Version 2.24.0

December 5, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies:
• Apache CXF from version 3.2.6 to 3.2.11 fixing the vulnerability CVE-2019-12406
• Jackson from version 2.10.0 to 2.10.1 fixing the vulnerabilities CVE-2019-17267 and CVE-2019-17531
• SAP Cloud Application Programming Model from version 1.32.0 to 1.35.2

Fixed Issues

• Fix an issue where special characters (e.g. /) were incorrectly escaped in OData requests made when dynamically fetching a navigation property of an entity whose key contains such characters.

Version 2.23.0

November 21, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Create, update, and delete operations have been removed from some VDM services, as they are no longer available on the SAP API Business Hub.

Improvements

• OData client: Update the OData VDM to the newest release 1911 of SAP S/4HANA Cloud. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Version 2.22.1

October 24, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies:
  • Jackson from version 2.9.10 to 2.10.0.
  • Bouncycastle from version 1.60 to 1.64 to address a security vulnerability.

Version 2.22.0

October, 10, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies on Jackson from 2.9.9/2.9.9.2 to 2.9.10.

Fixed Issues

• Fix a security issue (CVE-2019-10086) by replacing all transitive usages of commons-beanutils:commons-beanutils with version 1.9.4 (from 1.9.3 ).
• Fix an issue with metering support on Neo where query parameters were missing from the constructed URL when retrieving OAuth tokens, resulting in failed authentication.

Version 2.21.0

September 26, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Validate user access tokens issued by XSUAA with the verification key retrieved from the XSUAA service, instead of relying on a verification key present in the XSUAA service binding credentials. The retrieved key is cached for 5 minutes (depending on feedback, the cache duration may change in the future).
• Automatically read the principal ID from the user_name claim of the current JWT in ScpCfPrincipalFacade when the JWT has the user_token grant type.

Version 2.20.2

September 12, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Remove listeners-all dependencies from projects generated via archetypes since the SAP Cloud SDK Pipeline will inject this dependency during a pipeline run.

Version 2.20.1

August 29, 2019 - Maven Central - Javadoc - Release blog

Fixed Issues

• OData VDM: Fix an issue with function imports where special characters in query parameters, e.g. spaces, led to wrong URLs.

Version 2.20.0

August 15, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Update the OData virtual data model to the newest release 1908 of SAP S/4HANA Cloud. This includes completely new services (available as usual as from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Message VDM: Update the message virtual data model for the newest release 1908 of SAP S/4HANA Cloud. This includes 21 new message types to reflect the new event types added in SAP S/4HANA Cloud (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.messaging.api.message). The SDK supports all event types listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Improvements

• Update dependency to Jackson Databind to version 2.9.9.2 (from 2.9.9.1) in order to fix reported security vulnerabilities.

Version 2.19.2

August 1, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies to Java libraries of SAP Cloud Application Programming Model (com.sap.cloud.servicesdk.*) from version 1.31.1 to 1.32.0. This fixes an issue where deep insert did not work beyond the first level.

Version 2.19.1

July 18, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependency to Jackson BOM to version 2.9.9.1 (from 2.9.9) in order to fix reported security vulnerabilities.
• The minimum required Maven version in the archetypes is now 3.5.

Version 2.19.0

July 4, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Update dependencies to Java libraries of SAP Cloud Application Programming Model (com.sap.cloud.servicesdk.*) from version 1.29.0 to version 1.31.1. This contains the following fixes:
• Fix encoding of keys that contain a slash in OData by-key requests,
• Close HTTP resources properly in all execution paths to avoid exhausted connection pools, and
• Allow filtering in queries against null values.
• Update Tomcat in scp-cf-tomcat archetype to version 8.5.42.
• Message VDM: Support TextMessage from JMS in JmsMessagingVdmConverter to extract the message payload also from messages of such type (in addition to ByteMessage).
• OData VDM generator: Improve exception message in case of duplicate classes.

Fixed Issues

• OData VDM Generator: fix an issue where the generator failed with an exception in case two entity types with the same name, but different casing are present.

Version 2.18.1

June 20, 2019 - Maven Central - Javadoc - Release blog

Improvements

• OData VDM generator: Add support for entities without key that can be accessed through navigation properties.
• OData VDM: Log a warning during execute for an update request via PATCH if the request will be sent with an empty body when no fields of the entity have been registered as changed.
• Improve performance of getVcapApplication and getVcapServices in ScpCfCloudPlatform by only parsing JSON from the environment variables once instead of parsing it on each invocation.

Fixed Issues

• Fix a connectivity issue in the internal HTTP client where slashes in query parameters would be encoded incorrectly.
• OData VDM generator: Fix an issue where the generator failed to generate Java classes due to a name clash across entity sets and function imports.

Version 2.18.0

June 6, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Message VDM: Update the message virtual data model for the newest release 1905 of SAP S/4HANA Cloud. This includes 30 new message types to reflect the new event types added in SAP S/4HANA Cloud (available from package com.sap.cloud.sdk.s4hana.datamodel.messaging.api.message).

Improvements

• Update dependency to Jackson BOM to version 2.9.9.

Fixed Issues

• Fix an issue in the Multichain module where an exception was incorrectly thrown in listStreams when the result included non-subscribed streams.

Version 2.17.0

May 23, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Update the OData virtual data model to the newest release 1905 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.

Improvements

• Update dependency to JUnit5 to version 5.5.0-M1.
• Remove Lombok dependency from the Spring archetype, as it is not required from the start and may appear counter-intuitive for new projects.

Fixed Issues

• Fix a connectivity issue in the internal HTTP client where URIs would be encoded twice, leading to incorrect request URIs.
• OData VDM: Fix changed fields being converted to upper-case, leading to incorrect field change detection.

Version 2.16.0

May 9, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Support communicating with SAP S/4HANA Cloud systems connected via SAP Cloud Platform Extension Factory.
  • Introduce ScpXfDestinationFacade to read destinations from the VCAP_SERVICES environment variable in Cloud Foundry (as used by Extension Factory).
  • Background: SAP Cloud Platform Extension Factory creates named service instances for connected APIs of SAP S/4HANA Cloud and binds them to applications on Cloud Foundry.
  • Introduce FallbackDestinationFacade to use destination service and extension factory in parallel. The FallbackDestinationFacade allows to specify as constructor parameters one primary DestinationFacade and a secondary facade as fallback that is used if no destination of a given name is found using the primary facade.
  • Register the desired facade configuration at application startup using DestinationAccessor.setDestinationFacade.

Improvements

• OData VDM: support update request to OData APIs with PUT semantics (replace).
  • Allow controlling the HTTP method and strategy to use for update requests via the following Java methods. PATCH remains the default.
  • To use HTTP method PUT and send the full entity that is meant to replace the current state of the entity, call replacingEntity on any fluent helper for update requests.
  • To revert to using PATCH and only send changed fields (which is also the default if nothing is specified), call modifyingEntity.
• Update dependency to Tomcat used in the scp-cf-tomcat archetype to version 8.5.40 (from 8.5.23) due to a known vulnerability (CVE-2019-0232).
• Retrieve current principal via PrincipalAccessor also in case of a JWT with scope authorization_code.

Fixed Issues

• Fix wrong deserialization of MultichainTransaction.

Version 2.15.0

April 25, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Support batch processing of update, create, and delete operations in OData.
  • Group several OData operations as a single request to a system.
  • For now, only change sets are supported as part of the batch request, no reading operations.
  • Use the batch method available on each service representation to begin constructing a batch request.
  • The returned fluent helper (for example, BusinessPartnerServiceBatch) allows to begin a new change set, add operations to this change set, and end the change set.
  • After adding the desired change sets, execute the batch request as usual.
  • The returned BatchResponse gives access to the results of individual change sets accessible by their index, returned as a Try that wraps the actual result or any exception.
  • Batch requests only have a meaningful return value (beyond success / error) for create operations. Created entities returned from the server are accessible via getCreatedEntities.
• OData VDM: Allow counting the number tuples that match the criteria specified in a query.
  • Use the count method available on all fluent helpers for queries.
  • Calling execute on the fluent helper for count then returns the number of tuples.
  • You can apply other query modifiers such as filter beforehand. Query options top and skip have no effect on the result.
  • This executes a query with $inlinecount query option and does not return any actual tuples, just the count.
• OData VDM: Allow appending non-standard query parameters to reading OData requests via method withCustomQueryParameter (also available for by-key requests).
• Support destinations on Cloud Foundry with authentication type OAuth2UserTokenExchange.
  • Similar to the OAuth2SAMLBearerAssertion, the user exchange token flow is conducted with the XSUAA which issues a JWT encompassing the user principal.
  • This authentication type targets use cases where apps/reuse services on Cloud Foundry are invoked on behalf of the user, opposed to the usage of technical user via client credentials flow.

Improvements

• Message VDM: no longer rely on the message topic (as defined in JMS) to determine the type of message received. Instead, use the eventType property found in message payloads that follow the cloudevents specification, like SAP S/4HANA Cloud.
• OData VDM Generator: allow exiting the generation with failure in case a warning occurs. Use the flag failOnWarning (introduced both in the CLI and in the Maven plugin) for this purpose.
• OData VDM Generator: annotate all generated code files with a comment in the beginning of each file that references the used generator version.

Fixed Issues

• Fix incorrect invocation of MultichainCommand in MultichainService class which would lead to the code being executed within the same thread, not the intended thread pools of Hystrix.

Version 2.14.0

April 11, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Message VDM: Add new standalone message converter classes that can convert plain strings or JMS messages to Message VDM messages.
  • Introduce the MessageFactoryMapper interface for mapping of message types to message factory class names.
  • Provide a default implementation of MessageFactoryMapper called VdmMessages for currently supported message types.
  • To convert plain string-typed message payloads, instantiate a MessagingVdmConverter with the desired MessageFactoryMappers and call the method fromMessage.
  • To convert JMS messages, instantiate a JmsMessagingVdmConverter, which will use VdmMessages for mapping, and then call the fromMessage method.
  • Add a new constructor for JmsMessageDelegator that accepts a JMS message converter instance.
• Access information about the current principal (user or client) via PrincipalAccessor. The returned Principal object includes the identifier of the principal, which is either the user_name or client_id, depending on the current grant_type, as well as authorization information. In the Neo environment of SAP Cloud Platform, the principal is equivalent to the user.

Improvements

• Add m2eclipse lifecycle mappings for the scp-neo-maven-plugin, odata-generator-maven-plugin, and pmd-plugin to integrate the plugins with Maven in Eclipse and remove warnings like "plugin execution not covered by lifecycle configuration".
• Support using default values for the audiences of the JWT created when running operations on behalf of specific tenants.
  • Introduce onBehalfOfTenant( @Nonnull String tenantId ) that uses default values for issuerUrl and audiences.
  • Introduce the more specific method onBehalfOfTenant(@Nonnull String tenantId, @Nonnull String issuerUrl, @Nonnull Collection<String> audiences ) for full customization of these values. This method replaces the previously existing method.
  • When using the method with default values, the list of audiences will be initialized with the own application name as taken from the XSUAA service binding context.

Fixed Issues

• Fix an issue on Cloud Foundry and Neo where accessing a destination with a valid URL led to an URL parsing exception if at least one other destination returned by the destination service had an invalid URL.
• Fix an issue with incorrect serialization of negative numbers when using RFC queries via JCo.

Version 2.13.3

March 28, 2019 - Maven Central - Javadoc - Release blog

Improvements

• Add m2eclipse lifecycle mappings for the s4sdk-maven-plugin to integrate the plugin with Maven in Eclipse and remove warnings like "plugin execution not covered by lifecycle configuration".

Fixed Issues

• Fix an issue with GsonMessageBodyProvider where readFrom did not properly sanitize the JSON input to be converted.

Version 2.13.2

March 14, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Allow caching metadata of OData services on a tenant-level in order to improve performance by reducing the number of HTTP requests made for each OData call.
  • To enable caching for a request, use the method cachingMetadata on fluent helpers. Revert to the default by using withoutCachingMetadata.
  • By default, metadata will not be cached and instead still be fetched for each request, as before.
  • Please note that as of now it is not possible to invalidate the cache, so use of this feature is only advised where changes to the OData service are rare.
• (Beta) Introduce a new module blockchain for interacting with the SAP Cloud Platform Blockchain service.
  • Provide experimental classes for interacting with MultiChain blockchains.
  • Compared to the previous, now deprecated API, the new MultichainService offers fluent and type-safe access to MultiChain commands.
• Run operations on behalf of specific tenants.
  • Use the new method onBehalfOfTenant of JwtBasedRequestContextExecutor to execute code in a context for the tenant with the given tenandId.
  • Based on this value a JWT access token will be generated and used internally.
  • The content of the JWT can be influenced with the optional parameters issuerUrl and audience. Depending on the code executed on behalf, certain token audiences may be required. If no URL is provided, a default will be created to match the XSUAA service URL expected for the subscribed tenant.

Improvements

• OData VDM: Make the error result handler of the VDM more robust and return relevant information also about unexpected errors.
• Update dependencies:
  • Java libraries of SAP Cloud Application Programming Model from 1.24.0 to 1.27.0.
  • Neo SDK in archetype scp-neo-javaee7 to 1.44.12.
  • AssertJ Core from 3.11.1 to 3.12.0.
• Allow passing a WireMockConfiguration to MockUtil.mockServer and MockUtil.mockErpServer. This enables the customization of mock servers upon initialization, e.g. address mapping, port mapping, thread settings, SSL- and proxy configuration.

Fixed Issues

• Fix an issue where determining the XSUAA for JWT verification in user token flows did not work when scope names contained dots.
• OData VDM: Fix an issue where CSRF token retrieval for function imports failed if the target service responded with an error status code.
• Fix an issue where HttpCachingHeaderFilter did not add HTTP response headers in certain situations. For example, when the consuming application is using JAX-RS, the filter operation was not triggered in the past. With the new implementation, the cache headers will be set in these cases as well. It is now recommended to place the filter at the end of the filter chain, instead of the beginning.

Version 2.12.0

February 28, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Allow callers to decide how to deal with errors during remote execution of BapiQuery and RfcQuery by specifying an own error handler.
  • The error handler can decide based on the passed BapiQueryResult or RfcQueryResult if a RemoteFunctionException shall be thrown.
  • In addition, both BapiQuery and RfcQuery offer convenience methods as part of their fluent API to always ignore errors or to always propagate them as exceptions.
  • The default, as before, is always propagating errors as exceptions.

Improvements

• OData VDM: Allow passing a FilterExpression from the SAP Cloud Application Programming Model as an UncheckedFilterExpression.
  • Note that this approach discards type-safety and should only be used when it is desired to pass a filter query option directly.
  • Use the FilterExpressionConverter provided by the Cloud Application Programming Model to convert an expression from a query request to a FilterExpression.
• OData VDM: Improve generated Javadoc of virtual data model classes.
• Update maven-surefire-plugin used in archetypes from 3.0.0-M2 to 3.0.0-M3.

Fixed Issues

• Fix an issue where BapiQuery and RfcQuery had been committed asynchronously despite the API promising a synchronous commit.
  • The implicit transaction commit is now working synchronously by default. This fix assures that changes have propagated completely before continuing with the application execution.
  • The previous behavior can be toggled by using the newly introduced optional parameter on the query constructor that expects a CommitStrategy, which also allows not committing the call as a third option.
• Fix an issue where BapiQuery and RfcQuery did not throw a RemoteFunctionCommitFailedException in case the transaction could not be committed successfully. The change only applies to JCo-based RFC transactions; SOAP-based operations are not affected.

Version 2.11.1

February 14, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• OData VDM: Update the OData virtual data model to the newest release 1902 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• (Beta) Provide a virtual data model (VDM) for messages that represent business events from SAP S/4HANA Cloud.
  • This experimental message VDM simplifies the consumption of events in a type-safe manner, based on existing services such as SAP Enterprise Messaging and existing frameworks such as Java Message Service (JMS).
  • The module messaging-api contains Java classes representing each of the business event types that an SAP S/4HANA Cloud system (release 1902) may emit, as well as corresponding listener interfaces that you can implement to handle messages in a type-safe manner.
  • The module messaging-jms provides a message delegator for dispatching messages received via JMS to registered listeners.

Improvements

• Introduce a method getXsuaaServiceToken() to the AuthTokenAccessor that allows the caller to receive a JWT from the XSUAA service bound to the application.
• Adjust the behavior of TenantAccessor.getCurrentTenant() to fallback to the provider tenant on Cloud Foundry in case no tenant is available in the current request context.
  • This simplifies using the SDK in case of request-less tasks, like startup jobs or message handling.
  • The new behavior is achieved by calling AuthTokenAccessor.getXsuaaServiceToken() in case AuthTokenAccessor.getCurrentToken() does not return a token.
• Introduce a method withXsuaaServiceJwt() to the JwtBasedRequestContextExecutor that creates a request context using a JWT internally retrieved from the aforementioned AuthTokenAccessor.getXsuaaServiceToken method so that manually passing a JWT is not necessary.
• Support the authentication type client certificate for destinations on Cloud Foundry.
• Increase the default memory allocated for metaspace to 128 MB in projects generated from the archetypes.

Fixed Issues

• Fix an issue (introduced in version 2.9.1) where navigation properties of VDM entities were not serialized when using Gson.
• Fix an issue where TenantAccessor.tryGetCurrentTenant and UserAccessor.tryGetCurrentUser returned Success(null) in case the tenant is not available instead of propagating the TenantNotAvailableException.
• Fix an issue with fetching JWT refresh tokens in cases where there are multiple XSUAA service instance bindings using the same service plan.

Version 2.10.0

January 31, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Java VDM: Support both versions of the Bill of Materials API.
  • The newer version 2 is available as BillOfMaterialsV2Service.
  • The previous version 1 is available as BillOfMaterialsService.

Improvements

• Return String-typed user attributes as instances of StringUserAttribute instead of SimpleUserAttribute<String> on SAP Cloud Platform Neo, and as StringCollectionUserAttribute instead of CollectionUserAttribute<String> on Cloud Foundry to allow more convenient consumption.
• Update dependencies:
  • Spring to 5.1.2.RELEASE and Spring Boot to 2.1.1.RELEASE,
  • Surefire Maven plugin to 3.0.0-M2,
  • Jackson BOM to version 2.9.8.
• Add some additional CDI scanning exclusions for the BAPI virtual data model to the scp-cf-tomee, scp-cf-tomcat, scp-neo-javaee7 archetypes to further reduce memory consumption.
• Enhance the ForEachSystemRule test utility to support the notion of fallback systems. These are systems for which the tests are executed (in-order) after the test failed with the first configured system. A test is considered successful if at least one of the specified systems succeeds.
• Java VDM: Add additional @Nonnull annotations to public methods where applicable.

Fixed Issues

• Fix an issue where the XSUAA service instance credentials could not be found for a given JWT when using multiple XSUAA instances along with the broker plan of XSUAA.
• Fix an issue with projects created by the scp-cf-tomee archetype where TomEE would not start because of a conflict with the default shutdown port 8005 on Windows. Now, shutdown port 8006 is explicitly specified in application/pom.xml.
• Fix an issue with projects generated by the scp-cf-tomcat archetype where integration tests failed when run from an IDE because of a missing port configuration for arquillian. Now, a default port 9090 is defined in arquillian.xml which takes effect unless a system property arquillian.httpPort is passed to the test runner. Note: in IntelliJ, you still need to disable passing systemPropertyVariables to JUnit in File | Settings | Build, Execution, Deployment | Build Tools | Maven | Running Tests or pass -Darquillian.httpPort=9090 manually.

Version 2.9.1

January 17, 2019 - Maven Central - Javadoc - Release blog

New Functionality

• Java VDM generator: allow selectively generating Java virtual data model classes (fluent helpers and entities) for specific entity sets and/or function imports.
  • Use the new options of the VDM generator command line interface --include-entity-sets and --include-function-imports which take a comma-separated list of entity set or function import names.
  • Use the new Maven plugin list parameters includeEntitySets and includeFunctionImports which take a set of <param> tags, each containing the name of an entity set or function import, respectively.
  • When no filter on entity sets is provided, all entity sets are processed as before. When no filter on function imports is provided, all function imports are processed as before.
  • When filtering entity sets, please note that entities referenced by navigation properties are not automatically included transitively. Their entity sets must be added manually to the parameter, otherwise the generator will skip the corresponding navigation properties.
  • When filtering function imports and if a desired function import has an entity as the return type, then its entity set must be added to the entity set parameter (or all entity sets generated).

Improvements

• Support nesting of multiple RequestContextServletFilters to enable stepwise initialisation of objects. Set the property useParentContext to true to enable this.
• Combine the default service URI in the abstraction for SAP Leonardo machine learning services with the original request path, query, and fragment of the URI provided as part of the request parameter to the invoke method. This gives callers more flexibility on what URL will be called.

Fixed Issues

• Java VDM: Fix an issue where the version identifier field was not correctly deserialized when manually instantiating a VDM entity from a previously serialized JSON.
• Fix issues with Hibernate in Spring Boot projects by managing javax.validation:validation-api to 2.0.1.Final in scp-cf-spring archetype.
• Fix an issue where Maven reported warnings about the s4sdk-maven-plugin in parallel builds.

Version 2.9.0

December 20, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Provide a new method attachToService in all entity classes to allow setting the service path and ErpConfigContext after creating an entity manually.
  • Both parameters are optional and set to default values if not provided.
  • A thus configured entity can be used to issue calls to the backend system such as fetching associated entities.
  • Deprecate previously existing methods on entities to set the ErpConfigContext. Please use the attachToService method instead for setting the ErpConfigContext.

Improvements

• Add a beans.xml file to projects created by the scp-cf-tomee, scp-cf-tomcat, and scp-neo-javaee7 archetypes that excludes VDM namespaces from CDI scanning.
  • This strongly reduces the required memory of the application.
  • If your project is based on JavaEE and does not yet use a beans.xml file, it is recommended to include the following scan exclusions to achieve the same in already generated projects:

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
      bean-discovery-mode="annotated">
      <scan>
          <!-- do not scan namespaces since CDI is only required for service classes -->
          <exclude name="com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.**"/>
      </scan>
    </beans>

• Update scp-cf-tomee archetype to use TomEE 7 (Web Profile).
• Add hints to scp-cf-spring archetype how to setup security and manage spring-security and spring-security-oauth2 in the SDK's bill of material (BOM).
• Improve configuration of surefire and jacoco plugins in archetypes to avoid the need to adjust the IntelliJ configuration with the argLine flag when running tests.
  • This also affects how the TomEE adapter for Arquillian is configured, now introducing the system property surefire.forkDir which is set by the surefire plugin and referenced in the src/test/resources/arquillian.xml configuration file.
• Offer an additional method tryGetCurrentUser in UserAccessor and UserFacade which returns a Try for the current user.
  • This object contains the current user (possibly null) or any possibly thrown exception, also allowing to write idiomatic code without try-catch-blocks.
  • For more details on this monadic container type, refer to the Vavr user guide.
• Update dependencies:
  • Use final stable version 1.5.18 of Hystrix (updated from 1.5.11).
  • Use the Jackson BOM to manage compatible version of the Jackson dependencies. This changes the version of com.fasterxml.jackson.core:jackson-annotations from 2.9.7 to 2.9.0. According to the Jackson documentation there are no code changes in these minor releases.

Fixed Issues

• Fix an issue with the audit logger where AccessRequester objects always tried to access the HTTP servlet request instead of taking the user from the UserAccessor, which is more stable and supports different usage scenarios.
• Java VDM generator: Fix an issue where the name of generated methods may have led to name clashes with already existing methods.

Version 2.8.1

December 7, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Transparently support authentication type OAuth2 Client Credentials with destinations on SAP Cloud Platform Cloud Foundry and Neo.

Improvements

• Java VDM generator: support function imports that return a primitive type or that do not have a return value.
• Update surefire plugin used in archetypes to 3.0.0-M1.

Fixed Issues

• Java VDM: Fix a bug with ignoreVersionIdentifier where no If-Match: * header was sent if no version identifier was set on the entity. Now, If-Match: * will always be sent when activating ignoreVersionIdentifier on update and delete requests to force an overwrite.
• Fix an issue with the scp-cf-spring archetype that led to failures in generated projects when running tests with Java 11.

Version 2.8.0

November 22, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Java VDM: Update the OData virtual data model to the newest release 1811 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• (Beta) Simplify building applications that use SAP Conversational AI (also known as Recast.AI) to build chat bots with an experimental module com.sap.cloud.s4hana.services:recast-ai.
  • Provide classes that make interacting with the Recast.ai API easy.
  • Represent user requests sent by Recast.ai as instances of Java classes.
  • Represent bot responses to be sent by Recast.ai as instances of Java classes.
  • Note: Be aware that this module is experimental and might therefore be subject to breaking changes or discontinuation in the future.
• Introduce Maven plugin com.sap.cloud.s4hana.plugins:s4sdk-maven-plugin for collecting usage data and diagnosis reports and add it to all archetypes.

Improvements

• Java VDM: Support filtering entities by properties of associated entities where the cardinality of the association is at most one. To this end, the Java representation for such properties (such as CustomerOneToOneLink) provides a filter method.
• Make it possible to change the behavior for determining the local scope prefix of OAuth scopes when instantiating a user facade on Cloud Foundry.
  • You can provide your own behavior by implementing the LocalScopePrefixProvider interface and supplying an instance to the ScpCfUserFacace.
  • By default, the SDK will use the DefaultLocalScopePrefixProvider.
• Improve naming of methods in HttpClientAccessor by introducing methods setHttpClientFactory and getHttpClientFactory that correspond to the HttpClientFactory interface and deprecating methods setHttpClientProvider and getHttpClientProvider.

Fixed Issues

• Java VDM: Fix a bug (introduced in version 2.4.1) where the list returned by the getAll* methods of the OData VDM API was immutable.
• Java VDM generator: Fix issues with name clashes between entity representations and helper classes by moving helper classes to separate sub-packages.
• Java VDM generator: Fix a bug where similar field names in entities could lead to non-compiling code due to the way Lombok generates getter methods.

Version 2.7.0

November 8, 2018 - Maven Central - Javadoc - Release blog

Improvements

• Allow wrapping a RequestContextExecutor within another request context. By default this is disabled. You must enable this functionality by using the withParentRequestContext() method.
• Update dependencies:
  • spring-framework-bom from 5.1.0.RELEASE to 5.1.1.RELEASE
  • spring-boot (used in archetype scp-cf-spring) from 2.0.5.RELEASE to 2.0.6.RELEASE.
• Adapt Javadoc of AccessedAttribute to reflect that the operation will not be sent to the Audit Log when running on Cloud Foundry.

Fixed Issues

• Java VDM: Fix an issue where multiple calls to orderBy would result in the query to only contain the ordering expression of the last method call instead of chaining the ordering according to the order in which the method is called.
• Downgrade Hystrix to 1.5.11 (from 1.5.12) due to an unresolved issue with circuit breakers in later versions. For details, please refer to the respective GitHub issue.
• Fix a bug in the Audit Log abstraction where logDataWrite() and logDataWriteAttempt() logged wrong values for oldValue and newValue
  • NOTE: If you are logging changes on personal data, passwords, or similar sensitive data, it is your responsibility to ensure that the logs do not contain such sensitive data.
  • This affects both Neo and Cloud Foundry.

Version 2.6.1

October 25, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Allow transparently refreshing JWTs using supplied refresh tokens in a JwtBasedRequestContextExecutor to improve support for asynchronous scenarios such as messaging.
  • Supply a refresh token using JwtBasedRequestContextExecutor.withJwt(jwt, refreshToken).execute(() -> {}) to allow the SDK to automatically refresh the JWT in case it has expired.
  • While most of the flow is handled by the SDK, getting, storing, and possibly transferring the refresh token between services is the developer's responsibility, supported by a new method of the AuthTokenAcccessor (see below).
  • Please note that for this to work between multiple services, the services have to be bound to the same XSUAA instance.
  • In order to retrieve a refresh token for a given JWT, the JWT must contain the scope uaa.user.
• Add new method AuthTokenAccessor.getRefreshToken() for retrieving a refresh token.

Improvements

• Support multiple bindings to Authorization & Trust Management (XSUAA) service instances.
  • Previously, the SDK assumed that there exists only a single binding to a service instance of the XSUAA service for a given application. Now, the SDK transparently supports the case that an application has multiple bindings to instances of the XSUAA service.
  • Introduce functions that explicitly return a list of credentials, in addition to the existing methods that assume a single binding: ScpCfCloudPlatform.getXsuaaServiceCredentialsList(), ScpCfCloudPlatform.getConnectivityServiceCredentialsList(), ScpCfCloudPlatform.getDestinationServiceCredentialsList()
  • Please note that calling the old functions (e.g. getXsuaaServiceCredentials()) will still throw exceptions on multiple bindings.
• Update several dependencies to the latest available version, and:
  • Use scope compile instead of provided for spring-web in com.sap.cloud.s4hana.frameworks:spring-web.
  • Add an explicit dependency to org.skyscreamer:jsonassert in the scp-cf-spring archetype along with an exclusion to com.vaadin.external.google:android-json to avoid runtime conflicts with org.json:json. Details on this issue can be found here.
• Offer an additional method tryGetCurrentTenant in TenantAccessor and TenantFacade which returns a Try for the current tenant. This object contains the current tenant (possibly null) or any possibly thrown exception, also allowing to write idiomatic code without try-catch-blocks. For more details on this monadic container type, refer to the Vavr user guide.

Fixed Issues

• Fix an issue where SoapQuery did not properly respect the proxy configuration.

Version 2.5.0

October 11, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Java VDM: Support OData media streams that are accessible via the /$value path on an entity.
  • Entities such as AttachmentContent which expose media streams have a new method called fetchAsStream().
  • The usage of the method is similar to a navigation property fetch method. It returns a java.io.InputStream that represents the media content.
  • The entity must have been retrieved first from the service, and there is no caching of input streams.
• (Beta) Improve the simple consumption of SAP Leonardo services.
  • Offer a simple Java API to consume services from SAP Leonardo Machine Learning Foundation and SAP Cloud Platform Blockchain (Hyperledger Fabric and MultiChain).
  • Include the following Maven dependencies to leverage the new convenience classes: com.sap.cloud.s4hana.services:scp-machine-learning and com.sap.cloud.s4hana.services:scp-blockchain.

Improvements

• Transform the interface Authorization into a Java class.
  • This simplifies the transition of code related to authorization checks across the Neo and Cloud Foundry environments of SAP Cloud Platform.
  • On Neo, an Authorization refers to a role, while on Cloud Foundry, it refers to a scope.
  • Accordingly, the method User::hasAuthorization now performs the platform-specific check based on the passed instance of Authorization.

Fixed Issues

• Fix an issue where queries could not be executed on Java VDM entities that were loaded through function imports or by fetching navigation properties.
• Fix an issue where the missing mocking of the TenantContext in ScpNeoTenant when mocking a tenant with MockUtil on Neo could cause a NullPointerException when running tests that executed a Hystrix command within a RequestContextExecutor.
• Fix an issue where surefire.forkCount was not being applied correctly when running tests in projects created from the archetypes.
• Fix an issue in MeteringStats where calling its methods in a RequestContextExecutor caused an exception to be thrown about duplicate request contexts.
• Make exceptions classes TokenRequestDeniedException and TokenRequestFailedException public, as they are exposed as part of the API, so that they can be caught.

Version 2.4.2

September 27, 2018 - Maven Central - Javadoc - Release blog

Improvements

• Designate services on SAP Cloud Platform, Cloud Foundry by any combination of parameters (service type, plan, name) when instantiating a ScpCfService (beta) that grants easy access to those services.
  • Introduce ScpCfServiceDesignator (beta) to flexibly identify Cloud Foundry services with a convenient builder pattern.
  • Add additional static constructor methods to ScpCfService that take such a designator instead of service type and plan.

Fixed Issues

• Java VDM generator:
  • Fix a bug when specifying a key field with the name or label key.
  • Sanitize the automatically generated as well as manually specified mappings from serviceNameMappings.properties file so that valid Java identifiers will get created from them.
  • Gracefully handle multiple schemas in metadata document when identifying the base path of the OData service.
• Java VDM: Fix a bug in the default ODataVdmErrorResultHandler where the httpStatusCode of the exception was not set properly.

Version 2.4.1

September 13, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Introduce the SoapQuery class for convenient consumption of SOAP APIs exposed from SAP S/4HANA.
• Java VDM: allow creating OData entities as child of another entity.
  • Use the method asChildOf of corresponding fluent helpers.
  • After calling this method, executing the OData request will create the new entity via another (parent) entity that is related via the given navigation property.
  • This can be used to create entities in case they cannot be created directly, or if it is more convenient to create them via their relationship to an existing entity.

Improvements

• Enhance the DestinationAccessor class by the static methods getRetrievalStrategy and setRetrievalStrategy.
  • For a given destination name, you can set the strategy for loading the destination to any of the strategies defined by DestinationRetrievalStrategy.
  • This applies to environments where tenants subscribe to an application and may have destinations configured in their own sub-accounts.
  • For example, to prevent subscribers from overriding a destination you would set its strategy to DestinationRetrievalStrategy.ALWAYS_PROVIDER
  • These settings are not persisted. They are only stored in memory for as long as the application is running.
• Java VDM: Enhance the OData VDM to handle optimistic concurrency control also for delete and get-all requests by using ETag version identifier automatically.
  • Get all requests receive the ETag value for each entity and store them as version identifier in the corresponding Entity.
  • Delete calls take the ETag value from the entity to be deleted and provide it as the If-Match header.
• Update all Cloud Foundry archetypes to use the new attribute buildpacks in manifest.yml which replaces the deprecated attribute buildpack. Visit the official documentation for more details.
• Use "http" as default URI scheme if the proxy of HTTP destinations specified by property proxy misses the URI scheme. Formerly, an exception was thrown at runtime. Now, an info message is logged.

Fixed Issues

• Enhance all Cloud Foundry archetypes to use the timeout attribute in manifest.yml and increase the deployment timeout to 5 minutes in order to avoid issues with larger deployments.

Version 2.3.1

August 16, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Update the OData virtual data model to the newest release 1808 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Java VDM: readily execute OData requests in a resilient and/or asynchronous manner wrapped as a Hystrix command.
  • This is supported for any OData operation via the asResilientCommand method of fluent helper. To execute an OData request in a resilient manner, instead of calling service.getAllBusinessPartner().execute(), call service.getAllBusinessPartner().asResilientCommand().execute().
  • This uses under the hood the new class ODataRequestCommand, a sensible-default implementation of ErpCommand for OData requests

Improvements

• Update the BAPI virtual data model for SAP S/4HANA Cloud 1808.
• Manage the version of the OData v2 provisioning libraries of the application programming model for SAP Cloud Platform in the BOM of the SAP S/4HANA Cloud SDK.
  • This allows to quickly use the corresponding libraries for providing OData v2 services by adding required dependencies to the dependencies of a project.
  • In particular, this includes the following dependencies: com.sap.cloud.servicesdk.prov:api, com.sap.cloud.servicesdk.prov:odata2.web, com.sap.cloud.servicesdk.prov:odata2.xsa, com.sap.cloud.servicesdk.prov:odatav2-hybrid, and com.sap.cloud.servicesdk.prov:odatav2-prov.
  • Note: capabilities of the application programming model were mentioned under the name SAP Cloud Platform SDK for service development in previous release notes.
• Upgrade dependencies relevant for the application programming model for SAP Cloud Platform from 1.18.0 to 1.19.0.
• Throw unchecked exceptions when errors (regarding null handling and type conversion) occur during the parsing of OData payloads in the VDM. Previously, checked exceptions would be thrown. In cases where the errors cannot be recovered from, an ODataPayloadParsingFailedException will be thrown, which is a RuntimeException.
• Java VDM generator: do not generate links to the SAP API Business Hub by default in Javadoc. In order to still generate these links in case you generate a Java VDM for services available on the API Hub, you can use the following flags:
  • In the DataModelGenerator class, use the methods linkToApiBusinessHub(boolean) or linkToApiBusinessHub().
  • In the Maven plugin, use the parameter linkToApiBusinessHub.
  • In the command line interface, use the argument --generate-links-to-api-business-hub.
• Deprecate getHeaderParameters in the class Query and introduce a new method with name getCustomHttpHeaders to better reflect the purpose of this method. The deprecated method will be removed in one of the next releases.
• Update dependency to Java JWT to 3.4.0.
• Update Spring Boot in scp-cf-spring archetype to 2.0.4.RELEASE.

Fixed Issues

• Fix .gitignore files not being correctly generated by archetypes. The ignore file includes sensible defaults, including ignoring credential files to avoid accidentally committing them to Git.

Version 2.2.0

August 2, 2018 - Maven Central - Javadoc - Release blog

New Functionality

• Execute code in a request context constructed from a manually supplied JSON Web Token (JWT) with the JwtBasedRequestContextExecutor. The new class allows specifying a JWT and execute code as if the JWT has been provided as part of a HttpServletRequest. This can be useful in asynchronous scenarios.
• Java VDM: Use a type converter when getting and setting custom fields of VDM entities in order to convert from and to a specific type instead of the default OData type.
  • Create an instance of an appropriate EntityField subclass to represent the custom field and supply a type converter. Getters and setters using this EntityField representation will automatically use the converter.
  • For example, custom fields of OData type Edm.DateTime can be handled as LocalDateTime instances instead of Calendar, which would otherwise be the default type representation of such custom fields, by using the LocalDateTimeCalendarConverter. Similar converters exist out-of-the-box for LocalTime and ZonedDateTime.
  • Please note that type conversion can only be used when accessing custom fields using an EntityField instance, not when using a string identifier or when getting all custom fields.
  • Corresponding entity field representations can also be created using the method field(String, TypeConverter<T, DomainT>) (example) of the corresponding VDM entity class.

Improvements

• Java VDM: Manually specify the service path on an OData service to override the default service path in case the OData service can be reached at a different path than the default path in SAP S/4HANA Cloud.
  • All VDM services provide a new method withServicePath(String) (example) to specify a custom service path that will override the default service path. The returned new service instance will use the provided service path for all OData requests. The method leaves the original service instance unchanged.
  • All VDM service interfaces provide a new static field named DEFAULT_SERVICE_PATH (example) with the value of the default service path from SAP S/4HANA Cloud that is used if no custom service path has been specified.
• Add parameters to queries that will be sent as HTTP headers if the query is sent via HTTP.
  • The withCustomHttpHeader method of the base Query class provides a fluent API for adding single string-based key-value pairs, and the method withSameCustomHttpHeadersAs copies header parameters from another query.
  • The headers will only be sent if the query is sent via HTTP and ignored otherwise. For example, BAPI queries sent via SOAP to SAP S/4HANA Cloud will include the header parameters, but not queries that use JCo transactions.
• Upgrade SAP Cloud Platform SDK for service development from 1.17.1 to 1.18.0.
• Update dependencies to address known security vulnerabilities in those libraries:
  • Apache CXF from 3.2.4 to 3.2.5.
  • Jetty from 9.4.10.v20180503 to 9.4.11.v20180605.
  • BouncyCastle from 1.59 to 1.60.

Fixed Issues

• Fix an issue where audit log messages were tried to be sent without subject or object identifier, resulting in errors at runtime. Now, if no identifier is provided by the consumer, a randomly generated string will be forwarded to the Audit Log API. To log with a custom identifier, use the newly provided constructors of AuditedDataSubject and AuditedDataObject.

Version 2.1.2

July 5, 2018 - Maven Central - Release blog

New Functionality

• Java VDM generator: Provide an option to exclude files from the input folder, for which no Java VDM should be generated. The option is available in the Maven plugin (<excludes>), for the command line interface (--excludes), and for the Java class (withExcludeFilePattern). It accepts an ant-style pattern such as "*us_en.xml,*DE_de.edmx". All files matching the pattern will be excluded.
• Java VDM and generator: Introduce new annotation Key for fields in Java VDM entity classes that are defined to be part of the key. The annotation will be added by the default annotation strategy of the Java VDM generator. Pre-delivered Java VDM entities have this annotation applied to all key fields as well.

Improvements

• Java VDM: Provide a replacement for the now deprecated withHttpHeader method of fluent helpers called withCustomHttpHeader, which provides the same functionality in a fluent manner and additionally has the option to specify headers only for the actual OData request, but not any preflight request.
• Java VDM generator: exit gracefully if no metadata files are found in the input folder, as well as in other error cases. Instead of throwing an exception, print a warning message in the log.
• Improve scp-cf-tomcat archetype:
  • Enable context and dependency injection with Weld.
  • Use cargo-maven2-plugin instead of jetty-maven-plugin in local deployments to use a pure Tomcat. Accordingly, instead of mvn jetty:run, now run the local deployment with mvn package cargo:run.
  • The archetype now correctly uses Tomcat instead of TomEE in integration tests.
• Use jaxrs profile in TomEE Maven plugin of scp-cf-tomee archetype for parity between local deployment and deployment on Cloud Foundry with the SAP Java Buildpack.
• Update versions of maven plugins in the archetypes.
• Update Spring Boot in scp-cf-spring archetype to 2.0.3.RELEASE.
• Remove obsolete -XX:MaxPermSize flag from archetypes.
• Add Spring BOM to BOM of SAP S/4HANA Cloud SDK and update Spring to 5.0.7.RELEASE.
• No longer use scope "provided" for Apache CXF dependencies in frameworks module cxf, but mark them as optional instead.

Fixed Issues

• Fix an issue where using a proxy with scheme http would throw an UnsupportedSchemeException.
• Upgrade jackson libraries from 2.9.5 to 2.9.6 to prevent yet undisclosed vulnerability.
• Fix typo in index.html welcome pages of archetypes.
• Remove org.skyscreamer:jsonassert from BOM.
• Flag AuthToken property in AuthTokenRequestContextListener as confidential so that it is not written to logs.

Version 2.1.0

June 7, 2018 - Maven Central - Release blog

New Functionality

• Introduce experimental class ScpCfService for access to services on Cloud Foundry including OAuth2 authentication flow.

Improvements

• Redesign the audit logging modules to enable GDPR-compliant audit logging.
  • Introduce new classes AuditedDataObject for information about the data being accessed/modified and AuditableDataSubject for the owner of the data being accessed/modified.
  • Replace String-typed parameters objectId and objectName by parameters expecting AuditedDataObject and AuditableDataSubject.
  • Remove String-typed parameter message except for security event audit log messages.
  • Add tenant identifiers to AccessRequester along with automatic retrieval from current requests. If you experience issues with tenant identifiers in tests, make sure to mock the tenant using mockCurrentTenant() in MockUtil.
• Replace Jwt and JwtDecoder classes with DecodedJWT provided by java-jwt.
• Add isConfidential flag to Property to indicate whether a property must be handled confidentially, e.g., by not writing its contained value and exception to the log.
• Update dependencies
  • Update Apache HTTP client to 4.4.9 (httpcore) and 4.5.5 (client libraries).
  • Update SAP Cloud Platform SDK for service development to version 1.17.1.
  • Update com.sap.cloud:neo-javaee7-wp-api to 1.24.13 (also in archetype scp-neo-javaee7).
• Improve logging in archetypes:
  • Use logback as logger at runtime in the Cloud Foundry archetypes.
  • Emit logs in JSON format on Cloud Foundry for use in Kibana when using scp-cf-spring archetype, while keeping human-readable logs in local deployment.
  • Use slf4j-simple for unit and integration tests in all archetypes. You can now easily set the log level of all classes in tests with -Dsurefire.logLevel=<level>.
• Clean up Maven dependencies and scopes in all archetypes.

Fixed Issues

• Fix an issue with commit and rollback handling in RfcQuery.

Version 2.0.0

May 23, 2018 - Maven Central - Release blog

New Functionality

• This version updates the OData virtual data model to the newest release 1805 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Java VDM: Introduce withHttpHeader method to all fluent helpers. This adds the String-typed key and value pairs to the HTTP headers of all underlying OData requests.

Improvements

• Java VDM: Propagate locale and SAP client from the ErpConfigContext into the HTTP headers of all OData requests. To pass in different values than the default, create an ErpConfigContext object with the desired locale and/or SAP client and call the execute() method of the fluent helper with the ErpConfigContext object as a parameter.
• Java VDM: Add a resetChangedFields() method to all VDM entities to reset the currently tracked changed fields for update requests.
• Improve structure and reliability of Cloud Platform abstraction code in relation to accessing tenants, users, as well as secret and key stores.
• Introduce USE_MOCKED_TENANT and USE_MOCKED_USER environment variables for fine-granular control over mocking at runtime.
  • When these environment variables are set to true, the application will use a mocked tenant ("") and/or mocked user ("") instead of an actual tenant or user, respectively.
  • This should not be used in production, but only for testing purposes. As a consequence, security errors are logged when you use these environment variables.
  • The behavior is similar to the ALLOW_MOCKED_AUTH_HEADER environment variable on Cloud Foundry, but in contrast to that variable works on both Neo and Cloud Foundry and takes precedence over an actual tenant and user.
• MockUtil now uses the AuditLog, CloudPlatform, GenericDestination/Destination/RfcDestination, Tenant, User, and SecretStore type of the respective Cloud platform for mocking based on the chosen dependency of Cloud Foundry or Neo.
• Add methods to MockUtil to allow mocking of GenericDestinations.
• Java VDM generator: Add converter logic with ODataField annotations to externalize the expected OData types.
• Java VDM generator: Add method isKeyField() to entity property models supplied to annotation strategy.
• Manage the version of the OData v4 provisioning libraries of the SAP Cloud Platform SDK for service development in the BOM of the SAP S/4HANA Cloud SDK (currently version 1.17.0). This allows to quickly use the corresponding libraries with a consistent version by adding com.sap.cloud.servicesdk.prov:odatav4 to the dependencies of a project.
• Improve Javadoc documentation and exception messages in various places.
• Use a ServiceLoader instead of a bootstrap listener to make it easier to use Hystrix during app startup.
• SerializedQuery now not only supports POST, but also additional HTTP methods defined by RequestMethod.

Fixed Issues

• Fix incorrect HTTPS on-premise port translation when converting to HTTP (required by SAP Cloud Connector). Previously, for on-premise destinations, if the URI used HTTPS while omitting the port, the URI was translated to HTTP without considering the implicit port 443 that was specified by the destination using HTTPS. Now, if no port is specified, port 443 is kept when translating to HTTP.
• Java VDM generator: Fix a bug with unicode dashes in EDM names that are used to create the service class and package names.
• Fix java.lang.IllegalArgumentException: Not supported: http://javax.xml.XMLConstants/property/accessExternalDTD issue in SoapRemoteFunctionQuerySerializer on Java EE 7.
• Fix issue where asserting the existence of runtime dependencies in various facades within tests would not be triggered, leading to less comprehensible ClassNotFoundExceptions instead of the message provided by the respective assertRuntimeDependenciesExist() method.

Version 1.11.1

May 10, 2018 - Maven Central - Release blog

New Functionality

• Update requests with the VDM for OData services send only updated fields of an entity as opposed to sending the entire entity. You can manually include further fields by supplying their representation to the includingFields method of the fluent helper.
• Java VDM generator: Add an option to only generate the POJO classes representing OData entities, and skip generation of service classes and fluent helpers (command line option --generate-pojo-only, Maven plugin configuration pojosOnly).
• Java VDM generator: Allow to customize the annotations generated for POJO classes and their fields by supplying a custom AnnotationStrategy.
  • Expose the DefaultAnnotationStrategy as basis (super class) for custom annotation strategies.
  • The custom annotation strategy needs to be on the classpath when calling the generator. The corresponding command line option is --annotation-strategy-class <fully-qualified-class-name>, the Maven plugin configuration property annotationStrategy.

Improvements

• Java VDM generator: Improve the handling of names from OData metadata when mapping entities and properties to Java:
  • Handle name conflicts with Java identifiers by appending an underscore followed by an integer counter to the identifier. This applies to names of entity classes, complex types, member variables within entity & complex type classes, methods for navigation properties, and methods & parameters of function imports.
  • Remove characters from OData property and entity names and labels that are invalid in Java syntax.
  • Add the original name of entities and properties as specified in the OData entity metadata to the Javadoc documentation of the generated classes.
• Java VDM generator: Also look for the metadata document of OData services in files ending with .xml files (in addition to .edmx).
• Improve the naming of VDM entity classes for the BusinessEventQueue service.

Fixed Issues

• Fix an issue where sorting with the VDM for OData services would not work correctly.

Version 1.10.0

April 12, 2018 - Maven Central - Release blog

New Functionality

• Release of the Virtual Data Model (VDM) generator for OData services. The VDM generator introduced in version 1.9.4 is no longer considered experimental and is ready for productive use with the following additional features and improvements:
  • Make the Swagger JSON file that describes an OData service in more detail optional. Only the metadata document (EDMX file) of a service is required.
  • Use by default the label from the OData metadata (sap:label attribute) to derive the VDM name of entities and their properties. You can use the old strategy to use the name instead with the corresponding command line interface (CLI) option --use-odata-names or the Maven plugin parameter nameSource set to NAME.
  • Allow supplying a custom NamingStrategy to define the mapping of metadata names and labels to Java identifiers. Supply the fully qualified name of your class implementing this interface via the parameter --name-strategy-class (CLI) / namingStrategy (Maven plugin).
  • Rename Maven goal to generate to allow calling the Maven plugin (when configured) via mvn odata-generator:generate
  • Fix the issue that the defaultBasePath parameter was mandatory for the Maven plugin.
• When updating remote entities with the OData VDM, send an HTTP PATCH request and only send fields of the entity with non-null values.
• Support optimistic concurrency control for update requests using the OData VDM by transparently retrieving the ETag version identifier during read-by-key requests and supplying it as If-Match header during update requests.
  • Allow forced overwrites by ignoring the version identifier.
  • Allow reading and setting the ETag version identifier manually on all entities.

Improvements

• Introduce an AuthTokenAcccessor to transparently access the current authorization token on SAP Cloud Platform Cloud Foundry.
• Reduce log levels of RequestContextListeners to debug instead of warn to avoid unnecessary warnings in situations where this behavior is expected.
• Use more appropriate exceptions such as DestinationPathsNotMergeableException in UriPathMerger.

Fixed Issues

• Fix an issue where destinations on SAP Cloud Platform Cloud Foundry were not retrieved correctly in a multi-tenant setup.
• Fix an issue with reading destinations from non-container-managed threads on SAP Cloud Platform Cloud Foundry when using the Spring Security configuration approach.
• Fix incorrect scope of javax.inject module from compile to provided in odata-api and bapi-api modules.
• Fix a logging issue with JmxMonitor that occurred when deploying more than one application to the same container.

Version 1.9.4

March 29, 2018 - Maven Central - Release blog

New Functionality

• Support for OAuth2 SAML bearer flow with destination service of SAP Cloud Platform Cloud Foundry environment.
• Generate Java virtual data model for custom OData services with the preview release of the the VDM generator for OData services.
  • Command line interface of generator available as module com.sap.cloud.s4hana.datamodel:odata-generator-cli as a fat jar that can be called via java -jar odata-generator-cli-1.9.4.jar.
  • Maven plugin available as module com.sap.cloud.s4hana.datamodel:odata-generator-maven-plugin, bound to the generate-sources phase.
  • Calling the generator from any Java program is supported via the DataModelGenerator builder class.

Improvements

• Update all archetypes with latest version of the Continuous Delivery toolkit (cx-server).
  • Introduce support for backup and restore operations in cx-server script.
  • Introduce a local download cache for Maven and npm dependencies.

Fixed Issues

• Fix issue where a DestinationAccessException occurred on SAP Cloud Platform Cloud Foundry when a subaccount had an on-premise destination configured and the application was not bound to a connectivity service instance, even if this destination was never used.
  • To circumvent this, on-premise proxy configuration (related to Cloud Connector) is now resolved lazily before sending a request instead of being resolved when parsing destinations.
  • Accordingly, the method Destination#getProxyConfiguration may now throw a DestinationAccessException to indicate an issue while accessing the destination.
• Preconfigure the Docker image for Neo deployments used by the Continuous Delivery toolkit in the scp-neo-javaee7 archetype.

Version 1.9.3

March 15, 2018 - Maven Central - Release blog

New Functionality

• Introduce logical operators to the fluent API of the VDM for or and not to support complex filter expressions (together with the already previously existing and operator).

Improvements

• Update to version 1.13.1 of SAP Cloud Platform SDK for service development.
• Improve error messages when looking up destinations fails on SAP Cloud Platform Cloud Foundry.

Fixed Issues

• Properly escape HTML in Javadoc of the VDM.
• Fix issue where options for Catalina were not correctly set depending on the operating system during local deployment with the scp-neo-maven-plugin.

Version 1.9.2

February 15, 2018 - Maven Central - Release blog

New Functionality

• This version updates the OData virtual data model to the newest release 1802 of SAP S/4HANA Cloud. This includes completely new services (available as usual from package com.sap.cloud.sdk.s4hana.datamodel.odata.services), new operations in previously existing services, and new entity types. The SDK supports all OData services listed in the SAP API Business Hub for SAP S/4HANA Cloud.
• Support for AppToAppSSO authentication in destination service on SAP Cloud Platform Cloud Foundry.
• Support SAP Cloud Connector location ID on SAP Cloud Platform Neo.
• Introduce a new module com.sap.cloud.s4hana.frameworks:spring-web that provides a ready-to-use exception mapper for Spring applications. The exception mapper logs all unhandled exceptions with a reference ID and fills the response with the error description, without the stacktrace.

Improvements

• The environment variable destinations so far available for Cloud Foundry-based applications can now be used independent of the underlying Cloud platform environment, enabling consistent local testing of connectivity across environments.
• Set the random-route property by default in manifest.yml by default as part of all Cloud Foundry archetypes, so that the question for a unique hostname is not needed anymore.
• Improve Javadoc in frameworks.* packages.
• Update several dependencies:
  • Update Lombok to 1.16.20.
  • Update Gson to 2.8.2.
  • Update commons-lang3 to 3.7.
  • Update commons-text to 1.2.
  • Update wiremock to 2.14.0.
  • Remove dependencies to commons-io and commons-collections4 by relying on Guava.
  • Reduce dependencies to commons-lang3 and commons-codec of certain modules by relying on Guava.
• Move GsonMessageBodyProvider to a separate com.sap.cloud.s4hana.frameworks:jaxrs-gson module to avoid conflicts with other providers like Jackson.

Fixed Issues

• Fix bug appearing on SAP Cloud Platform Neo, where running in non-container managed threads would always use the tenant context of the provider, not the consumer account. Upgrading to this version from the previous version is highly recommended when using the SDK in a multi-tenant application in the Neo environment.
• Fix deserialization of complex type properties in OData VDM entities.
• Fix deserialization of OData VDM entities that contain properties of type Edm.Binary.
• Use the fully qualified name of the service implemention class as value of the @Named annotation to avoid conflicts between service classes using the same names in the VDM for OData and BAPI.
• Fix dependency injection not working in scp-cf-spring archetype due to missing @ComponentScan annotation.

Version 1.8.0

February 1, 2018 - Maven Central - Release blog

Improvements

• Introduce TenantAccessException and UserAccessException for a cleaner contract on the tenant and user accessors and facades; rename TenantNotFoundException to TenantNotAvailableException.
• Introduce KeyStoreAccessException and SecretStoreAccessException for a cleaner contract on the secret store accessor and facade; rename KeyStoreException to KeyStoreNotFoundException and SecretStoreException to SecretStoreNotFoundException.
• Improve Javadoc in cloudplatform.* packages.

Fixed Issues

• Remove tomcat-catalina lib from TomEE Maven plugin configuration in application/pom.xml generated by scp-cf-tomee archetype in order to fix local deployment issues (e.g., java.lang.NoSuchMethodError: org.apache.tomcat.util.ExceptionUtils.preload()V) on some developer machines.
• Introduce additional RequestContextListeners for SAP Cloud Platform, Neo to avoid failing JNDI lookups in non-container managed threads.
• Fix issue in HystrixUtil.getUserIsolatedKey not considering tenant context (this may have caused circuit breakers to trigger for users with the same name across different tenants).
• Fix issue with multiple class loaders in FacadeLocator.

Version 1.7.1

January 18, 2018 - Maven Central - Release blog

New Functionality

• Add new archetype com.sap.cloud.s4hana.archetypes:scp-neo-javaee7 for Java EE 7 on SAP Cloud Platform Neo.
• Support for on-premise connectivity via SAP Cloud Connector on SAP Cloud Platform Cloud Foundry.
• Provide API about the state of feature toggles via FeatureToggleServlet.
• Onboard and offboard tenants for schema-based multi-tenancy with SchemaPerTenantProvisioner for liquibase.
• Add a new class LogInputSanitizer that can be used to prevent log forging.
  • The LogInputSanitizer comes with an END_OF_LOG token (by default: (END OF LOG ENTRY)) that will be appended to the end of each log entry.
  • If an attacker tries to inject log entries using this token, the sanitizer will catch it and replace the forged token by a warning token.

Improvements

• The destination cache on SAP Cloud Platform Cloud Foundry is now only invalidated if destinations were retrieved successfully. Otherwise, the cache remains valid.
• DestinationType, AuthenticationType, and ProxyType now provide methods for handling conversion from and to String identifiers.
• Add additional AuthenticationType enum values which are available on SAP Cloud Platform Neo and/or Cloud Foundry.
• Refine Destination interface: improve contract on some methods that may throw a DestinationAccessException and add method getDescription().
• Add newTenantIsolatedOrGlobalKey to CacheKey.
• Add getTenantIsolatedOrGlobalKey to HystrixUtil.
• Move helper classes for managing concurrency on SAP Cloud Platform Neo to module com.sap.cloud.s4hana.cloudplatform:concurrency-scp-neo.
• Replace MockServer with WireMock for MockUtil.mockErpServer and MockUtil.mockServer.
  • Instead of returning a ClientAndServer object, the affected MockUtil methods now return a WireMockRule.
  • This allows you to use the JUnit rule annotation for easier setup & teardown of the mock server.
• Update version of TomEE adapters for Arquillian to 1.7.5 (from 1.7.4).
• Update Jackson to version 2.9.3 (from 2.8.7).

Fixed Issues

• OData virtual data model (VDM) for S/4HANA: When using function imports, the VDM now correctly retrieves a CSRF token before executing the request.
• The toString method of destinations now replaces sensitive information such as passwords with the String (hidden).

Version 1.6.0

December 21, 2017 - Maven Central - Release blog

New Functionality

• Support type-safe expand for OData queries with the S/4HANA Virtual Data Model (VDM).
  • The expand functionality is integrated into the select method of fluent helpers. Please note that there is no separate expand method.
  • The fields to select from the expanded entities can be specified in the same manner.
  • Example with the business partner service: use

    getAllBusinessPartner().select(
      BusinessPartner.TO_BUSINESS_PARTNER_ROLE,
      BusinessPartner.TO_BUSINESS_PARTNER_ADDRESS.select(BusinessPartnerAddress.COUNTRY)
    )

    to retrieve all business partners with their roles (all fields of role) and the country field of their addresses.
• SAP Cloud Platform Cloud Foundry: Retrieve destinations including credentials from destination service and support basic authentication flows via the Cloud Platform abstractions that were already available on SAP Cloud Platform Neo.

Improvements

• Improve usability of builder methods for navigation properties of VDM entities. Use, for example, BusinessPartner.builder().businessPartnerAddress(...) to add addresses while constructing an entity.
• The methods for modifying navigation properties, set[NavigationProperty] and add[NavigationProperty], no longer attempt to fetch the associated entities first.
• Add method to VDM objects to set a custom field using an EntityField object and a type-safe value.
• Improve Javadoc for classes dealing with BAPI and RFC queries (see packages com.sap.cloud.sdk.s4hana.connectivity.rfc and com.sap.cloud.sdk.result).
• Rename method doCommit in BapiQuery and RfcQuery to isPerformingTransactionalCommit. doCommit is now deprecated.
• Retrieve generic destinations (in addition to RFC and HTTP) from the Destination Facade on both Neo and Cloud Foundry, introduce MAIL and LDAP as additional destination types.
• Add best effort isolated cache key to CacheKey and a method newEquallyIsolatedKey to retrieve a cache key with same level of isolation as a given cache key.
• Add best effort isolated command key to HystrixUtil, used as default by CachingCommand.

Fixed Issues

• Fix compiler warning about unsafe varargs for select methods in the VDM.
• Fix malformed acronym names for fields in the VDM.
• Fix bug with transaction handling for BAPI queries to SAP S/4HANA on premise.
• Fix failing deserialization of date and time fields into LocalDate and LocalTime when accessing BAPI and RFM results.
• Fix issues with audit logging in AuditLoggingStateRepository (Togglz integration).
• Fix some issues where input streams were not closed properly before.
• Rename AutorizationApiDestination to AuthorizationApiDestination.

Version 1.5.0

December 7, 2017 - Maven Central - Release blog

New Functionality

• Provide navigation properties as part of OData virtual data model (VDM) for S/4HANA.
  • Retrieve values of navigation properties of an entity via get[NavigationProperty]OrNull and get[NavigationProperty]OrFetch (examples: BusinessPartner.getBusinessPartnerAddressOrFetch and BusinessPartner.getBusinessPartnerAddressOrNull).
  • Modify navigation property values via set[NavigationProperty] (to overwrite) and, in case of 1:n associations, add[NavigationProperty] (examples: BusinessPartner.setBusinessPartnerAddress and BusinessPartner.addBusinessPartnerAddress).
• Support deep insert via VDM by leveraging navigation properties.
• Allow to modify values of custom fields.
  • Set the value of a custom field of an entity using setCustomField.
  • Custom fields of entities thus modified are sent to S/4HANA as part of create or update operations and persisted (if the custom field exists in the S/4HANA Cloud system).

Improvements

• The ODataVdmErrorResultHandler used by default in all VDM operations exposes more information about exceptions that occur during calls of the VDM.
• Method getCustomFields returns a map of all custom fields of an entity and their values.

• Adjust default memory provisioned for applications generated by scp-cf-tomee, scp-cf-tomcat, or scp-cf-spring archetypes to ensure sufficient memory and metaspace.