hivemq-spi

hivemq-spi copied to clipboard

:hivemq-github-link: https://github.com/hivemq :hivemq-link: http://www.hivemq.com :hivemq-plugin-docu-link: https://www.hivemq.com/docs/3.4/plugins/introduction.html :extension: https://github.com/hivemq/hivemq-extension-sdk

== HiveMQ SDK

NOTE: HiveMQ 4 uses a new extension system. This SDK is not compatible with HiveMQ 4. The new version can be found {extension}[here].

image:https://travis-ci.org/hivemq/hivemq-spi.png?branch=master["Build Status", link="https://travis-ci.org/hivemq/hivemq-spi"]

The enterprise MQTT broker HiveMQ offers this free and open source plugin SDK with service provider interfaces. This allows everyone to extend HiveMQ and add custom functionality via plugins.

With custom HiveMQ plugins, it's easy to add functionality like writing messages to databases, integrate with other service buses, collect statistics, add fine-grained security and virtually anything you else you can imagine.

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

=== Using the SDK

A extensive HiveMQ plugin documentation is available {hivemq-plugin-docu-link}[on the official HiveMQ website]. It covers the core concepts and shows how to set up your development environment.

You can also clone our example open source HiveMQ plugins at {hivemq-github-link}[in our Github page].

=== Maven Repository

Since version 2.0.0, the hivemq-spi is available in Maven central, so no special configuration is needed.

=== Using the SDK

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

[source,xml]

<dependency>
    <groupId>com.hivemq</groupId>
    <artifactId>hivemq-spi</artifactId>
    <version>3.4.4</version>
</dependency>

=== Plugin Development Documentation

Please visit {hivemq-plugin-docu-link}[our website] for the documentation how to develop plugins.

=== Example plugins You can find many example plugins by browsing {hivemq-github-link}[here on Github].

= Contributing

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

= License

HiveMQ SPI is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found link:LICENSE.txt[here].