Registration Processor Developers Guide
Overview
Registration Processor(Regproc) is a backend processing engine to enable the ID Lifecycle management. It has several stages and services, registration packet flows through various stages depending on the type of flow.
The documentation here will guide you through the prerequisites required for the developer setup.
Software setup
Below are a list of tools required in Registration Processor:
JDK 11
Any IDE (like Eclipse, IntelliJ IDEA)
Apache Maven (zip folder)
pgAdmin
Git
Notepad++ (optional)
lombok.jar (file)
settings.xml (document)
Follow the steps below to set up Registration Processor on your local system:
Download
lombok.jar
andsettings.xml
from here.Unzip Apache Maven and move the unzipped folder in
C:\Program Files
andsettings.xml
toconf
folderC:\Program Files\apache-maven-3.8.4\conf
.Install Eclipse, open the
lombok.jar
file and wait for some time until it completes the scan for Eclipse IDE and then clickInstall/Update
.
Check the Eclipse installation folder
C:\Users\userName\eclipse\jee-2021-12\eclipse
to see if thelombok.jar
is added. By doing this, you don't have to add the dependency oflombok
in yourpom.xml
file separately as it is auto-configured by Eclipse.Configure the JDK (Standard VM) with your Eclipse by traversing through
Preferences → Java → Installed JREs
.
Code setup
For the code setup, clone the registration repository from and follow the guidelines mentioned in the Code Contributions.
Importing and building of a project
Open the project folder where
pom.xml
is present.Open command prompt from the same folder.
Run the command
mvn clean install -Dgpg.skip=true -DskipTests=true
to build the project and wait for the build to complete successfully.After building of a project, open Eclipse and select
Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish
.After successful importing of project, update the project by right-click on
Project → Maven → Update Project
.
Environment setup
For the environment setup, you need an external JAR that is available here with different versions. (E.g.: You can download
kernel-auth-adapter.jar
and add to projectLibraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close
).
Clone mosip-config repository.
Create an empty folder inside the
mosip-config
withsandbox-local
name and then copy and paste all the config files insidesandbox-local
folder except.gitignore, README and LICENSE
.As Registration Processor is using two properties files,
registration-processor-default
andapplication-default
, you will have to configure them according to your environment. The same files are available here for reference.To run the server, two files are required- kernel-config-server.jar and config-server-start.bat.
Put both the files in the same folder and change the location attribute to
sandbox-local
folder inconfig-server-start.bat
file and also check the version ofkernel-config-server.jar
towards the end of the command.
Example:
java -jar -Dspring.profiles.active=native -Dspring.cloud.config.server.native.search-locations=file:C:\Users\myDell\mosipProject\mosip-config\sandbox-local -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 kernel-config-server-1.2.0-20201016.134941-57.jar
.
Run the server by opening the
config-server-start.bat
file.
The server should now be up and running.
Before running any application of Registration Processor, replace the below properties in
bootstrap.properties
:
spring.cloud.config.uri=http://localhost:51000/config
spring.cloud.config.label=master
spring.profiles.active=default
spring.profiles.active can be dmz or mz(default)
Last updated