MigratoryData Extension API
Developer's Guide and Reference Manual
Developer's Guide

This guide includes the following sections:


This Application Programming Interface (API) contains all the necessary operations for building extensions for MigratoryData Server.

Before reading this manual, it is recommended to read MigratoryData Architecture Guide (PDF, HTML).

Creating Extensions for MigratoryData Server

A typical API usage is as follows:

Step 1 - Import in your application the API as follows:

import com.migratorydata.extension.MigratoryDataExtensionListener;

Step 2 - Implement the interface MigratoryDataExtensionListener

The interface MigratoryDataExtensionListener is available under the folder doc/Extensions/entitlement/api of this package.

Step 4 - Building the jar of the extension

Build a jar consisting in the object code of the class defined at Step 2. In addition, the jar must also include a folder named services in its META-INF folder. Moreover, the folder services must include a file named com.migratorydata.agent.MigratoryDataExtensionListener which must have as content the fully qualified name of the class defined at Step 2.

Step 5 - Install the extension

Rename the JAR built at Step 4 to extension.jar and deploy it to the folder extensions of the root folder of your MigratoryData server installation. If you installed MigratoryData Server using the deb/rpm packages, then deploy the JAR to the folder /usr/share/migratorydata/extensions.

Step 6 - Configure the entitlement

In the configuration file of the MigratoryData server, configure the parameter Entitlement as follows:

Entitlement = Custom

Step 7 - Restart the MigratyData server

Step 8 - Include the entitlement token in clients

Use the API call MigratoryDataClient.setEntitlementToken() to attach an entitlement token to the clients of the MigratoryData server.


An example built with this API is available in the folder doc/Extensions/entitlement/examples of this package; start with the README file which explains how to compile and run the example.