Package com.avoka.fc.core.stream.consumer

Class KafkaStreamConsumer<T>

java.lang.Object

com.avoka.fc.core.stream.consumer.KafkaStreamConsumer<T>

Type Parameters:

T - the type of data being consumed

All Implemented Interfaces:

IStreamConsumer<T>

public class KafkaStreamConsumer<T>
extends Object
implements IStreamConsumer<T>

Represents a Kafka consumer for reading data from Kafka streams.

Since:

24.4.0

Constructor Summary

Constructors

Constructor	Description
KafkaStreamConsumer(ServiceConnection serviceConnection)	Constructs a KafkaStreamConsumer object.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the consumer.
protected org.apache.kafka.clients.consumer.Consumer<String,T>	getKafkaConsumer(Properties properties)	Retrieves a Kafka consumer instance with the provided properties.
List<String>	listStreams()	Lists the streams available for consumption.
StreamData<T>	poll(Duration duration)	Polls data from the stream.
void	shutdown()	shutdown the consumer.(This method will wake up consumer before closing)
KafkaStreamConsumer<T>	subscribe(String topic)	Subscribes to a single topic.
KafkaStreamConsumer<T>	subscribe(List<String> topics)	Subscribes to multiple topics.
void	wakeup()	Wakes up the consumer to process data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KafkaStreamConsumer

public KafkaStreamConsumer(ServiceConnection serviceConnection)

Constructs a KafkaStreamConsumer object.

Parameters:

serviceConnection - the service connection used for Kafka setup

Method Details

listStreams

public List<String> listStreams()
                         throws StreamWakeupException

Lists the streams available for consumption.

Specified by:

listStreams in interface IStreamConsumer<T>

Returns:

a list of streams

Throws:

StreamWakeupException - If wakeup method be called.

wakeup

public void wakeup()

Wakes up the consumer to process data.

Specified by:

wakeup in interface IStreamConsumer<T>

shutdown

public void shutdown()

shutdown the consumer.(This method will wake up consumer before closing)

Specified by:

shutdown in interface IStreamConsumer<T>

close

public void close()

Close the consumer.

Specified by:

close in interface IStreamConsumer<T>

poll

public StreamData<T> poll(Duration duration)
                   throws StreamWakeupException

Polls data from the stream.

Specified by:

poll in interface IStreamConsumer<T>

Returns:

the data polled from the stream

Throws:

StreamWakeupException - If wakeup method be called.

subscribe

public KafkaStreamConsumer<T> subscribe(String topic)

Subscribes to a single topic.

Specified by:

subscribe in interface IStreamConsumer<T>

Parameters:

topic - the topic to subscribe to

Returns:

the stream consumer instance

subscribe

public KafkaStreamConsumer<T> subscribe(List<String> topics)

Subscribes to multiple topics.

Specified by:

subscribe in interface IStreamConsumer<T>

Parameters:

topics - the list of topics to subscribe to

Returns:

the stream consumer instance

getKafkaConsumer

protected org.apache.kafka.clients.consumer.Consumer<String,T> getKafkaConsumer(Properties properties)

Retrieves a Kafka consumer instance with the provided properties.

Parameters:

properties - the properties for Kafka consumer configuration

Returns:

the Kafka consumer instance