# Commons Developers Guide

## Overview

[Commons](https://docs.mosip.io/1.2.0/modules/commons) module provides a bedrock to build and run services by providing several significant necessary technical operations. It contains common functionalities which are used by more than one module.

Below is a list of tools required in Commons:

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](https://projectlombok.org/download) and [settings.xml](https://github.com/mosip/documentation/tree/1.2.0/docs/_files/commons/settings.xml).
2. Unzip Apache Maven and move `settings.xml` to "conf" folder `<apache maven unzip path>\conf`.
3. Install Eclipse, open the `lombok.jar` file and then click `Install/Update`.

![](/files/5fJLX5CC6ovM6CHMphDE)

1. Check the Eclipse installation folder to see if the `lombok.jar` is added.
2. Configure the JDK (Standard VM) with your Eclipse by traversing through `Preferences → Java → Installed JREs`.

![](/files/2uKzCG0i7f0HOAbSIojO)

### Source code setup

For the code setup, clone the repository and follow the guidelines mentioned in the [Code Contributions](https://docs.mosip.io/1.2.0/community/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 successful importing of project, update the project by right-click on `Project → Maven → Update Project`.

![](/files/D3RIv6MtLMutmJaTJYAJ)

## Environment setup

1. Download [Auth adapter](https://oss.sonatype.org/#nexus-search;gav~~kernel-auth-adapter~1.2.0-SNAPSHOT~~) and add to project `Libraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close`.

   ![](/files/f7jdZbSZxF2dZ7fT0pYr)
2. Clone [mosip-config repository](https://github.com/mosip/mosip-config).
3. Refer [Commons-DB-deploy](https://github.com/mosip/commons/blob/release-1.2.0/db_scripts/README.md) to deploy local DB.
4. For integration with any of our environments, do reach out to our team.
5. `Commons` uses two property files, `kernel-default` and `application-default`, configure them accordingly. For instance

* Update `spring.mail.host` property to update SMTP host.
* Secrets can be encrypted using [config server](https://cloud.spring.io/spring-cloud-config/reference/html/#_encryption_and_decryption).
* Update Url's in property files.(It can be either pointed to any remotely or locally deployed services).

1. Download [kernel-config-server.jar](https://oss.sonatype.org/#nexus-search;gav~~kernel-config-server~1.2.0-SNAPSHOT~~). For windows download [config-server-start.bat](https://github.com/mosip/documentation/blob/1.2.0/docs/_files/commons/config-server-start.bat), linux users can run `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}` .
2. Run the server by opening the `config-server-start.bat` file.

![](/files/8KxMJTv67HMayTYqHW5Y)

1. 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`.

## Initialization and utilization of module

1. `Commons` repo consists of two types of project- REST services and libraries.
2. Every REST service consist of `bootstrap.properties` file in `src/main/resources`.
3. Below properties needed to be modified in order to connect to the config server:

   ```
   spring.cloud.config.uri=<config server uri>
   spring.cloud.config.label=<branch of config repo>
   spring.profiles.active=default
   ```
4. Services can be run using `Run As -> Spring Boot App/Java Application`.
5. Libraries are not meant to be run alone they are projects used by commons as well as other modules of mosip to perform commons operations.
6. For API documentation, refer [here](https://docs.mosip.io/1.2.0/api).
7. The API's can be tried with the help of **Swagger-UI** and **Postman**.
8. Swagger-UI of services 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://dev.mosip.net/v1/authmanager/swagger-ui/index.html?configUrl=/v1/authmanager/v3/api-docs/swagger-config`.
9. Context-path of services is present in `bootstrap.properties` file in `src/main/resources` of every service.
10. The API's can be tried using Postman. URLs and Body structures can be found in Swagger or curl command can be copied and imported in Postman.

![](/files/n0apuBAku76KtefrzyPO)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mosip.io/1.2.0/id-lifecycle-management/supporting-components/commons/commons-developer-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.