Versions Compared

Key

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

...

Dernæst vises hvordan NSP Audit API rent praktisk indføres i en NSP komponent med konkrete eksempler på anvendelse. I dette afsnit gives også input til, hvordan en NSP komponent bør dokumentere sin anvendelse af NSP Audit API.  

Arkitekturoverblik og motivation for NSP Audit API

Auditlogning er en capability, som er nødvendig for mange af NSP'ens komponenter: Af juridiske hensyn er det nødvendigt at kunne følge op på hvem, der har gjort hvad og hvornår henover NSP'ens service portefølje.

Det giver mening at auditloggen opsamles og gemmes centralt henover alle NSP'ens komponenter, idet beskaffenheden af disse logs stiller særlige krav til opbevaring og håndtering.

Kravene til indholdet af auditloggen er sammenfaldende henover NSP'ens services i forhold til information om hvornår og hvem, der har lavet en handling, som er auditlogget.

Hvad der skal auditlogges er i høj grad op til den enkelte NSP komponent og de forretningsmæssige og juridiske krav, der omgiver denne.

Ensartetheden i forhold til granularitet og format for audit informationer vil lette det efterfølgende arbejde med disse - både i forhold til opfølgning og anvendelse og i forhold til den generelle håndtering og opbevaring.

NSP Audit API er født ud af ønsket om:

  1. At gøre det let for NSP komponenter at auditlogge
  2. At sørge for at informationsniveauet er ensartet henover de forskellige komponenter
  3. At sørge for at strukturen er ensartet henover de forskellige komponenter

NSP Audit API stiller rammer og funktioner til rådighed for NSP komponenterne, så de bliver i stand til at løse problemet omkring audit logning.

Gliffy Diagram
size600
displayNameNSP Audit API overview
nameNSP Audit API overview
pagePin3
NSP A


Anvendelse af NSP Audit API

For at anvende NSP Audit API i en konkret NSP komponent, så er der et par tekniske øvelser, der skal være på plads. Da hovedparten af NSPens NSP'ens komponenter er bygget op på samme måde, så vil denne vejledning umiddelbart kunne anvendes i langt de fleste tilfælde. Antagelsen i denne vejledning er derfor at:

  • Komponenten anvender Maven til styring af tredjeparts dependencies
  • Komponenten afvikles på Wildfly (evt via et af NSP'ens Docker images)

...

Dernæst vises det med et praktisk eksempel hentet fra Dokumentdelingsservicen, hvordan NSP Audit API kan anvendes i koden til at implementere audit logning.

Det demonstreres gennem eksemplet fra Dokumentdelingsservice, hvorledes anvendelsen af NSP Audit API kommer til udtryk i forhold til informationsniveau i den resulterende auditlog. Herigennem bliver det muligt for udviklere af NSP komponenter at forstå, hvilke informationer, der stammer fra afviklingsplatformen, og hvilke der stammer fra komponenten selv.

Tilsidst inkluderes en "dokumentationsskabelon", der kan anvendes som input til de konkrete driftsmanualer for de NSP komponenter, der anvender NSP Audit API.

Maven dependency

Langt de fleste NSP komponenter anvender Maven til at holde styr på afhængigheder til tredjeparts biblioteker.

...