io.micronaut.configuration.kafka

Interface ConsumerRegistry

All Known Implementing Classes:

KafkaConsumerProcessor

public interface ConsumerRegistry

A registry for created Kafka consumers. Also provides methods for pausing and resuming consumers.

Since:

1.1

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
<K,V> org.apache.kafka.clients.consumer.Consumer<K,V>	getConsumer(java.lang.String id) Returns a managed Consumer.
java.util.Set<java.lang.String>	getConsumerIds() The IDs of the available consumers.
boolean	isPaused(java.lang.String id) Is the consumer with the given ID paused.
void	pause(java.lang.String id) Pause the consumer for the given ID.
void	resume(java.lang.String id) Resume the consumer for the given ID.

Method Detail

getConsumer

@Nonnull
<K,V> org.apache.kafka.clients.consumer.Consumer<K,V> getConsumer(@Nonnull
                                                                           java.lang.String id)

Returns a managed Consumer. Note that the consumer should not be interacted with directly from a different thread to the poll loop!

Type Parameters:

K - The key generic type

V - The value generic type

Parameters:

id - The id of the producer.

Returns:

The producer

Throws:

java.lang.IllegalArgumentException - If no consumer exists for the given ID

getConsumerIds

@Nonnull
java.util.Set<java.lang.String> getConsumerIds()

The IDs of the available consumers.

Returns:

The consumers

isPaused

boolean isPaused(@Nonnull
                 java.lang.String id)

Is the consumer with the given ID paused.

Parameters:

id - True it is paused

Returns:

True if it is paused

pause

void pause(@Nonnull
           java.lang.String id)

Pause the consumer for the given ID. Note that this method will request that the consumer is paused, however does not block until the consumer is actually paused. You can use the isPaused(String) method to establish when the consumer has actually been paused.

Parameters:

id - The id of the consumer

resume

void resume(@Nonnull
            java.lang.String id)

Resume the consumer for the given ID. Note that this method will request that the consumer is resumed, however does not block until the consumer is actually resumed. You can use the isPaused(String) method to establish when the consumer has actually been resumed.

Parameters:

id - The id of the consumer