aboutsummaryrefslogtreecommitdiff
path: root/docs/spec.md
diff options
context:
space:
mode:
authorChristof Rabensteiner <christof.rabensteiner@iaik.tugraz.at>2019-08-30 13:52:48 +0200
committerChristof Rabensteiner <christof.rabensteiner@iaik.tugraz.at>2019-08-30 13:52:48 +0200
commitb9715604f4f50ddab2c59395f8a264a938689901 (patch)
tree70bb1bdb5236e1e2e549d3a8aed21a589966ea91 /docs/spec.md
parentc048d2ee787197b963dc1e8fa9297cf1cd3a4307 (diff)
downloadmoa-zs-b9715604f4f50ddab2c59395f8a264a938689901.tar.gz
moa-zs-b9715604f4f50ddab2c59395f8a264a938689901.tar.bz2
moa-zs-b9715604f4f50ddab2c59395f8a264a938689901.zip
Documentation: Add YAML Config Profile Example
Diffstat (limited to 'docs/spec.md')
-rw-r--r--docs/spec.md71
1 files changed, 48 insertions, 23 deletions
diff --git a/docs/spec.md b/docs/spec.md
index 7854499..efaa5be 100644
--- a/docs/spec.md
+++ b/docs/spec.md
@@ -141,37 +141,62 @@ The following list specifies, how a parameter can be configured and in which pri
3. If you so not specify a parameter in `Config`, if you do not select a `ProfileId`, or if the parameter in the selected profile is missing, MOA ZS falls back to the parameter in the `default` profile.
If a mandatory parameter is not configured in any of the listed manners, MOA ZS rejects the delivery request.
-The following listing shows the structure of a profile.
-You find a description of the individual parameters in `application.yaml`.
+
+### Structure of a Delivery Request Configuration Profile in `application.yaml`
+
+The following listing shows the structure of a delivery request configuration profile.
+You find a description and several examples eof the individual parameters in `application.yaml`.
```
- default:
- service-timeout: 60
- perform-query-person-request: false
+ <ProfileID-string>:
+
+ service-timeout: <integer>
+
+ perform-query-person-request: <boolean>
+
tnvz-client:
- url: http://localhost:8082/tnvz/
- connection-timeout: 0
- receive-timeout: 0
- ssl:
- custom-http-headers:
- X-PVP-NAME-1: VALUE-X
- X-PVP-NAME-2: VALUE-Y
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
+
msg-client:
- url: http://localhost:8081/services/DeliveryRequest
- connection-timeout: 0
- receive-timeout: 0
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
+
msg-response-sinks:
save-response-to-file:
- active: false
- path: /msg-responses/
- log-response: true
+ active: <boolean>
+ path: <string>
+ log-response: <boolean>
forward-response-to-service:
- active: false
+ active: <boolean>
mzs-client:
- url: http://service.which.implements.mzs2app.wsdl/services/
- connection-timeout: 0
- receive-timeout: 0
- ssl:
+ url: <string>
+ connection-timeout: <integer>
+ receive-timeout: <integer>
+ ssl: ...
+ custom-http-headers: ...
+```
+
+This listing shows, how a connection of a client can be protected with SSL and how client authentication can be activated:
+
+```
+ ssl:
+ trust-all: <boolean>
+ lax-hostname-verification: <boolean>
+ key-store:
+ filename: <string>
+ password: <string>
+ type: <string>
+ trust-store:
+ filename: <string>
+ password: <string>
+ type: <string>
```
### Server