1. Indhold

2. Indledning

2.1. Dokumenthistorik

2.2. Formål

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.

2.3. Versionering

Ved nyt release af MinLog2, bumpes minor versionen kun hvis det er nødvendigt for anvendere at opdatere producer biblioteket.

3. Overblik

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:

• Registering af logninger.

Lookup tilbyder services til:

• Forespørgsel på logninger til borger opslag.
• Forespørgsel på logninger til medhjælpslog.

Lookup services findes således i 2 sikkerhedsvarianter

1. DGWS (Den Gode WebService) - til sundhedsfaglige personale
2. OIOIDWS - til borgeren

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.

Af figuren nedenfor fremgår desuden, at MinLogs registreringsservice udstilles på dNSP'erne (foruden på cNSP). Via Kafka flyttes data til cNSP, og skrives i MinLog2-databasen. Fra cNSP udstilles MinLog2 lookup-services til hhv. borgeropslag og til medhjælpsloggen.

4. Snitflader

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.

* Hver kasse i ovenstående diagram har en kort forklaring, som kommer frem i et nyt browservindue, når der klikkes på kassen.

5. Komponenter

Løsningen er designet som en web applikation opdelt i følgende struktur jee bestående af henholdsvis lookup og registration applikationerne, consumer, producer og shared.  

├── service
│   ├── lookup
│   │   ├── lookup-core
│   │   ├── lookup-ear
│   │   ├── lookup-idws
│   │   ├── lookup-minlog1-ws
│   │   └── lookup-ws
│   ├── registration
│   │   ├── registration-core
│   │   ├── registration-war
│   │   ├── registration-minlog1-ws
│   │   └── registration-ws
├── shared
│   ├── shared-configuration
│   ├── shared-db
│   ├── shared-domain-api
│   ├── shared-test
│   ├── shared-test-idws
│   └── shared-ws
├── Consumer      
└── Producer

5.1. Service

Er opdelt i lookup og registration.

Som det fremgår er der flere webservices i modulerne lookup og registration - de deler deres kode i xxxx-core. Modulerne med postfix "-ws" indeholder selve implementeringen af webservicens operationer. Modulerne registration-war og lookup-ear er udelukkende holdere af deployment information samt initialiseringskode til applikationerne.

5.2. Consumer

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. 

5.3. Producer

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

5.4. Shared

Dette modul har forskellige anvendelsesformål. 

5.4.1. Konfiguration

• shared-configuration indeholder DDL og konfigurationer - herunder muligheden for dem generet til specifikke miljøer

Der er ikke kode i denne

5.4.2. Delt kode

• shared-db indeholder kode, der deles mellem komponenter, der indsætter i databasen (consumer og lookup)
• shared-domain-api indeholder objekter, der udveksles via Kafka (registration og consumer)
• shared-ws indeholder kode relateret til adgang, SLA o.lign og benyttes i modulerne, der udstiller webservices (lookup og registration)

Disse komponenter deployes med i consumer, registration og lookup via maven afhængigheder

5.4.3. Delt testkode

• shared-test-xxx modulerne indeholder integrationstests og hjælpeværktøjer - der henvises til Integrationstests. 

Denne kode bliver ikke deployet.

6. Webservice stakken

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)

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:

6.1. Sikkerhed

Sikkerheden er implementeret i 2 varianter DGWS og OIOIDWS.

I begge tilfælde anvendes det af platformen tilbudte Security API til at tjekke indkommende credentials og restriktioner i forhold til medsendte oplysninger i sikkerhedsbilletter.

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.

7. Statuskomponent

7.1. Monitorering

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.

7.2. Versionsinfo

En servlet, der fortælle hvilken version af løsningen, der er den aktuelle.

8. Arkitektur lag

Der er fortaget en traditionel lagdeling af løsningen:

8.1. Webservice

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).

8.2. Controller

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.

8.3. Domain

For Lookup Indeholder domain, JPA klasser til persistering. I Registration er det POJO's.

8.4. Data lag

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.

9. Databasedesign

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.

* Hver kasse i ovenstående diagram har en kort forklaring, som kommer frem i et nyt browservindue, når der klikkes på kassen.

10. Ikke funktionelle krav

10.1. Sikkerhed

Løsningen er sikret med det af platfomen udbudte Security API.

10.2. SLA logning

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.

10.3. Audit logning

Ved alle kald registreres

• Information om kalder
• Den kaldte metode.
• De medsendte parametre i json format.

Auditloggen gemmes i en tekstfil, og dens udseende kan konfigureres.