To get started with the SAP Cloud SDK for Java you can either create a new project or integrate the SDK into your existing one. You will need an installation of Java and Maven.
Java version compatibility
The SDK itself is compatible with Java 8 and 11. Other Java versions may work as well depending on your setup but are not yet tested by us. Note that SAP Cloud Platform Cloud Foundry environment only supports Java 8 out of the box but can be configured to also run with Java 11. SAP Cloud Plattform Neo only supports Java 8.
Maven will ask you to provide the following:
groupId- usually serves as your organization identifier, i.e.
artifactId- it's your application's name, i.e.
version- we recommend keeping
1.0-SNAPSHOTif you're just starting
package- by default this equals to
groupId. Change it only if you know what you're doing
After providing all the interactive values to the CLI it will generate your first Cloud SDK based application:
Congratulations! You've just setup a brand new application with the SAP Cloud SDK for Java.
To change the Java version modify the
<java.version> property in the root
To get started with an existing project include the SDK BOM in the dependency management section of your project:
If your application is running on SAP Cloud Platform please add the appropriate dependency:
- Cloud Foundry
If you want to connect to an S/4HANA system via the OData protocol you should also add a dependency to the client libraries of the SDK:
In case you have a CAP application which uses multitenancy features and/or a protected backend your service will need the following dependency:
Last but not least we recommend that you include the following plugin:
It sends anonymized usage data such as the SDK version used and helps us with improving the SDK.
Furthermore the plugin is capable of generating a report with useful information about the project setup.
diagnosis-report will print out the SDK modules used and their version but also other information like the Java and Maven version.
This is helpful when you are facing an issue and are reaching out to us for help.
In particular the SDK provides listeners that can extract tenant and principal information from an incoming request. To ensure these listeners are present please configure your project accordingly.
For a Spring based project please ensure that the application is annotated to scan for components of the SDK:
Check the logs on application startup to ensure the listeners got registered. Also please check the Spring version declared in the SDK BOM doesn't clash with your version of Spring.
For a TomEE based project the filters should be registered automatically. They are part of the
servlet module which comes into the dependency tree through
scp-neo automatically. Check the logs on application startup to ensure the listeners are being registered.