Chapter 3. Adding client dependencies to your Maven project


If you are developing Java-based Kafka clients, you can add the Red Hat dependencies for Kafka clients, including Kafka Streams, to the pom.xml file of your Maven project. Only client libraries built by Red Hat are supported for AMQ Streams.

You can add the following artifacts as dependencies:

kafka-clients

Contains the Kafka Producer, Consumer, and AdminClient APIs.

  • The Producer API enables applications to send data to a Kafka broker.
  • The Consumer API enables applications to consume data from a Kafka broker.
  • The AdminClient API provides functionality for managing Kafka clusters, including topics, brokers, and other components.
kafka-streams

Contains the KafkaStreams API.

Kafka Streams enables applications to receive data from one or more input streams. You can use this API to run a sequence of real-time operations on streams of data, like mapping, filtering, and joining. You can use Kafka Streams to write results into one or more output streams. It is part of the kafka-streams JAR package that is available in the Red Hat Maven repository.

3.1. Adding a Kafka clients dependency to your Maven project

Add a Red Hat dependency for Kafka clients to your Maven project.

Prerequisites

  • A Maven project with an existing pom.xml.

Procedure

  1. Add the Red Hat Maven repository to the <repositories> section of the pom.xml file of your Maven project.

    <repositories>
        <repository>
            <id>redhat-maven</id>
            <url>https://maven.repository.redhat.com/ga/</url>
        </repository>
    </repositories>
  2. Add kafka-clients as a <dependency> to the pom.xml file of your Maven project.

    <dependencies>
        <dependency>
            <groupId>org.apache.kafka</groupId>
            <artifactId>kafka-clients</artifactId>
            <version>3.4.0.redhat-00004</version>
        </dependency>
    </dependencies>
  3. Build the Maven project to add the Kafka client dependency to the project.

3.2. Adding a Kafka Streams dependency to your Maven project

Add a Red Hat dependency for Kafka Streams to your Maven project.

Prerequisites

  • A Maven project with an existing pom.xml.

Procedure

  1. Add the Red Hat Maven repository to the <repositories> section of the pom.xml file of your Maven project.

    <repositories>
        <repository>
            <id>redhat-maven</id>
            <url>https://maven.repository.redhat.com/ga/</url>
        </repository>
    </repositories>
  2. Add kafka-streams as a <dependency> to the pom.xml file of your Maven project.

    <dependencies>
        <dependency>
            <groupId>org.apache.kafka</groupId>
            <artifactId>kafka-streams</artifactId>
            <version>3.4.0.redhat-00004</version>
        </dependency>
    </dependencies>
  3. Build the Maven project to add the Kafka Streams dependency to the project.

3.3. Adding an OAuth 2.0 dependency to your Maven project

Add a Red Hat dependency for OAuth 2.0 to your Maven project.

Prerequisites

  • A Maven project with an existing pom.xml.

Procedure

  1. Add the Red Hat Maven repository to the <repositories> section of the pom.xml file of your Maven project.

    <repositories>
        <repository>
            <id>redhat-maven</id>
            <url>https://maven.repository.redhat.com/ga/</url>
        </repository>
    </repositories>
  2. Add kafka-oauth-client as a <dependency> to the pom.xml file of your Maven project.

    <dependency>
     <groupId>io.strimzi</groupId>
     <artifactId>kafka-oauth-client</artifactId>
     <version>0.12.0.redhat-00006</version>
    </dependency>
  3. Build the Maven project to add the OAuth 2.0 dependency to the project.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.