diff --git a/_pages/migration/migration-5.0.md b/_pages/migration/migration-5.0.md index d8e3b674..8b5af6e4 100644 --- a/_pages/migration/migration-5.0.md +++ b/_pages/migration/migration-5.0.md @@ -7,16 +7,44 @@ toc_icon: align-left toc_sticky: true --- -IPF 5.0 comes with some changes that should be considered when upgrading from earlier IPF versions +IPF 5.0 comes with some changes that should be considered when upgrading from earlier IPF versions. -## Renamed Classes and Modules +## Changes in ATNA audit dataset enrichment -* Interface `org.openehealth.ipf.commons.ihe.ws.cxf.audit.XuaProcessor` was renamed to - `org.openehealth.ipf.commons.ihe.ws.cxf.audit.WsAuditDatasetEnricher`, because this - mechanism can be used for all types of Web Service audit dataset enrichment and not - only for extracting data from XUA tokens. +Older IPF versions contained the module `ipf-commons-ihe-xua` which provided routines to propagate +particular elements of XUA authorization assertions into ATNA audit datasets. In IPF 5.0, this +module is not present anymore. Instead, a concept of a "Web Service audit dataset enricher" +is introduced. -* Module `ipf-commons-ihe-xua` (containing an implementation of the aforementioned interface) - was renamed to `ipf-commons-ihe-swissepr`, because its functionalities relate not only - to extracting data from XUA tokens and are specific for the Swiss EPR. +IPF provides two enricher implementations out of the box: +* `org.openehealth.ipf.commons.ihe.ws.cxf.audit.XuaWsAuditDatasetEnricher` — fulfills requirements + of the IHE [XUA](https://profiles.ihe.net/ITI/TF/Volume2/ITI-40.html) profile. +* `org.openehealth.ipf.commons.ihe.ws.cxf.audit.SwissEprWsAuditDatasetEnricher` — fulfills both IHE XUA + requirements and the requirements of the + [Swiss Electronic Patient Record](https://www.e-health-suisse.ch/en/technique/technical-interoperability/specifications-for-the-epr-implementation). +A Web Service audit dataset enricher can be configured in an Audit Context +by providing a Spring bean of the type `org.openehealth.ipf.commons.ihe.ws.cxf.audit.WsAuditDatasetEnricher`, +or by specifying an enricher's class name in the corresponding Spring Boot configuration property. + +Example for Spring context XML configuration: +```xml + + + + + + + + +``` + +Example for Spring Boot YAML configuration: +```YAML +ipf: + atna: + audit-enabled: true + audit-queue-class: my.project.atna.DevNullMessageQueue + audit-source-id: ipfapp + ws-audit-dataset-enricher-class: org.openehealth.ipf.commons.ihe.ws.cxf.audit.SwissEprWsAuditDatasetEnricher +``` \ No newline at end of file