eGov-Localisation

Owned by Kaviyarasan P
Apr 04, 2020
2 min read

INTRODUCTION



An eGov core application which provides locale-specific components and translating text for the eGov group of applications.



Requirements:



  1. Prior Knowledge of Java/J2EE.

  2. Prior Knowledge of Spring Boot.

  3. Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.

  4. Prior knowledge of Redis and postgres.



Functionality: 

 

The localization application stores the locale data in the format of key and value along with the module, tenantid and locale. Module defines which application of eGov owns the locale data and tenantId does the same for the tenant, locale is the specific locale for which data is being added.  



The request can be posted through the post API with the above mentioned variables in the request body.



Once posted the same data can be searched based on the module, locale and tenantId as keys.



The Data posted to localization service will be permanently stored in the database and will be loaded in to redis cache for easy access and every time new data is added in to the application the redis cache will be refreshed.

FLOW DIAGRAM :



SETUP AND USAGE:

 

The Application is present among the core group of applications available in the eGov-services git repository.  The spring boot application but needs lombok extension added in your IDE to load it. Once the application is up and running API requests can be posted to the url and ids can be generated. 



  • *in case of intellij the plugin can be installed directly, for eclipse the lombok jar location has to be added in eclipse.ini file in this format

-javaagent:lombok.jar.



For the API information please refer the swagger yaml 



GOTO : https://editor.swagger.io/  and click on file -> import url 



Then add the raw url of the API doc in the pop up. 



https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-localization/docs/contract/v1-0-0.yml



Incase the url is unavailable, please go to the docs folder of egov-services git repo and find the yaml for egov-filestroe.

 

The application needs redis cache running along with the DB.



To work any of the file storages there are some application properties which needs to be configured.

ACCESS:

Please use the following postman collection to access apis of localization services.