Configure the CData JDBC Driver for SAP HANA XS Advanced in a Connection Pool in Tomcat

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP HANA XS Advanced JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP HANA XS Advanced.



Connect to SAP HANA XS Advanced data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to SAP HANA XS Advanced data from a connection pool in Tomcat.

Connect to SAP HANA XS Advanced Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    SAP HANA XSA uses the OAuth authentication standard. Before connecting, it is necessary to establish an SAP HANA XSA OData Service. See the OAuth section in the Help documentation for a guide.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the SAP HANA XS Advanced JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.saphanaxsa.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/saphanaxsa" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.saphanaxsa.SAPHanaXSADriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:saphanaxsa:OAuthClientID=my-ouath-client-id;OAuthClientSecret=my-oauth-client-secret;URL=https://hxehost:51027/euro.xsodata;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access SAP HANA XS Advanced data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to SAP HANA XS Advanced for all applications.

  3. Add a reference to the resource to the web.xml for the application. SAP HANA XS Advanced data JSP jdbc/SAPHanaXSA javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/SAPHanaXSA"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to SAP HANA XS Advanced data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.