Reform Scan Notification is a microservice that provides the Bulk Scan ecosystem a way of notifying an external supplier when something has gone wrong.
Retrieves service bus queue messages from notifications queue and then processes them by notifying external supplier's API and finally saves results to database in notifications table.
Also exposes several API endpoints related to notifications. Through this microservice you can retrieve information about a specific notification, get a list of all notifications that have not yet been processed in the queue and also request that the external supplier is notified of an error.
- Retrieves messages from service bus queue
- Notifies external supplier via API
- Persists results in notifications table
- Health endpoint for monitoring application status
- JDK 21
- Project requires Spring Boot v3.x to be present
An alternative faster way getting started is by using the automated setup script. This script will help set up all bulk scan/print repos including reform-scan-notification-service and its dependencies. See common-dev-env-bsbp repository for more information.
The project uses Gradle as a build tool. It already contains
./gradlew wrapper script, so there's no need to install gradle.
To build the project execute the following command:
./gradlew buildCreate the image of the application by executing the following command:
./gradlew assembleCreate docker image:
docker-compose buildRun the distribution (created in build/install/reform-scan-notification-service directory)
by executing the following command:
docker-compose upThis will start the API container exposing the application's port
(set to 8585 in this app).
In order to test if the application is up, you can call its health endpoint:
curl http://localhost:8585/healthYou should get a response similar to this:
{"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}
This project is licensed under the MIT License - see the LICENSE file for details