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

This guide includes the following sections:

Overview

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

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

Creating an Audit Extension for MigratoryData Server

A typical API usage is as follows:

Step 1 - Implement one or more audit interfaces

The interfaces MigratoryDataAccessListener, MigratoryDataPublishListener, MigratoryDataCacheListener, and MigratoryDataStatsListener are available as part of the audit library which can be found under the folder doc/Extension/libs/audit of this package.

Step 2 - Build the jar of the extension

Build the JAR consisting of the object code of the classes 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 for each implemented interface at Step 1 named as the fully qualified name of the interface and having as content the fully qualified name of the class which implements the interface.

Step 3 - Install the extension

Rename the JAR built at Step 2 to audit.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 audit

In the configuration file of the MigratoryData server, set on true the parameters Audit.Access, Audit.Publish, Audit.Cache, and Audit.Stats provided that you implemented its corresponding interface at Step 1.

Step 5 - Restart the MigratyData server

Examples

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