VOOZH about

URL: https://www.cdata.com/kb/tech/odata-jdbc-jboss.rst

⇱ Connect to OData Services from a Connection Pool in JBoss

Connect to OData Services from a Connection Pool in JBoss

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Integrate OData services into Java servlets: Use the Management Console in JBoss to install the OData JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access OData services from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for OData. You will then access OData services from a connection pool.

About OData Data Integration

CData simplifies access and integration of live OData services data. Our customers leverage CData connectivity to:

  • Access OData versions 2.0, 3.0, and 4.0, working with legacy services and the latest features and capabilities.
  • Leverage advanced query options, including $filter, $select, and $expand, enhancing data retrieval from 3rd party tools.
  • Use Server-side execution of aggregation and grouping to minimize data transfer and boost performance.
  • Authenticate securely using a variety of schemes, including Azure AD, digest, negotiate, NTLM, OAuth, and more means secure authentication with every connection.
  • Use SQL stored procedures to manage OData service entities - listing, creating, and removing associations between entities.

Customers use CData's solutions to regularly integrate their OData services with preferred tools, such as Power BI, MicroStrategy, or Tableau, and to replicate data from OData services to their databases or data warehouses.


Getting Started


Create a JDBC Data Source for OData from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable. 👁 The deployed JAR. (Salesforce is shown.)
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: 
    java:jboss/root/jdbc/OData
  5. Select the driver that you added above.

  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:odata: followed by a semicolon-separated list of connection properties.

    The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, specify a URL to a valid OData server organization root or OData services file.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.odata.jar

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

    👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical connection string is below:

    jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;
  7. Test the connection and finish the wizard. Select the OData data source and click Enable.
👁 The enabled data source. (Salesforce is shown.)

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.