HiveMQ Maven Plugin - User Guide

HiveMQ Maven Plugin

This maven plugin simplifies the development of HiveMQ extensions as it provides a simple way to execute your extension with HiveMQ.

Usage as Maven Profile

HiveMQ Maven plugin embedded as Maven profile

<profiles>
    <profile>
        <id>RunWithHiveMQ</id>
        <build>
            <plugins>
                <plugin>
                    <groupId>com.hivemq</groupId>
                    <artifactId>hivemq-maven-plugin</artifactId>
                    <version>4.0.1</version>
                    <executions>
                        <execution>
                            <id>hivemq</id>
                            <phase>package</phase>
                            <goals>
                                <goal>hivemq</goal>
                            </goals>
                            <configuration>
                                <hiveMQDir>
                                       (1)
                                </hiveMQDir>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>

1. Insert HiveMQ home directory

Configuration Options

Name	Type	Required	Default	Description
hivemqDir	String	true		Directory of the HiveMQ Jar-file
extensionZipName	String	false	{artifact-id}-{version}-distribution.zip	Name of the extension zip file
extensionDirectory	String	false	target	Name of the directory, where the extension folder is located
verbose	boolean	false	true	HiveMQ logging to standard output enabled
noExtensions	boolean	false	false	Should extensions be loaded, false for extensions are loaded, true for extensions are not loaded
debugMode	String	false	SERVER	Mode of the debugger: CLIENT, SERVER, NONE
debugServerHostName	String	false	localhost	Used in CLIENT debugMode
debugPort	String	false	5005	Port on which HiveMQ in debug mode and IDE connect
hivemqJar	String	false	hivemq.jar	Name of the HiveMQ Jar-file
includeResources	String	false		Path to a folder that will be included into the extension folder

Debug Modes

Client Mode

HiveMQ is the debugging client, so a debugging server has to be opened already, for example by an IDE.

Server Mode

HiveMQ is the debugging server, an IDE debugger can be connected after HiveMQ is started.

Contributing

If you want to contribute to HiveMQ Maven Plugin, see the contribution guidelines.

License

HiveMQ Maven Plugin is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found here.