org.thales.punch.kafka.api

Interface IKafkaSettingsMapConsumer

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

KafkaAdminConsumer

public interface IKafkaSettingsMapConsumer
extends AutoCloseable

The IKafkaSettingsMapConsumer is your main interface to read the latest settings map record from a punch admin topic or assignement topic. Refer to the KafkaContinuousConsumerBuilder class to create and configure your consumer.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
org.thales.punch.settings.api.ISettingsMap	readLatestSettingsMap(Duration timeout) Read the latest json settings map from a topic.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

readLatestSettingsMap

org.thales.punch.settings.api.ISettingsMap readLatestSettingsMap(Duration timeout)
                                                          throws TimeoutException

Read the latest json settings map from a topic.

Note that the record key is not checked. This API is called for reading the admin topic used to store the channel statuses, or the assignement topic.

Parameters:

timeout - how much time you accept to wait

Returns:

the latest settings map, possibly empty if no record is found in the topic

Throws:

TimeoutException - if you hang