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

This guide includes the following sections:

Overview

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

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

Creating an Authorization Extension for MigratoryData Server

A typical API usage is as follows:

Step 1 - Implement the interface MigratoryDataAuthorizationListener

The interface MigratoryDataAuthorizationListener is available as part of the authorization library which can be found under the folder doc/Extension/libs/authorization of this package.

Step 2 - Build the jar of the extension

Build the JAR consisting of the object code of the class defined at Step 1. 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.extensions.authorization.MigratoryDataAuthorizationListener which must have as content the fully qualified name of the class defined at Step 1.

Step 3 - Install the extension

Rename the JAR built at Step 2 to authorization.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 4 - Configure the authorization type

In the configuration file of the MigratoryData server, configure the parameter Authorization.Type as follows:

Authorization.Type = Custom

Step 5 - Restart the MigratyData server

Examples

An example built with this API is available in the folder doc/Extension/examples/authorization of this package; start with the README file which explains how to compile and deploy the example authorization extension.