https://github.com/hivemq/hivemq-edge-extension-sdk

Extension SDK for HiveMQ Edge
https://github.com/hivemq/hivemq-edge-extension-sdk

Last synced: 5 days ago
JSON representation

Extension SDK for HiveMQ Edge

• Host: GitHub
• URL: https://github.com/hivemq/hivemq-edge-extension-sdk
• Owner: hivemq
• License: apache-2.0
• Created: 2023-06-15T15:20:16.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-11T11:12:18.000Z (2 months ago)
• Last Synced: 2024-09-12T14:59:16.450Z (2 months ago)
• Language: Java
• Size: 204 KB
• Stars: 3
• 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-github: https://github.com/hivemq

:hivemq-edge: https://github.com/hivemq/hivemq-edge

:hivemq-website: http://www.hivemq.com

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

:hivemq-extensions-docu: http://www.hivemq.com/docs/latest/extensions/

:hivemq-marketplace: http://www.hivemq.com/extensions/

= HiveMQ Edge Extension SDK

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

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

{hivemq-edge}[HiveMQ Edge] offers this free, open source extension SDK.

The HiveMQ Edge extension framework provides an open API that allows developers to create custom extensions that suit their specific infrastructures.

Use our extension framework to extend HiveMQ Edge with custom business logic or to integrate virtually any system into HiveMQ.

The HiveMQ Edge extension framework can be used to add many different types of functionality:

* Modify messages

* integrate other services,

* collect statistics,

* add fine-grained security,

* and much more.

Resources:

* Web Site: {hivemq-website}

* Documentation: {hivemq-extensions-docu}

* Community Forum: {hivemq-community-forum}

* Contribution Guidelines: link:CONTRIBUTING.md[Contributing.adoc]

* License: The source files in this repository are made available under the link:LICENSE[Apache License Version 2.0].

== Using the SDK

The HiveMQ Edge extension 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-edge-extension-sdk

    2024.7

----

== Extension Development Documentation

Extension development for HiveMQ is as easy as writing a Java main method once you grasp the core concepts.

Please visit the extensive {hivemq-extensions-docu}[HiveMQ extension developer documentation].

It covers the core concepts and shows how to set up your development environment.

== Example Extensions

You can find many example extensions by browsing the {hivemq-github}[HiveMQ GitHub space].

Check out the {hivemq-marketplace}[HiveMQ Marketplace] for officially supported extensions.

== Need Help?

If you need help with custom HiveMQ extensions please contact [email protected].

== Contributing

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

== License

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

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