Versions Compared

Key

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

...

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.

MetodesignaturBeskrivelse
void init(String topic, Properties kafkaProperties)

Denne metode skal kaldes inden man kalder andre metoder.
Hvis man ikke gør dette, får man en exception. Første argument (topic) er det Kafka topic, der skal anvendes. De properties, der skal angives som argument (kafkaProperties), er dem, der kan anvendes til at konfigurere en KafkaProducer.

RegistrationResult addRegistrations(List<LogEntry> logEntries)

Denne metode kaldes for at registrere i MinLog.
Argumentet indeholder en liste af LogEntry objekter, som repræsenterer de data, der skal registreres i MinLog. RegistrationResult er resultatet af registreringen.

void flush()

Sørger for at kalde flush() på KafkaProducer.
Metoden skal kaldes

hvor

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.

MetodesignaturBeskrivelse
Properties fitlerProperties(String prefix, Properties kafkaProperties)Denne metode kan anvendes til at filtrere kafkaProperties
  så
, så der kun returneres de properties, der matcher det prefix
  der
, 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.

...