mirth-plugin-maven-plugin

mirth-plugin-maven-plugin is now archived in favor of mirth-plugin-maven-plugin-kt, a Kotlin rewrite with some improvements.

A maven plugin to simplify and automate NextGen Connect plugin development.

---

Installation

<repository>
    <id>nexus</id>
    <url>https://maven.kaurpalang.com/repository/maven-public/</url>
</repository>

<dependency>
  <groupId>com.kaurpalang</groupId>
  <artifactId>mirth-plugin-maven-plugin</artifactId>
  <version>1.0.2-SNAPSHOT</version>
</dependency>

---

Usage

See Sample project on Github

@ServerClass

Annotated class will be generated as a <string> entry.

<serverClasses>
    <string>com.kaurpalang.mirthpluginsample.server.ServerPlugin</string>
    <string>com.kaurpalang.mirthpluginsample.server.ServerPlugin2</string>
</serverClasses>

@ClientClass

Annotated class will be generated as a <string> entry.

<clientClasses>
    <string>com.kaurpalang.mirthpluginsample.client.ClientPlugin</string>
    <string>com.kaurpalang.mirthpluginsample.client.ClientPlugin2</string>
</clientClasses>

@ApiProvider(ApiProviderType type)

Annotated class will be generated as a <apiProvider> entry.

<apiProvider name="com.kaurpalang.mirthpluginsample.shared.ApiProviderSample" type="SERVLET_INTERFACE"/>

Libraries

All libraries inside pluginroot/libs/runtime/{type} are packaged into the .zip archive into libs directory.

<library path="libs/sample-external.jar" type="{type}"/>

---

Maven goals overview

generate-aggregator

Purpose is to generate a file to store all found classes before annotation processing.

Parameter	Description	Default
<aggregatorPath>	Specifies where to create aggregation file	distribution/aggregated.json

generate-plugin-xml

Purpose is to generate the actual plugin.xml file.

Parameter	Description	Default
<name>	Plugin's name	Default plugin
<author>	Plugin's author	John Doe
<pluginVersion>	Plugin version	42
<mirthVersion>	Mirth versions this plugin is compatible with	3.10.1
<url>	Plugin's website	https://github.com/kpalang/mirth-sample-plugin
<description>	Plugin's description	A sample Mirth plugin to showcase my Maven plugin
<path>	The name of the directory that will be extracted into Mirth's extensions directory	sampleplugin
<aggregatorPath>	Aggregation file location	distribution/aggregated.json
<outputPath>	Specifies where to put generated plugin.xml	${project.basedir}/plugin.xml