Audit Manager Developers Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
module provides audit-related functionalities.
Below is a list of tools required for auditing:
JDK 11
Any IDE (like Eclipse, IntelliJ IDEA)
Apache Maven (zip folder)
PostgreSQL
Any DB client (like DBeaver, pgAdmin)
Postman (any HTTP Client)
Git
Any Editor (like Vscode, Notepad++ etc optional)
lombok.jar (jar file)
settings.xml (document)
1. Download and .
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
.
Open the project folder where pom.xml
is present.
Open the command prompt from the same folder.
Run the command mvn clean install -Dgpg.skip=true -DskipTests=true
to build the project.
After building, open Eclipse and select Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish
.
After successfully importing of project, update the project by right-clicking on Project → Maven → Update Project
.
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.
Update URL's in property files.(It can be either pointed to any remotely or locally deployed services)
java -jar -Dspring.profiles.active=native -Dspring.cloud.config.server.native.search-locations=file:{mosip-config-mt_folder_path}/config -Dspring.cloud.config.server.accept-empty=true -Dspring.cloud.config.server.git.force-pull=false -Dspring.cloud.config.server.git.cloneOnStart=false -Dspring.cloud.config.server.git.refreshRate=0 {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/{spring.profiles.active}/{spring.cloud.config.name}/{spring.cloud.config.label}
for instance http://localhost:51000/config/kernel/env/master
.
Audit REST service consist of bootstrap.properties
file in src/main/resources
.
Below properties needed to be modified in order to connect to the config server:
Services can be run using Run As -> Spring Boot App/Java Application
.
The API's can be tried with the help of Swagger-UI and Postman.
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 https://dev2.mosip.net/v1/auditmanager/swagger-ui/index.html?configUrl=/v1/auditmanager/v3/api-docs/swagger-config
.
The API's can be tried using postman by copying CURL command below, updating host and importing in Postman.
3. Install Eclipse, open the lombok.jar
file, and click Install/Update
.
For the code setup, clone the repository and follow the guidelines mentioned in the .
1. Download and add to project Libraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close
.
2. Clone .
3. Refer to deploy local DB.
Secrets can be encrypted using .
5. Download . For Windows, download , linux users can run
For API documentation, refer .