io.github.eocqrs.kafka.Consumer Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (c) 2022 Aliaksei Bialiauski, EO-CQRS
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.github.eocqrs.kafka;

import org.apache.kafka.clients.consumer.ConsumerRebalanceListener;
import org.apache.kafka.clients.consumer.ConsumerRecords;

import java.io.Closeable;
import java.time.Duration;
import java.util.Collection;

/**
 * Consumer.
 *
 * @param  The key
 * @param  The value
 * @author Ivan Ivanchuck ([email protected])
 * @author Aliaksei Bialiauski ([email protected])
 * @since 0.0.0
 */
public interface Consumer extends Closeable {

  /**
   * Subscribe.
   *
   * @param topics topics to subscribe
   */
  void subscribe(String... topics);

  /**
   * Subscribe.
   *
   * @param topics topics to subscribe
   */
  void subscribe(Collection topics);

  /**
   * Subscribe.
   *
   * @param listener rebalance listener
   * @param topics   topics to subscribe
   */
  void subscribe(ConsumerRebalanceListener listener, String... topics);

  /**
   * Fetch Records.
   *
   * @param topic   topic to poll
   * @param timeout max time to wait
   * @return Records.
   * @throws Exception When something went wrong.
   */
  ConsumerRecords records(String topic, Duration timeout)
    throws Exception;

  /**
   * Unsubscribe.
   *
   * @throws Exception When something went wrong.
   */
  void unsubscribe() throws Exception;
}