Versions Compared

Key

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

...

I ovenstående eksempel er det NSP Audit API version 1.0.1, der stilles til rådighed af Wildfly, hvilket hænger fint sammen med det versionsnummer, der blev udtrykt i Maven afhængigheden (i pom.xml).

Integration i koden

Når en komponent har fået sat afhængighed op til NSP Audit API, er den klar til at begynde at anvende dette til auditlogning.

Anvendelse af NSP Audit API er meget simpel. For hver request som komponenten modtager skal følgende linie kaldes:

...

Dette opretter en Audit Builder som kan føres med rundt i komponenten og kaldes hver gang audit information i forbindelse med kaldet opstår.

Warning

Det er vigtigt at denne linie udføres på den samme tråd som kalder komponentens Servlet metoder, annoterede WebMethod metoder eller lign.

Dette sikrer at platformen kan koble builderen sammen med det request/response der er i gang.

...

Fordi builderen er koblet sammen med platformens håndtering af request/response, er der ikke brug for at komponenten kalder en commit metode eller lign.

Der er derfor ikke mere arbejde end at oprette builderen og kalde en af de fire metoder for hver audit information der skal logges.

...

Når man kalder createAuditBuilder metoden i NSP Audit API'et anvender denne Java Service Loader systemet til at finde en NSP Audit Provider. På en driftet NSP platform

Når komponenten afvikles i drift på NSP platformen, vil der være en provider tilgængelig som rent faktisk står for at logge audit informationerne for hvert request. Det er driftens ansvar at sørge for, at dette sker

Under udvikling er det dog stadig muligt at bruge NSP Audit API idet den indeholder en fallback development provider. Denne provider skriver en advarsel til stderr om at den ikke må bruges i et driftet NSP miljø, men foretager sig ellers ikke noget pr. default. Hvis man sætter følgende system property vil den skrive hver audit information ud på stdout som et JSON objekt:

...