https://github.com/hivemq/hivemq-amazon-kinesis-extension-customization-sdk

https://github.com/hivemq/hivemq-amazon-kinesis-extension-customization-sdk

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-amazon-kinesis-extension-customization-sdk
• Owner: hivemq
• License: apache-2.0
• Created: 2023-02-24T15:57:02.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-17T19:01:48.000Z (26 days ago)
• Last Synced: 2024-10-19T00:11:25.280Z (25 days ago)
• Language: Java
• Size: 262 KB
• Stars: 2
• Watchers: 10
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= HiveMQ Amazon Kinesis Extension Customization SDK

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

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

== Features

The HiveMQ Amazon Kinesis Extension Customization SDK allows the programmatic interaction with the https://www.hivemq.com/extension/hivemq-amazon-kinesis-extension/[HiveMQ Enterprise Extension for Amazon Kinesis].

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

* Convert a MQTT PUBLISH into one or more Amazon Kinesis records.

* Dismiss particular MQTT PUBLISHES from being converted into Amazon Kinesis records.

* Convert an Amazon Kinesis record into one or more MQTT PUBLISHES.

* Dismiss particular Amazon Kinesis records from being converted into MQTT PUBLISHES.

== Using the SDK

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

Maven

[source,xml]

----

    com.hivemq

    hivemq-amazon-kinesis-extension-customization-sdk

    4.33.0

----

Gradle

[source,groovy]

----

implementation("com.hivemq:hivemq-amazon-kinesis-extension-customization-sdk:4.33.0")

----

NOTE: The HiveMQ Amazon Kinesis Extension Customization SDK is available in Maven central, so no special configuration is needed.

== License

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

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