001/*
002 * Copyright (c) 2007-2022 The Cascading Authors. All Rights Reserved.
003 *
004 * Project and contact information: https://cascading.wensel.net/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.local.tap.kafka.commit;
022
023import java.util.Map;
024
025import org.apache.kafka.clients.consumer.Consumer;
026import org.apache.kafka.clients.consumer.OffsetAndMetadata;
027import org.apache.kafka.common.TopicPartition;
028
029/**
030 * CommitListener is a listener that notifies on offset commits and any subsequent failures.
031 */
032public interface CommitListener
033  {
034  default void onClose( Consumer consumer, Map<TopicPartition, OffsetAndMetadata> offsets )
035    {
036    }
037
038  default void onRevoke( Consumer consumer, Map<TopicPartition, OffsetAndMetadata> offsets )
039    {
040    }
041
042  /**
043   * @param exception the caught exception
044   * @param offsets   current partition offsets
045   * @return returns true if the captured exception should be rethrown
046   */
047  default boolean onFail( Consumer consumer, RuntimeException exception, Map<TopicPartition, OffsetAndMetadata> offsets )
048    {
049    return true;
050    }
051  }