/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* http://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 org.apache.kafka.clients.consumer;
import org.apache.kafka.common.Metric;
import org.apache.kafka.common.MetricName;
import org.apache.kafka.common.PartitionInfo;
import org.apache.kafka.common.TopicPartition;
import java.io.Closeable;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.regex.Pattern;
/**
* @see KafkaConsumer
* @see MockConsumer
*/
public interface Consumer<K, V> extends Closeable {
/**
* @see KafkaConsumer#assignment()
*/
public Set<TopicPartition> assignment();
/**
* @see KafkaConsumer#subscription()
*/
public Set<String> subscription();
/**
* @see KafkaConsumer#subscribe(Collection)
*/
public void subscribe(Collection<String> topics);
/**
* @see KafkaConsumer#subscribe(Collection, ConsumerRebalanceListener)
*/
public void subscribe(Collection<String> topics, ConsumerRebalanceListener callback);
/**
* @see KafkaConsumer#assign(Collection)
*/
public void assign(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#subscribe(Pattern, ConsumerRebalanceListener)
*/
public void subscribe(Pattern pattern, ConsumerRebalanceListener callback);
/**
* @see KafkaConsumer#unsubscribe()
*/
public void unsubscribe();
/**
* @see KafkaConsumer#poll(long)
*/
public ConsumerRecords<K, V> poll(long timeout);
/**
* @see KafkaConsumer#commitSync()
*/
public void commitSync();
/**
* @see KafkaConsumer#commitSync(Map)
*/
public void commitSync(Map<TopicPartition, OffsetAndMetadata> offsets);
/**
* @see KafkaConsumer#commitAsync()
*/
public void commitAsync();
/**
* @see KafkaConsumer#commitAsync(OffsetCommitCallback)
*/
public void commitAsync(OffsetCommitCallback callback);
/**
* @see KafkaConsumer#commitAsync(Map, OffsetCommitCallback)
*/
public void commitAsync(Map<TopicPartition, OffsetAndMetadata> offsets, OffsetCommitCallback callback);
/**
* @see KafkaConsumer#seek(TopicPartition, long)
*/
public void seek(TopicPartition partition, long offset);
/**
* @see KafkaConsumer#seekToBeginning(Collection)
*/
public void seekToBeginning(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#seekToEnd(Collection)
*/
public void seekToEnd(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#position(TopicPartition)
*/
public long position(TopicPartition partition);
/**
* @see KafkaConsumer#committed(TopicPartition)
*/
public OffsetAndMetadata committed(TopicPartition partition);
/**
* @see KafkaConsumer#metrics()
*/
public Map<MetricName, ? extends Metric> metrics();
/**
* @see KafkaConsumer#partitionsFor(String)
*/
public List<PartitionInfo> partitionsFor(String topic);
/**
* @see KafkaConsumer#listTopics()
*/
public Map<String, List<PartitionInfo>> listTopics();
/**
* @see KafkaConsumer#paused()
*/
public Set<TopicPartition> paused();
/**
* @see KafkaConsumer#pause(Collection)
*/
public void pause(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#resume(Collection)
*/
public void resume(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#offsetsForTimes(java.util.Map)
*/
public Map<TopicPartition, OffsetAndTimestamp> offsetsForTimes(Map<TopicPartition, Long> timestampsToSearch);
/**
* @see KafkaConsumer#beginningOffsets(java.util.Collection)
*/
public Map<TopicPartition, Long> beginningOffsets(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#endOffsets(java.util.Collection)
*/
public Map<TopicPartition, Long> endOffsets(Collection<TopicPartition> partitions);
/**
* @see KafkaConsumer#close()
*/
public void close();
/**
* @see KafkaConsumer#close(long, TimeUnit)
*/
public void close(long timeout, TimeUnit unit);
/**
* @see KafkaConsumer#wakeup()
*/
public void wakeup();
}