adoption of Cloud SDK 5 in CAP Java (#627)

* fix links * adoption steps for cloud sdk 5 * revert table format * Update migration.md * minor corrections * Update migration.md * Update java/development/index.md Co-authored-by: BraunMatthias <[email protected]> * Update migration.md * Update index.md * Update java/migration.md Co-authored-by: René Jeglinsky <[email protected]> * Update java/migration.md Co-authored-by: René Jeglinsky <[email protected]> * Update java/migration.md Co-authored-by: René Jeglinsky <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Rene Jeglinsky <[email protected]> Co-authored-by: BraunMatthias <[email protected]>
cap-js · Jan 24, 2024 · 82886f2 · 82886f2
1 parent fde5607
commit 82886f2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/java/development/index.md b/java/development/index.md
@@ -254,11 +254,13 @@ The CAP Java SDK uses various dependencies that are also used by the application
 | @sap/cds-compiler | 3 | latest |
 | Spring Boot | 3.0 | latest |
 | XSUAA | 3.0 | latest |
-| SAP Cloud SDK | 4.24 | latest |
+| SAP Cloud SDK | 4.24 | latest<sup>2</sup> |
 | Java Logging | 3.7 | latest |
 
 <sup>1</sup> When using the SAP Business Application Studio JDK 17 is recommended.
 
+<sup>2</sup> Cloud SDK 5 is recommended. Refer to necessary steps for [adoption of Cloud SDK 5](../migration.md#cloudsdk5)  
+
 ::: warning
 The Cloud SDK BOM `sdk-bom` manages XSUAA until version 2.x, which isn't compatible with CAP Java 2.x.
 You have two options:

diff --git a/java/migration.md b/java/migration.md
@@ -1043,3 +1043,16 @@ After rebuilding and restarting your application, your Application Services are
 <!-- TODO: Move this to "Development" section -->
 
 <span id="afterenablingodata" />
+
+## Cloud SDK 4 to 5 { #cloudsdk5 }
+
+CAP Java `2.6.0` and higher is compatible with Cloud SDK in version 4 and 5. For reasons of backward compatibility, CAP Java assumes Cloud SDK 4 as the default. However, we highly recommend to use at least version `5.2.0` of Cloud SDK. To upgrade your CAP Java application to Cloud SDK 5, in most cases, you  don't need to adapt any code if you rely on the Cloud SDK integration package (`cds-integration-cloud-sdk`). In these cases, it's sufficient to add the following maven dependency to your CAP Java application:
+
+```xml
+<dependency>
+	<groupId>com.sap.cloud.sdk.cloudplatform</groupId>
+	<artifactId>connectivity-apache-httpclient4</artifactId>
+</dependency>
+```
+
+