https://github.com/hivemq/hivemq-kafka-extension-customization-sdk

Open source Customization SDK for the HiveMQ Enterprise Extension for Kafka that you can use to customize the extension and enrich your data transfer between MQTT and Kafka.
https://github.com/hivemq/hivemq-kafka-extension-customization-sdk

customization hivemq kafka kafka-extension mqtt sdk

Last synced: about 2 hours ago
JSON representation

Open source Customization SDK for the HiveMQ Enterprise Extension for Kafka that you can use to customize the extension and enrich your data transfer between MQTT and Kafka.

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-kafka-extension-customization-sdk
• Owner: hivemq
• License: apache-2.0
• Created: 2020-07-06T12:11:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T19:01:49.000Z (22 days ago)
• Last Synced: 2024-10-19T00:13:10.099Z (21 days ago)
• Topics: customization, hivemq, kafka, kafka-extension, mqtt, sdk
• Language: Java
• Homepage: https://www.hivemq.com
• Size: 475 KB
• Stars: 7
• Watchers: 17
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= HiveMQ Kafka Extension Customization SDK

image:https://maven-badges.herokuapp.com/maven-central/com.hivemq/hivemq-kafka-extension-customization-sdk/badge.svg?style=for-the-badge["Maven Central",link="https://maven-badges.herokuapp.com/maven-central/com.hivemq/hivemq-kafka-extension-customization-sdk"]

image:https://javadoc.io/badge2/com.hivemq/hivemq-kafka-extension-customization-sdk/javadoc.svg?style=for-the-badge["javadoc",link=https://javadoc.io/doc/com.hivemq/hivemq-kafka-extension-customization-sdk]

== Features

The HiveMQ Kafka Extension Customization SDK allows the programmatic interaction with the https://www.hivemq.com/extension/hivemq-kafka-extension/[HiveMQ Enterprise Extension for Kafka].

By implementing a customization for the HiveMQ Enterprise Extension for Kafka it is possible to:

* Transform an MQTT PUBLISH into one or multiple Kafka records

* Query the existence of specific Kafka topics

* Create new Kafka topics

== Using the SDK

The HiveMQ Kafka Extension Customization SDK is available in Maven central, so no special configuration is needed.

To use the SDK, add the following dependency to your Maven project:

[source,xml]

----

    com.hivemq

    hivemq-kafka-extension-customization-sdk

    4.33.0

----

== License

The HiveMQ Kafka Extension SDK is licensed under the `APACHE LICENSE, VERSION 2.0`.

A copy of the license can be found link:LICENSE[here].

== Setup

To be able to use the latest changes of the `hivemq-extension-sdk` please check out the https://github.com/hivemq/hivemq-extension-sdk repository in the same folder as the current project.

(See line `includeBuild("../hivemq-extension-sdk")` in `settings.gradle.kts`).

NOTE: You can also change the path in the `settings.gradle.kts` to the path of your `hivemq-extension-sdk`.

Otherwise, it will not be possible to publish develop snapshots to your local repository.