Audit Manager Developers Guide


Audit Manager module provides audit-related functionalities.

Below is a list of tools required for auditing:

  1. JDK 11

  2. Any IDE (like Eclipse, IntelliJ IDEA)

  3. Apache Maven (zip folder)

  4. PostgreSQL

  5. Any DB client (like DBeaver, pgAdmin)

  6. Postman (any HTTP Client)

  7. Git

  8. Any Editor (like Vscode, Notepad++ etc optional)

  9. lombok.jar (jar file)

  10. settings.xml (document)

Software setup

1. Download lombok.jar and settings.xml.

2. Unzip Apache Maven and move settings.xml to the "conf" folder <apache maven unzip path>\conf.

4. Check the Eclipse installation folder to see if the lombok.jar is added.

5. Configure the JDK (Standard VM) with your Eclipse by traversing through Preferences → Java → Installed JREs.

Source code setup

For the code setup, clone the repository and follow the guidelines mentioned in the Code Contributions.

Importing and building

  1. Open the project folder where pom.xml is present.

  2. Open the command prompt from the same folder.

  3. Run the command mvn clean install -Dgpg.skip=true -DskipTests=true to build the project.

  4. After building, open Eclipse and select Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish.

  5. After successfully importing of project, update the project by right-clicking on Project → Maven → Update Project.

Environment setup

1. Download Auth adapter and add to project Libraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close.

2. Clone mosip-config repository.

3. Refer Audit-DB-deploy to deploy local DB.

4. The audit uses two property files, kernel-default and application-default. Please configure them as needed. For instance,

  • Update the mosip.kernel.auditmanager-service-logs-location property to update the location of log files.

  • Secrets can be encrypted using config server.

  • Update URL's in property files.(It can be either pointed to any remotely or locally deployed services)

5. Download kernel-config-server.jar. For Windows, download config-server-start.bat, linux users can run

java -jar{mosip-config-mt_folder_path}/config {jarName} .

6. Run the server by opening the config-server-start.bat file.

7. To verify the config-server, hit the below URL:

http://localhost:51000/config/{}/{}/{} for instance http://localhost:51000/config/kernel/env/master.

Initialization and utilization of module

  1. Audit REST service consist of file in src/main/resources.

  2. Below properties needed to be modified in order to connect to the config server:<config server uri><branch of config repo>
  3. Services can be run using Run As -> Spring Boot App/Java Application.

  4. For API documentation, refer here.

  5. The API's can be tried with the help of Swagger-UI and Postman.

  6. Swagger-UI of service can be accessed from (https/http)://(<domain>/<host>:<port>)/<context-path>/swagger-ui/index.html?configUrl=<contect-path>/v3/api-docs/swagger-config for instance

  7. The API's can be tried using postman by copying CURL command below, updating host and importing in Postman.

curl -X 'POST' \
  'https://<host>/v1/auditmanager/audits' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "version": "string",
  "requesttime": "2022-04-20T12:23:59.300Z",
  "metadata": {},
  "request": {
    "eventId": "string",
    "eventName": "string",
    "eventType": "string",
    "actionTimeStamp": "2022-04-20T12:23:59.300Z",
    "hostName": "string",
    "hostIp": "string",
    "applicationId": "string",
    "applicationName": "string",
    "sessionUserId": "string",
    "sessionUserName": "string",
    "id": "string",
    "idType": "string",
    "createdBy": "string",
    "moduleName": "string",
    "moduleId": "string",
    "description": "string"

Last updated

Copyright © 2021 MOSIP. This work is licensed under a Creative Commons Attribution (CC-BY-4.0) International License unless otherwise noted.