Git Product home page Git Product logo

aad-extension's Introduction

HiveMQ 4 Hello World Extension

Extension Type GitHub release (latest by date) GitHub GitHub Workflow Status (branch)

Purpose

This Hello World extension sets a ClientLifecycleEventListener which logs the MQTT Version and identifier of every connecting and disconnecting client and registers a PublishInboundInterceptor to modify the payload of every Publish with the topic 'hello/world' to 'Hello World!'.

We strongly recommend to read the HiveMQ Extension Documentation to grasp the core concepts of HiveMQ extension development.

Installation

  1. Clone this repository into a Java 11 Gradle project.

  2. Execute the Gradle task hivemqExtensionZip to build the extension.

  3. Move the file: build/hivemq-extension/hivemq-hello-world-extension-4.9.0.zip to the directory: HIVEMQ_HOME/extensions

  4. Unzip the file.

  5. Start HiveMQ.

First Steps

Manual Testing

Connect with an MQTT client of your choice. You should see a log message with its identifier and MQTT version.

Automatic Testing

Execute the HelloWorldInterceptorIT for automatic testing of the extension. It uses the HiveMQ Testcontainer to automatically package, deploy and run the extension inside a HiveMQ docker container. The test creates a HiveMQ MQTT Client to publish and receive a message with the topic 'hello/world'. It checks whether the payload has been changed correctly to 'Hello World!'.

Next Steps

Awesome, you got your first HiveMQ 4 extension working.

Now read the HiveMQ Extension Documentation to see what extensions can do.

Need Help?

If you encounter any problems, we are happy to help. The best place to get in contact is our support.

Contributing

If you want to contribute to HiveMQ Hello World Extension, see the contribution guidelines.

License

HiveMQ Hello World Extension is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found here.

aad-extension's People

Contributors

yannickweber avatar sgtsilvio avatar gitseti avatar florian-limpoeck avatar magierber avatar atastrophic avatar schaebo avatar sauroter avatar hivemq-jenkins avatar a-imal avatar dc2-danielkrueger avatar remit avatar busybeetree avatar rhinobetatron avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.