diff options
-rw-r--r-- | docs/spec.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/spec.md b/docs/spec.md index e3f1e5b..ef8e57f 100644 --- a/docs/spec.md +++ b/docs/spec.md @@ -10,19 +10,19 @@ The goal of MOA ZS is to manage all aspects of the electronic delivery process f - Forwarding requests to delivery services - Handling responses and notifications (e.g. signature verification, archiving) -The following figure shows, with which electronic delivery participants MOA ZS communciates and which interfaces it uses: +The following figure shows, with which electronic delivery participants MOA ZS communciates and which interfaces it uses: ![Architecture](https://git.egiz.gv.at/moa-zs/plain/docs/figures/architecture.png "Architecture") -- The sender application sends a `mzs:DeliveryRequest` (specified in [app2mzs.wsdl](../src/main/resources/mzs/app2mzs.wsdl)) to MOA ZS. -- MOA ZS sends a `tnvz:QueryPersonRequest` to the participant registry to find out if the receiver is registered (specified in [zuse2tnvz_p2.wsdl](../src/main/resources/zusetnvz/zuse2tnvz_p2.wsdl)). - This request is optional and depends on parameters from the `mzs:DeliveryRequest` and from the MOA ZS configuration. +- The sender application sends a `mzs:DeliveryRequest` (specified in [app2mzs.wsdl](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/mzs/app2mzs.wsdl)) to MOA ZS. +- MOA ZS sends a `tnvz:QueryPersonRequest` to the participant registry to find out if the receiver is registered (specified in [zuse2tnvz_p2.wsdl](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/zusetnvz/zuse2tnvz_p2.wsdl)). + This request is optional and depends on parameters from the `mzs:DeliveryRequest` and from the MOA ZS configuration. If the receiver is registered, the participant registry returns an identifier for this receiver. -- MOA ZS converts the `mzs:DeliveryRequest` to a `msg:DeliveryRequest` and forwards `msg:DeliveryRequest` to the delivery service (specified in [app2zuse_p2.wsdl](../src/main/resources/zusemsg/app2zuse_p2.wsdl)). -- The delivery service sends delivery notifications and status updates to MOA ZS via the [zuse2app_p2.wsdl](../src/main/resources/zusemsg/zuse2app_p2.wsdl) service. -- MOA ZS then handles notifications and status updates by verifying their signatures, archiving them, and by (optional) forwarding the notifications to the sender application (specified in [mzs2app.wsdl](../src/main/resources/mzs/mzs2app.wsdl)). +- MOA ZS converts the `mzs:DeliveryRequest` to a `msg:DeliveryRequest` and forwards `msg:DeliveryRequest` to the delivery service (specified in [app2zuse_p2.wsdl](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/zusemsg/app2zuse_p2.wsdl)). +- The delivery service sends delivery notifications and status updates to MOA ZS via the [zuse2app_p2.wsdl](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/zusemsg/zuse2app_p2.wsdl) service. +- MOA ZS then handles notifications and status updates by verifying their signatures, archiving them, and by (optional) forwarding the notifications to the sender application (specified in [mzs2app.wsdl](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/mzs/mzs2app.wsdl)). -MOA ZS uses Apache CXF as a web service framework and the Spring Framework as inversion of control container. The application is written in Java and requires JDK 12 as runtime environment. +MOA ZS uses Apache CXF as a web service framework and the Spring Framework as inversion of control container. The application is written in Java and requires JDK 12 as runtime environment. ## Changelog @@ -175,7 +175,7 @@ A configuration profile contains all parameters that determine how MOA ZS proces The following list specifies, how to configure a parameter and in which priority MOA ZS lets you override parameters, highest priority first: 1. You can set a parameter directly in a `mzs:DeliveryRequest` under the `Config` element. - See [app2mzs.xsd](../src/main/resources/mzs/app2mzs.xsd) for a list of parameters that you can configure. + See [app2mzs.xsd](https://git.egiz.gv.at/moa-zs/tree/src/main/resources/mzs/app2mzs.xsd) for a list of parameters that you can configure. Note that each parameter is optional and you can override individual parameters, while omitting other parameters. For parameters that are missing from the `Config` element, MOA ZS falls back to the parameter from the *referred profile*. The scope of a parameter in the `Config` element is always limited to the current delivery request. |