Getting started

A typical API usage is as follows:

Step 1 - Include the library

For using this API please include in the class-path of your authorization plugin the library of this API migratorydata-extension-authorization.jar located in the folder lib of the SDK of this API.

Step 2 - Implement MigratoryDataEntitlementListener

Implement the two methods provided by the MigratoryDataEntitlementListener interface:

void onSubscribe(MigratoryDataSubscribeRequest);

void onPublish(MigratoryDataPublishRequest);

Step 3 - Build the jar of your authorization plugin

Build the JAR consisting of the object code of the class you defined at Step 2. The JAR should also include in its META-INF folder a subfolder services including a file:

com.migratorydata.extensions.authorization.MigratoryDataEntitlementListener

which should have as content the fully qualified name of the class you defined at Step 2.

Step 4 - Install the extension

Rename the JAR built at Step 3 to authorization.jar and deploy it to the folder extensions of your MigratoryData server installation. See the Installation Guide to learn where is the location of this extensions folder.

Step 5 - Configure the server

In the configuration file of the MigratoryData server, configure the parameter Entitlement as below and restart the server:

Entitlement = Custom

Step 6 - Update the client

In order for a user to be granted access to the MigratoryData server by your authorization plugin, an entitlement token should be attached to the user.

Use the API call MigratoryDataClient.setEntitlementToken(String) to attach an entitlement token to the users of your client applications.

Examples

Examples built with this API are available in the folder examples of the SDK of this API; start with the README file which explains how to run them.