Connect SingleStore to IBM WebSphere Using the CData JDBC Driver
IBM WebSphere is a powerful application server that runs many enterprise level Java applications and services. When paired with the CData JDBC Driver for SingleStore, IBM WebSphere applications can connect to SingleStore and work with data using standard SQL queries instead of complex APIs. This simplifies integration, reduces development effort, and provides secure, real-time access to critical business data.
Prerequisites
- Access to a SingleStore account (with API permissions)
- IBM WebSphere Application Server (configured and running)
- CData JDBC Driver for SingleStore
- Java Servlet WAR application ready for deployment
Note: This article uses Salesforce as a demonstration data source, but the same steps can be followed to connect to any of the 250+ JDBC Drivers available in our portfolio.
Getting Started
Step 1: Download and install the CData JDBC Driver for SingleStore
Download and install the CData JDBC Driver for SingleStore, which provides a .jar file: cdata.jdbc.singlestore.jar
Step 2: Install and configure IBM Websphere
- Create an account in IBM WebSphere using the official IBM site.
- Install and configure the IBM Websphere Application server in the local system using the documentation: IBM Websphere Application Server
- Once the application server is installed, start the WebSphere Server using the Admin Console in your browser: https://your-server:9043/ibm/console
Step 3: Set up the JDBC provider and data source for SingleStore
- Go to Resources, expand the JDBC section, and then select JDBC providers to create a new provider
- Select the appropriate scope from the drop down menu
- Click New to add a JDBC provider
- Choose User defined as the database type
- Enter cdata.jdbc.singlestore.SingleStoreConnectionPoolDataSource as the implementation class name
- Type a name for the provider, for example User defined JDBC Provider
- Enter the full path of the JDBC driver JAR file in the classpath field
- Click Next, then Finish, and save the changes to the master configuration.
- Once the JDBC provider is created, add a JDBC data source.
- Enter the basic details such as Data Source Name and JNDI name
- Select the existing JDBC provider created earlier (e.g., CData SingleStore Provider)
- Provide the Implementation class name: cdata.jdbc.singlestore.SingleStoreConnectionPoolDataSource
- Add the Data Store Helper Class Name: com.ibm.websphere.rsadapter.GenericDataStoreHelper
- Configure security by setting authentication aliases if required
- Review the Summary page to verify all details and click Finish to complete the data source creation
- Select the newly created data source from the list and open Custom properties
-
Add the JDBC connection string under the URL property and press OK. For example:
jdbc:singlestore:RTK=5246...;User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
The following connection properties are required in order to connect to data.
- Server: The host name or IP of the server hosting the SingleStore database.
- Port: The port of the server hosting the SingleStore database.
- Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.
Connect Using Standard Authentication
To authenticate using standard authentication, set the following:
- User: The user which will be used to authenticate with the SingleStore server.
- Password: The password which will be used to authenticate with the SingleStore server.
Connect Using Integrated Security
As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.
Connect Using SSL Authentication
You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:
- SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
- SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
- SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
- SSLClientCertType: The certificate type of the client store.
- SSLServerCert: The certificate to be accepted from the server.
Connect Using SSH Authentication
Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:
- SSHClientCert: Set this to the name of the certificate store for the client certificate.
- SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
- SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
- SSHClientCertType: The certificate type of the client store.
- SSHPassword: The password that you use to authenticate with the SSH server.
- SSHPort: The port used for SSH operations.
- SSHServer: The SSH authentication server you are trying to authenticate against.
- SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
- SSHUser: Set this to the username that you use to authenticate with the SSH server.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the SingleStore JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.singlestore.jarFill in the connection properties and copy the connection string to the clipboard.
Note: If the URL property is not available, create it and then add the JDBC connection string.
Tip: Always test the connection string with the driver before entering it in the URL property.
- Now open the data source and choose Test Connection
Step 4: Build the web application
- Build the web application using preferred Java framework (Servlet, JSP, or Spring). The resulting .war file will typically follow a structure like this:
- Define the data access logic using JDBC or JPA, referencing the data source through a JNDI name
- This article walks through JDBC connection setup and deploying a Java Servlet application
- Package the project as a WAR (Web Application Archive) or EAR (Enterprise Archive) file for deployment
- In a terminal compile the java file using the command:
cd webcontent jar cvf ..\SingleStoreServletApp.war *
SingleStoreServletApp.war |--webcontent | |--index.jsp -- JSP page (entry point) | | | |--WEB-INF/ --Hidden from direct browser access | |--web.xml -- Deployment descriptor | | | |--classes/ --Compiled .class files | |--com/example/SingleStore/ | |--SingleStoreServlet.class | |--lib/ --Dependency JARs |--cdata.jdbc.singlestore.jar
Step 5: Deploy the SingleStore application in WebSphere
- In the WebSphere admin console, go to Applications and select Install New Application
- Browse and upload the WAR file, then continue with the installation wizard.
Step 6: Retrieve SingleStore data through WebSphere
- Access the application using its context root: http://hostname:port/context-root/page
Note: Ensure the deployed application is started before opening it in the browser.
We can now view the retrieved data from the source. The data is accessible directly through IBM WebSphere. This setup demonstrates how a servlet can be deployed in WebSphere to retrieve SingleStore data using the JDBC driver, creating a strong foundation for building advanced SingleStore powered enterprise applications.
Get Started with Connecting SingleStore to IBM WebSphere
Start connecting SingleStore to IBM WebSphere with the CData JDBC Connector today. Download the free 30-day trial and explore how easy it is to enable secure, real-time data access for your applications. As always, our world-class Support Team is available to help with any questions you may have.