https://github.com/hivemq/hivemq-amazon-kinesis-hello-world-customization

https://github.com/hivemq/hivemq-amazon-kinesis-hello-world-customization

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-amazon-kinesis-hello-world-customization
• Owner: hivemq
• License: apache-2.0
• Created: 2023-03-24T13:10:53.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-16T13:53:03.000Z (28 days ago)
• Last Synced: 2024-10-18T13:54:24.795Z (26 days ago)
• Language: Java
• Size: 264 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
:hivemq-amazon-kinesis-docs: https://www.hivemq.com/docs/hivemq-amazon-kinesis-extension

:hivemq-blog-tools: https://www.hivemq.com/mqtt-toolbox/

:hivemq-support: https://community.hivemq.com

= HiveMQ Amazon Kinesis Extension Hello World Customization

image:https://img.shields.io/badge/Customization_Type-Demonstration-orange?style=for-the-badge[Extension Type]

image:https://img.shields.io/github/v/release/hivemq/hivemq-amazon-kinesis-hello-world-customization?style=for-the-badge[GitHub release (latest by date),link=https://github.com/hivemq/hivemq-amazon-kinesis-hello-world-customization/releases/latest]

image:https://img.shields.io/github/license/hivemq/hivemq-amazon-kinesis-hello-world-customization?style=for-the-badge&color=brightgreen[GitHub,link=LICENSE]

== Purpose

This project contains two example transformer implementations that show how to use the customization SDK for the {hivemq-amazon-kinesis-docs}[HiveMQ Enterprise Extension for Amazon Kinesis].

- The `com.hivemq.extensions.amazon.kinesis.customizations.helloworld.MqttToKinesisHelloWorldTransformer` that transforms and forwards MQTT publishes to Amazon Kinesis.

- The `com.hivemq.extensions.amazon.kinesis.customizations.helloworld.KinesisToMqttHelloWorldTransformer` that transforms and forwards Amazon Kinesis records to HiveMQ.

== Installation

* Clone this repository into a Java 11 Gradle project.

* Run the `./gradlew jar` task from Gradle to build the customization.

* Copy the `build/libs/hivemq-amazon-kinesis-hello-world-customization-4.34.0.jar` file to the  `HIVEMQ_HOME/extensions/hivemq-amazon-kinesis-extension/customizations` directory.

* Copy the `src/main/resources/amazon-kinesis-configuration.xml` file to the `HIVEMQ_HOME/extensions/hivemq-amazon-kinesis-extension` folder.

* Adapt the configuration to your environment.

** (optional): Uncomment and adjust `` to manage your AWS credential profiles.

** (optional): Uncomment and adjust `` to reference your AWS credential profiles.

** (optional): Uncomment and adjust `` to choose your desired AWS Region.

** Set the `` of the destination `` in the `` to an existing Amazon Kinesis stream.

** Set the `` of the `` in the `` to an existing Amazon Kinesis stream.

** Set the `` of the `` in the `` to a unique value.

* Delete the `HIVEMQ_HOME/extensions/hivemq-amazon-kinesis-extension/DISABLED` file (if there is one).

* Start HiveMQ.

== First Steps

=== Manually Test Your mqtt-to-kinesis-route

- Connect with an {hivemq-blog-tools}[MQTT client] of your choice.

- Publish an MQTT message to the topic `to-kinesis/test`.

- Monitor the stream you configured in your AWS account for a received message.

=== Manually Test Your kinesis-to-mqtt-route

- Connect with an {hivemq-blog-tools}[MQTT client] of your choice.

- Subscribe to `from-kinesis/#`.

- Publish an Amazon Kinesis record to the Amazon Kinesis stream.

- Verify that you receive an MQTT message with your client.

== Need Help?

If you encounter any problems, we are happy to help.

The best place to get in contact is our {hivemq-support}[community forum].

== License

HiveMQ Amazon Kinesis Extension Hello World Customization is licensed under the `APACHE LICENSE, VERSION 2.0`.

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