4.6.0 Updating Custom Extensions

• mirth-core-client

• mirth-core-client-api

• mirth-core-client-base

• mirth-core-client-plugins

• mirth-core-models

• mirth-core-server-plugins

• mirth-core-ui

• mirth-core-util

• mirth-client-core.jar: These classes were moved into various other core libraries.

• mirth-crypto.jar: These classes were moved into mirth-core-util.

• donkey-model.jar: These classes were moved into other core libraries, primarily mirth-core-models.

• mirth-core-client: Contains the Client class that can be used to make API requests to a server.

• mirth-core-client-api: Contains servlet interfaces.

• mirth-core-client-base: Contains classes needed for basic API hooks and base classes needed by the server and client.

• mirth-core-client-plugins: Contains classes needed for client-side extension hooks.

• mirth-core-models: Contains base model classes.

• mirth-core-server-plugins: Contains classes needed for server-side extension hooks.

• mirth-core-ui: Contains common Java Swing components and base classes used in the client.

• mirth-core-util: Contains various utility classes.

In addition, if you are able, stop linking to the following librariesso your extension is no longer tightlycoupled with a specific version of Connect, but rather is only dependent on one or more core libraries:

• mirth-server.jar

• donkey-server.jar

• mirth-client.jar

Update the extension’s metadata XML files (plugin.xml, source.xml, and/or destination.xml) to specify the core libraries it depends on and the minimum versions it requires. Initially, the minimum version should be 4.6.0 for each core library. Refer to the following example metadata XML file:

<pluginMetaData path="myPlugin">
	<name>Plugin Name</name>
	<author>Author</author>
	<pluginVersion>4.6.0</pluginVersion>
	<mirthVersion>4.6.0</mirthVersion>
	<minCoreVersions class="java.util.Map">
		<entry><string>mirth-core-client</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-client-api</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-client-base</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-client-plugins</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-models</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-server-plugins</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-ui</string><string>4.6.0</string></entry>
		<entry><string>mirth-core-util</string><string>4.6.0</string></entry>
	</minCoreVersions>
</pluginMetaData>

• PlatformUI is now located in the mirth-core-ui library, and PlatformUI.MIRTH_FRAME is now a FrameBase rather than a Frame. You will need to update your import statements or cast references to that field to a Frame.

• DatabaseSettings.getProperties() has been replaced with DatabaseSettings.getProperties(Serializer serializer).

• Subclasses of com.mirth.connect.donkey.util.Serializer must now implement <T> List<T> deserializeList(String serializedObject, Class<T> expectedListItemClass).

Many classes were moved to different packages, so you will need to update your import statements accordingly. Refer to the following table for the changed packages. All packages begin with com.mirth.connect.

Here is an example of how to update a SourceConnector class:

// Original class
public class MyCustomReceiver extends SourceConnector {
  private void myCustomMethod() {
    System.out.println("Channel ID: " + getChannelId()); // Calls the inherited method getChannelId()
    System.out.println("Connector Name: " + super.getConnectorName());  // Calls the inherited method getConnectorName() via super reference
  }
}
// Updated class
public class MyCustomReceiver implements SourceConnectorPlugin {
  private ISourceConnector connector;
  @Override
  public void initialize(ISourceConnector connector) {
    this.connector = connector;
  }
  private void myCustomMethod() {
    System.out.println("Channel ID: " + connector.getChannelId()); // Calls method from ISourceConnector reference
    System.out.println("Connector Name: " + connector.getConnectorName());  // Calls method from ISourceConnector reference
  }
}

In addition, connectors that directly extended a concrete connector class in Mirth® Connect, such as the HttpReceiver or WebServiceDispatcher, must add a new property to their metadata XML file named serverBaseClassName that specifies the fullyqualified name of the base class. In the following example, MyDispatcher extended HttpDispatcher:

<connectorMetaData path="myConnector">
	<name>My Connector</name>
	<author>Me</author>
	<pluginVersion>4.6.0</pluginVersion>
	<mirthVersion>4.6.0</mirthVersion>
	<url>http://myurl.com</url>
	<description>Some description.</description>
	<clientClassName>my.connectors.myconnector.client.MySender</clientClassName>
	<serverClassName>my.connectors.myconnector.server.MyDispatcher</serverClassName>
	<serverBaseClassName>com.mirth.connect.connectors.http.HttpDispatcher</serverBaseClassName>
</connectorMetaData>

Client connectors that directly extended a concrete class in Mirth® Connect, such as HttpListener, must add a property to their metadata XML file named clientBaseClassName that specifies the fullyqualified name of their base class. In the following example, MyListener extended HttpListener:

<connectorMetaData path="myConnector">
	<name>My Connector</name>
	<author>Me</author>
	<pluginVersion>4.6.0</pluginVersion>
	<mirthVersion>4.6.0</mirthVersion>
	<url>http://myurl.com</url>
	<description>Some description.</description>
	<clientClassName>my.connectors.myconnector.client.MyListener</clientClassName>
	<clientBaseClassName>com.mirth.connect.connectors.http.HttpListener</clientBaseClassName>
	<serverClassName>my.connectors.myconnector.server.MyReceiver</serverClassName>
</connectorMetaData>