Skip to main content
Version: 2.0

RS-DELIVERY Conception

Basically, rs-delivery is a microservice that interacts with REGARDS core functionalities to make files available for download in a configurable S3 server. The following sequence diagram presents the main interactions when a delivery request is sent.

delivery_sequence_diagram

Create a delivery request​

First, a delivery event is published by an external client and is then received by REGARDS to be proceeded.

see create a delivery request

REGARDS checks the conformity of the message received:

  • if it is valid, the request is saved and a delivery response with GRANTED status is sent,
  • otherwise, the response with the DENIED status is sent with the error received by delivery.

see subscribe to delivery responses

Monitor the request progress​

Internally, the request is then forwarded to rs-order microservice to be processed.

Files requested are retrieved and made available locally by rs-order. An event is then sent from rs-order to rs-delivery to indicate that the suborder has been processed.

Current limitation

For now, only one suborder is allowed per delivery request. If there are more than one, the delivery request is set to ERROR status.

When rs-delivery receives the final order event, it handles the response in two different ways:

  • In case of error, an event is sent from rs-delivery to rs-order to delete the order and the request status is set to ERROR.
  • In case of success, files are retrieved by rs-delivery and copied to its local workspace. They are then zipped and uploaded to the configured S3 server. The checksums are systematically verified to ensure data integrity. A DONE response is then published to notify the end of the delivery.

see subscribe to delivery responses