Version | Dato | Ansvarlig | Beskrivelse |
| 1.3 | 11-10-2019 | Openminds | Opdatering som følge af ændringer til MinLog2 |
| 1.2 | 07-09-2018 | Openminds | Specificering af OIOIDWS service |
1.1 | 12-12-2017 | Openminds | Ny borgerservice |
1.0 | 14-06-2017 | Openminds |
Dette dokument giver et overblik over MinLog2 applikationerne med fokus på design og arkitektur.
Dokumentet giver et overblik over løsningens snitflader samt den interne struktur. Desuden indeholder det en beskrivelse af håndtering af ikke funktionelle krav.
Ved nyt release af MinLog2, bumpes minor versionen kun hvis det er nødvendigt for anvendere at opdatere producer biblioteket.
MinLog2 er primært delt i to dele, Registration og Lookup. Hver del indeholder SOAP baserede webservices der håndterer sikkerhed og mapning til/fra databasen.
Registration tilbyder services til:
Lookup tilbyder services til:
Nedenfor vises den overordnede arkitektur. En sundhedsfaglig person anvender en løsning som foretager en registrering i MinLog2. Data valideres og formateres for at blive afleveret til et Kafka cluster. En eller flere MinLog2 consumere læser fra Kafka og indsætter i databasen. Borgeren anvender feks. sundhed.dk til at se egen log og det gøres via forespørgsler til Lookup der læser fra databasen.
Lookup services findes i 2 sikkerhedsvarianter
MinLog2 løsningen håndterer både MinLog2 og MinLog1 formaterne.
Snitfladerne for MinLog2 beskrives i detaljer i dokumenterne "Guide til anvendere" - Registration skema beskrivelse og Lookup skema beskrivelse. Der er også her man finder links til WSDL filer. Vedrørende snitfladerne til MinLog1 så henvises der til dokumenterne som findes i svn - https://svn.nspop.dk/public/components/minlog-reg/latest/doc/ og https://svn.nspop.dk/public/components/minlog-ws/latest/doc/.
Der henvises til de respektive moduler mht. detaljer omkring wsdl'er og fejlbeskeder.
Udover MinLog2's egen database, er løsningen afhængig af stamdatamodulets databaser, til berigelse af logdata ved Lookup. Principperne for anvendelse af stamdata fra stamdatamodulet afviges dermed, idet der ikke anvendes enkeltopslags- services eller kopiregisterservices. Dette er dog accepteret i MinLog 2-sammenhæng.
Løsningen er designet som en web applikation opdelt i 4 jee, consumer, producer og shared.
├── jee
│ ├── lookup
│ │ ├── lookup-core
│ │ ├── lookup-ear
│ │ ├── lookup-idws
│ │ ├── lookup-minlog1-ws
│ │ └── lookup-ws
│ ├── registration
│ │ ├── registration-core
│ │ ├── registration-ear
│ │ ├── registration-minlog1-ws
│ │ └── registration-ws
├── shared
│ ├── shared-configuration
│ ├── shared-db
│ ├── shared-domain-api
│ ├── shared-test
│ ├── shared-test-idws
│ └── shared-ws
├── Consumer
└── Producer
Er opdelt i lookup og registration.
Som det fremgår er der flere webservices i modulerne lookup og regstration - de deler deres kode i xxxx-core. Modulerne med postfix "-ws" indeholder selve implementeringen af webservicens operationer. Ear modulerne er udelukkende holdere af deployment information.
Consumer modulet lytter på et kafka topic efter entries til MinLog2 og ved modtagelse indsættes de i databasen. Koden har taget udgangspunkt i Den Gode Brug af Kafka og følger dennes retningslinier.
Producer har tidligere være et selvstændigt modul, men er nu en del af MinLog2. Dokumentation for dette modul findes her: https://www.nspop.dk/display/public/web/MinLogProvider+-+Leverancebeskrivelse
Dette modul har forskellige anvendelsesformål.
Der er ikke kode i denne
Disse komponenter deployes med i consumer, registration og lookup via maven afhængigheder
shared-test-xxx modulerne indeholder integrationstests og hjælpeværktøjer - der henvises til Integrationstests.
Denne kode bliver ikke deployet.
Der er anvendt Apache CXF som webservice stak. Udgangspunktet er WSDL filer - som vha. maven danner klasser hvorfra MinLog2 implementeringerne arver fra:
dk.nsi.minlog2.registration.webservice.RegisterServiceImpl implements RegisterservicePort
dk.nsi.minlog2.registration.webservice.RegisterServiceImpl implements Service (Minlog1)
dk.nsi.minlog2.lookupid.LookupidImpl implements LookupidServicePortType
dk.nsi.minlog2.lookup.webservice.LookupServiceImpl implements LookupServicePort
dk.nsi.minlog2.lookup.webservice.LookupServiceImpl implements Minlog (Minlog1)
Funktionalitet udover SOAP protokol håndteringen er lavet som Handlers/Interceptor - feks special håndtering af headers, sla-logning, audit-logning mm. I forbindelse med deployment skal man være opmærksom på at subsystemerne i Jboss Wildfly til logning og webservices er slået fra - for at opnår den fulde kontrol over stakken.
Nedenfor ses en sekvens diagram over registreringsdelen.
Og opslagsdelen:
Sikkerheden er implementeret i 2 varianter DGWS og OIOIDWS.
IDCard læses fra SOAPHeader og sættes det på threadlocal. Kan kortet ikke læses, eller er signaturen ugyldig afvises brugeren.
I svaret tilføjes en WSSecurity header med et timestamp.
På vej ind gemmes Medcom header på Threadlocal. På vej ud tilføjes Medcom header baseret på den indkomne.
IDCard fra Threadlocal og autentificerer kalderen ved at kontrollere, at kortet er gyldigt og ikke udløbet.
Herefter autoriseres brugeren, idet det verificeres, at denne har det fornødne niveau (medarbejder eller virksomhed). Bemærk at der efter aftale ikke er gjort brug af whitelisting på det udstillede services.
Sikkerheden omkring signering varetages af indgående og udgående CXF interceptorer.
Den indgående interceptor foretager:
Data gemmes på threadlocal.
Den udgående interceptor foretager:
Autenficering af brugeren er foretages premature af STS. Bemærk at der efter aftale ikke er gjort brug af whitelisting på det udstillede services. Vær opmærksom på at whitelisting heller ikke er implementeret for MinLog1.
En simpel servlet, der returnerer ok (http kode 200), hvis systemet er tilgængeligt. Desuden er det muligt at få detaljer om, hvilke komponenter, der er i live eller fejler.
En servlet, der fortælle hvilken version af løsningen, der er den aktuelle.
Der er fortaget en traditionel lagdeling af løsningen:
Dette lag indeholder kode som interceptorer til håndtering af audit- og slalogning - hvis er kode relateret til sikkerhed som ikke håndteres af webservicestakken, skemavalidering af data (hvor det giver mening).
Laget modtager kald fra webservicelaget og delegerer til andre klasser, der hver især håndterer hhv. validering, caching, groupering samt håndtering af persistens.
For Lookup Indeholder domain, JPA klasser til persistering. I Registration er det POJO's.
Indeholder logikken til insert af data fra Registration samt forespørgsel fra Lookup.
Registration afleverer data til Kafka igennem NSP komponenterne.
Lookup og Consumer, bruger JPA dels til forbindelsen, men også mapning til domain. Dog er alle queries defineret som rå SQL, i koden, således at intet bliver autogeneret. Dette er gjort for at imødekomme tidligere erfaringer på platformen, om at autogeneret SQL fra JPA kan blive unødig kompleks og forringe performance.
Afhængigheder mellem komponenter.
Log events, består af to primærer tabeller. source og logentry. Logentry indeholder alt information om logningen, mens source er kaldekæden gennem systemerne. Se Løsningsbeskrivelsen for nærmere beskrivelse. Disse gemmes i hver sin tabel. Database layout, herunder default værdier for felter kan ses i filen "shared/shared-configuration/src/main/resources/sql/initial_schema.sql".
For at forhindre at der kan forekomme dublikater ved insert, laves der en SHA256 hash over en række værdier, af databasen.
Løsningen er sikret med IDCard, der enten kan repræsentere en person eller en myndighed. I tilfælde af Lookupid anvendes OIOIDWS.
Ved hver enkelt servicekald verificeres det, at kalderen har den fornødne rolle (myndighed eller medarbejder), og at det medfølgende IDCard overholder levetidskravet til det konkrete kald.
Der logges med brug af NSPUtils biblioteket: Et filter opretter en log entitet, der senere beriges med messageID fra Medcom headeren. Logning foretages gennem NSP-Util og følger retningslinier herfor.
Ved alle kald registreres
Auditloggen gemmes i en tekstfil, og dens udseende kan konfigureres.