Connect to Kafka Data from a Connection Pool in JBoss

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Apache Kafka JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Apache Kafka.



Integrate Kafka data into Java servlets: Use the Management Console in JBoss to install the Kafka JDBC Driver.

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

Create a JDBC Data Source for Kafka 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.
  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/ApacheKafka
  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:apachekafka: followed by a semicolon-separated list of connection properties.

    Set BootstrapServers and the Topic properties to specify the address of your Apache Kafka server, as well as the topic you would like to interact with.

    Authorization Mechanisms

    • SASL Plain: The User and Password properties should be specified. AuthScheme should be set to 'Plain'.
    • SASL SSL: The User and Password properties should be specified. AuthScheme should be set to 'Scram'. UseSSL should be set to true.
    • SSL: The SSLCert and SSLCertPassword properties should be specified. UseSSL should be set to true.
    • Kerberos: The User and Password properties should be specified. AuthScheme should be set to 'Kerberos'.

    You may be required to trust the server certificate. In such cases, specify the TrustStorePath and the TrustStorePassword if necessary.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.apachekafka.jar

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

    A typical connection string is below:

    jdbc:apachekafka:User=admin;Password=pass;BootStrapServers=https://localhost:9091;Topic=MyTopic;
  7. Test the connection and finish the wizard. Select the Kafka data source and click Enable.

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.