org.springframework.kafka.support.Acknowledgment Maven / Gradle / Ivy
/*
* Copyright 2015-2019 the original author or 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 org.springframework.kafka.support;
/**
* Handle for acknowledging the processing of a
* {@link org.apache.kafka.clients.consumer.ConsumerRecord}. Recipients can store the
* reference in asynchronous scenarios, but the internal state should be assumed transient
* (i.e. it cannot be serialized and deserialized later)
*
* @author Marius Bogoevici
* @author Gary Russell
*/
public interface Acknowledgment {
/**
* Invoked when the record or batch for which the acknowledgment has been created has
* been processed. Calling this method implies that all the previous messages in the
* partition have been processed already.
*/
void acknowledge();
/**
* Negatively acknowledge the current record - discard remaining records from the poll
* and re-seek all partitions so that this record will be redelivered after the sleep
* time. Must be called on the consumer thread.
*
* When using group management,
* {@code sleep + time spent processing the previous messages from the poll} must be
* less than the consumer {@code max.poll.interval.ms} property, to avoid a
* rebalance.
* @param sleep the time to sleep.
* @since 2.3
*/
default void nack(long sleep) {
throw new UnsupportedOperationException("nack(sleep) is not supported by this Acknowledgment");
}
/**
* Negatively acknowledge the record at an index in a batch - commit the offset(s) of
* records before the index and re-seek the partitions so that the record at the index
* and subsequent records will be redelivered after the sleep time. Must be called on
* the consumer thread.
*
* When using group management,
* {@code sleep + time spent processing the records before the index} must be less
* than the consumer {@code max.poll.interval.ms} property, to avoid a rebalance.
* @param index the index of the failed record in the batch.
* @param sleep the time to sleep.
* @since 2.3
*/
default void nack(int index, long sleep) {
throw new UnsupportedOperationException("nack(index, sleep) is not supported by this Acknowledgment");
}
}