Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
_

...

Toc485201042
_Toc485201042
MinLog2

Anchor
_Toc485201043
_Toc485201043
Guide til udviklere


Indhold

MinLog2
Guide til udviklere
Indledning
Læsevejledning
Dokumenthistorik
Definitioner og forkortelser
Forudsætninger
Byg
Moduler
Lookup
Core
WS
Ear
Registration
Core
WS
Ear
Shared
Shared-configuration
Shared-core
Shared-test


Anchor
_Toc485201044
_Toc485201044
Indledning

Dette dokument beskriver, hvordan MinLog2-løsningen bygges og hvad de forskellige moduler indeholder.

Dokumentet kan med fordel læses sammen med dokumentet "arkitektur_design" for overordnet forståelse. Desuden henvises der undervejs til "testvejledning" og "installationsvejledning".

Anchor
_

...

Toc485201045
_Toc485201045
Læsevejledning

Læseren forventes at have kendskab til National Sundheds-IT's platform NSP, samt generelt kendskab til WildFly applikation server, MariaDB og java.

...

Anchor
_Toc485201046
_Toc485201046
Dokumenthistorik

Version

Dato

Ansvarlig

Beskrivelse

1.1

12-12-2017

Openminds

Ny borgerservice

1.0

15-06-2017

Openminds

 



Anchor
_

...

Toc485201047
_Toc485201047
Definitioner og forkortelser

Definition

Beskrivelse

NSP

Den nationale service platform (inden for sundheds-IT)

 

 




Anchor
_Toc485201048
_Toc485201048
Forudsætninger

Udover java (JDK 1.8) og WildFly, så kræver MinLog2 2 databaser for at kunne afvikles lokalt

...

MinLog2 databasen kan oprettes via script fra sql/initial_schema.sql fra modulet shared-configuration.

Stamdata databasen kan oprettes via script fra sql/stamdata_tables.sql som dog kun opretter de tabeller som er relevant for MinLog2. Det anbefales at importere et databasedump fra feks. et testmiljø.

Anchor
_Toc485201049
_Toc485201049
Byg

MinLog2 er et standard maven projekt og bygges med


mvn clean install


Helt som det er standard fører det til et byg af alle moduler, herunder ear-filer som indeholder den kode, der skal deployes.

Som en del af bygget afvikles alle unit-tests. Der er ingen af disse unit-tests, der har afhængigheder til netværk, database eller lignende.
Det er muligt at få dannet en projektrapport i targetfolderen – herunder coverage (folderen site) – ved at køre


mvn site
mvn site:stage


Anchor
_Toc485201050
_Toc485201050
Moduler

Der findes 3 undermoduler
├── lookup
│   ├── lookup-core
│   ├── lookup-ear
│   └── lookup-ws
├── registration
│   ├── registration-core
│   ├── registration-ear
│   └── registration-ws
└── shared
├── shared-configuration
├── shared-core
└── shared-test

Anchor
_Toc485201051
_Toc485201051
Lookup

Dette modul håndterer opslag udstillet som webservice og der er overvågningservices til rådighed.

Webservicen er beskrevet i en wsdl fil (contract first) og på baggrund af denne dannes java klasser med CXF.

Lookup-idws

Dette modul håndterer opslag udstillet som webservice og der er overvågningservices til rådighed.

Webservicen er beskrevet i en wsdl fil (contract first) og på baggrund af denne dannes java klasser med CXF. Vær opmærksom på at sikkerhed på denne service er defineret vha. WS-Policy.

Anchor
_Toc485201052
_Toc485201052
Core

Databasekonfiguration er angivet i en persistence unit, der peger på datasource.

Indeholder service (forretningskode) og domain delene.

Anchor
_Toc485201053
_Toc485201053
WS

Indeholder webservice implementeringen.

Anchor
_Toc485201054
_Toc485201054
Ear

Artifaktet som kan deployes til JBoss. Find ear-filen i target/.

Databasekonfiguration er angivet i en persistence unit, der peger på datasource.

Anchor
_Toc485201055
_Toc485201055
Registration

Dette modul håndterer registrering af log hændelser udstillet som webservice, overvågningservices til rådighed.

Webservicen er beskrevet i en wsdl fil (contract first) og på baggrund af denne dannes java klasser med CXF.

Anchor
_Toc485201056
_Toc485201056
Core

Indeholder service (forretningskode) og domain delene.

Databasekonfiguration er angivet i en persistence unit, der peger på datasource. Det skal nævnes at registreringer på nuværende tidspunkt udelukkende foretages direkte til den centrale MinLog2 database.

Anchor
_Toc485201057
_Toc485201057
WS

Indeholder webservice implementeringen.

Anchor
_Toc485201058
_Toc485201058
Ear

Artifaktet som kan deployes til JBoss. Find ear-filen i target/.

Databasekonfiguration er angivet i en persistence unit, der peger på datasource.

Anchor
_Toc485201059
_Toc485201059
Shared

Disse moduler er fælles moduler og ikke nødvendigvis en del af den deployede kode.

Anchor
_Toc485201060
_Toc485201060
Shared-configuration

Dette modul gør det muligt at få dannet de filer, der skal være på JBoss serveren. Indeholder primært filer til opsætning af logning og datasources.

Folderen src/main/environments indeholder miljøspecifik konfiguration af disse filer.

Ved at udpege en af disse, når man bygger, kan man på den måde få danne konfigurationsfiler til et givet miljø.
Eksempel:

Byg til test

Tilret /src/main/environments/test.properties
Kør: mvn clean install –Ptest


Ønsker man at føje yderligere miljøer til, skal man blot lave en propertyfil hørende til miljøet og udpege den i pom.xml.

De genererede filer kan efterfølgende findes i target/classes.

Dokumentet installationsvejledning indeholder yderligere information om brugen af disse.

Anchor
_Toc485201061
_Toc485201061
Shared-core

Fælles kode til blandt andet håndtering af sikkerhed, audit, SLA logning og en del utility klasser.

Anchor
_Toc485201062
_Toc485201062
Shared-test

Dette modul anvendes i forbindelse med afviklingen af integrationtests: Dels kode til dannelse af IDCard (wsse header), dels kode til dannelse og eksekvering af webservicerequests.

Anvendelsen af dette er beskrevet i dokumentet "testvejledning".

Shared-test-idws

Dette modul anvendes i forbindelse med afviklingen af integrationtests: Dels til generering af klient kode og eksekvering af webservicerequests.

Anvendelsen af dette er beskrevet i dokumentet "testvejledning.
.