https://github.com/hivemq/hivemq-swarm-hello-world-extension

HiveMQ Swarm extension for demonstrating the HiveMQ Swarm extension system
https://github.com/hivemq/hivemq-swarm-hello-world-extension

demonstration extension hello-world hivemq-swarm hivemq-swarm-extension mqtt

Last synced: about 4 hours ago
JSON representation

HiveMQ Swarm extension for demonstrating the HiveMQ Swarm extension system

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-swarm-hello-world-extension
• Owner: hivemq
• License: apache-2.0
• Created: 2021-04-22T14:21:48.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T13:55:24.000Z (23 days ago)
• Last Synced: 2024-10-18T13:53:58.740Z (21 days ago)
• Topics: demonstration, extension, hello-world, hivemq-swarm, hivemq-swarm-extension, mqtt
• Language: Java
• Homepage: https://www.hivemq.com/docs/swarm/latest/swarm/extensions.html
• Size: 265 KB
• Stars: 4
• Watchers: 15
• 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-link: https://www.hivemq.com

:hivemq-extension-docs: {hivemq-link}/docs/swarm/latest/swarm/extensions.html

:hivemq-support: {hivemq-link}/support/

= HiveMQ Swarm Hello World Extension

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

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

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

== Purpose

This Hello World extension registers a `PayloadGenerator` which can be used in a publish command of the scenario.xml of HiveMQ Swarm to set every payload to "HelloWorld".

We strongly recommend reading the {hivemq-extension-docs}[HiveMQ Swarm Extension Documentation] to grasp the core concepts of HiveMQ Swarm extension development.

== Installation

* Clone this repository into a Java 11 Gradle project.

* Execute the Gradle task `jar` to build the extension.

* Move the file: `build/libs/hivemq-swarm-hello-world-extension-4.34.0.jar` to the directory: `HIVEMQ_SWARM_HOME/extensions`

* Use the payload generator in a publish command in the scenario.xml of your choice.

----

----

* Start HiveMQ Swarm.

== Need Help?

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

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

== Contributing

If you want to contribute to HiveMQ Swarm Hello World Extension, see the link:CONTRIBUTING.md[contribution guidelines].

== License

HiveMQ Swarm Hello World Extension is licensed under the `APACHE LICENSE, VERSION 2.0`.

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