io.micronaut.configuration.kafka.ConsumerAware Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-kafka Show documentation

Integration between Micronaut and Kafka Messaging

There is a newer version: 5.7.0

/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.configuration.kafka;

import org.apache.kafka.clients.consumer.Consumer;
import io.micronaut.core.annotation.NonNull;

/**
 * Interface for {@link io.micronaut.configuration.kafka.annotation.KafkaListener} instances to implement
 * if they wish to obtain a reference to the underlying {@link Consumer}.
 * 
 * Modification of received {@link Consumer} instances (e.g. modifying subscriptions) is possible ONLY
 * when run by the Thread driving KafkaConsumer's poll loop! Otherwise you will receive {@link
 * java.util.ConcurrentModificationException}, cause KafkaConsumer instances are not safe for
 * multi-threaded access!
 *
 * @param  The key type
 * @param  The value type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface ConsumerAware {
    /**
     * Called when the underlying {@link Consumer} is created.
     *
     * @param consumer The consumer
     */
    void setKafkaConsumer(@NonNull Consumer consumer);
}