Page History
| Table of Contents |
|---|
Indledning
Det primære formål med MinLogProducer biblioteket er at udstille et Java-API som NSP komponenter kan anvende til at lave MinLog2 registreringer via. Dette dokument beskriver tilgængelighed af modulet samt anvendelse.
...
Dette bibliotek indeholder api og interface definitioner samt ServiceLoader implementeret i form af klassen RegisterServiceProvider. Det er det eneste bibliotek der er brug for at inkludere i sit projekt.
POM groupId: dk.nsp.minlog
POM artifactId: minlog-producer-api
Wildfly modul navn: dk.nsp.minlog.producer.api
Eksempel på inkludering i pom.xml
...
Dette bibliotek indeholder implementering af interface defineret i minlog-producer-api biblioteket.
POM groupId: dk.nsp.minlog
POM artifactId: minlog-producer-registration
Wildfly modul navn: dk.nsp.minlog.producer
Eksempel på inkludering i pom.xml
...
Når man har anvendt RegisterServiceProvider til at få en implementering af RegisterService er der 4 metoder man kan kalde.
| Metodesignatur | Beskrivelse |
|---|---|
void init(String topic, Properties kafkaProperties) | Denne metode skal kaldes inden man kalder andre metoder. |
RegistrationResult addRegistrations(List<LogEntry> logEntries) | Denne metode kaldes for at registrere i MinLog. |
void flush() | Sørger for at kalde flush() på KafkaProducer. |
hver gang, man vil sikre sig at kald til addRegistrations() er persisteret i Kafka. | |
void close() | Kaldes når servicen ikke længere skal bruges. Sørger for pænt at lukke forbindelsen til Kafka osv. |
PropertyFilter
Lille hjælper klasse, man kan anvende til at filtrere properties, så de kan anvendes til init metoden i RegisterService.
| Metodesignatur | Beskrivelse |
|---|---|
Properties fitlerProperties(String prefix, Properties kafkaProperties) | Denne metode kan anvendes til at filtrere kafkaProperties |
| , så der kun returneres de properties, der matcher det prefix |
| , der er angivet. Prefix er fjernet fra properties, der returneres. |
LogEntry
Dette svarer til et LogDataEntry element i https://www.nspop.dk/display/public/web/MinLog2+-+Min+Log+Registrering+-+Guide+til+anvendere#MinLog2MinLogRegistreringGuidetilanvendere-Request og der henvises derfor til dette dokument.
...
Dette svarer til et Destination element i https://www.nspop.dk/display/public/web/MinLog2+-+Min+Log+Registrering+-+Guide+til+anvendere#MinLog2MinLogRegistreringGuidetilanvendere-Request og der henvises derfor til dette dokuemntdokument.
For OrganisationIdSrc anbefales det at anvende den set metode der tager en enum som argument, hvis dette er muligt.
Eksempel
Nedenstående er et eksempel på hvordan man anvender biblioteket.
...