content: /*
   * 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.common.requests;
  
  import org.apache.kafka.common.TopicPartition;
  import org.apache.kafka.common.Uuid;
  import org.apache.kafka.common.message.OffsetCommitResponseData;
  import org.apache.kafka.common.message.OffsetCommitResponseData.OffsetCommitResponsePartition;
  import org.apache.kafka.common.message.OffsetCommitResponseData.OffsetCommitResponseTopic;
  import org.apache.kafka.common.protocol.ApiKeys;
  import org.apache.kafka.common.protocol.Errors;
  import org.apache.kafka.common.protocol.Readable;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  import java.util.function.Function;
  
  /**
   * Possible error codes:
   *
   *   - {@link Errors#UNKNOWN_TOPIC_OR_PARTITION}
   *   - {@link Errors#REQUEST_TIMED_OUT}
   *   - {@link Errors#OFFSET_METADATA_TOO_LARGE}
   *   - {@link Errors#COORDINATOR_LOAD_IN_PROGRESS}
   *   - {@link Errors#COORDINATOR_NOT_AVAILABLE}
   *   - {@link Errors#NOT_COORDINATOR}
   *   - {@link Errors#ILLEGAL_GENERATION}
   *   - {@link Errors#UNKNOWN_MEMBER_ID}
   *   - {@link Errors#REBALANCE_IN_PROGRESS}
   *   - {@link Errors#INVALID_COMMIT_OFFSET_SIZE}
   *   - {@link Errors#TOPIC_AUTHORIZATION_FAILED}
   *   - {@link Errors#GROUP_AUTHORIZATION_FAILED}
   *   - {@link Errors#INVALID_PRODUCER_ID_MAPPING}
   *   - {@link Errors#INVALID_TXN_STATE}
   *   - {@link Errors#GROUP_ID_NOT_FOUND}
   *   - {@link Errors#STALE_MEMBER_EPOCH}
   */
  public class OffsetCommitResponse extends AbstractResponse {
  
      private final OffsetCommitResponseData data;
  
      public OffsetCommitResponse(OffsetCommitResponseData data) {
          super(ApiKeys.OFFSET_COMMIT);
          this.data = data;
      }
  
      public OffsetCommitResponse(int requestThrottleMs, Map<TopicPartition, Errors> responseData) {
          super(ApiKeys.OFFSET_COMMIT);
          Map<String, OffsetCommitResponseTopic>
                  responseTopicDataMap = new HashMap<>();
  
          for (Map.Entry<TopicPartition, Errors> entry : responseData.entrySet()) {
              TopicPartition topicPartition = entry.getKey();
              String topicName = topicPartition.topic();
  
              OffsetCommitResponseTopic topic = responseTopicDataMap.getOrDefault(
                  topicName, new OffsetCommitResponseTopic().setName(topicName));
  
              topic.partitions().add(new OffsetCommitResponsePartition()
                                         .setErrorCode(entry.getValue().code())
                                         .setPartitionIndex(topicPartition.partition()));
              responseTopicDataMap.put(topicName, topic);
          }
  
          data = new OffsetCommitResponseData()
                  .setTopics(new ArrayList<>(responseTopicDataMap.values()))
                  .setThrottleTimeMs(requestThrottleMs);
      }
  
      public OffsetCommitResponse(Map<TopicPartition, Errors> responseData) {
          this(DEFAULT_THROTTLE_TIME, responseData);
      }
  
      @Override
      public OffsetCommitResponseData data() {
          return data;
      }
  
      @Override
      public Map<Errors, Integer> errorCounts() {
          return errorCounts(data.topics().stream().flatMap(topicResult ->
                  topicResult.partitions().stream().map(partitionResult ->
                          Errors.forCode(partitionResult.errorCode()))));
      }
  
      public static OffsetCommitResponse parse(Readable readable, short version) {
          return new OffsetCommitResponse(new OffsetCommitResponseData(readable, version));
      }
  
      @Override
      public String toString() {
          return data.toString();
      }
  
      @Override
      public int throttleTimeMs() {
          return data.throttleTimeMs();
      }
  
      @Override
      public void maybeSetThrottleTimeMs(int throttleTimeMs) {
          data.setThrottleTimeMs(throttleTimeMs);
      }
  
      @Override
      public boolean shouldClientThrottle(short version) {
          return version >= 4;
      }
  
      public static boolean useTopicIds(short version) {
          return version >= 10;
      }
  
      public static Builder newBuilder(boolean useTopicIds) {
          if (useTopicIds) {
              return new TopicIdBuilder();
          } else {
              return new TopicNameBuilder();
          }
      }
  
      public abstract static class Builder {
          protected OffsetCommitResponseData data = new OffsetCommitResponseData();
  
          protected abstract void add(
              OffsetCommitResponseTopic topic
          );
  
          protected abstract OffsetCommitResponseTopic get(
              Uuid topicId,
              String topicName
          );
  
          protected abstract OffsetCommitResponseTopic getOrCreate(
              Uuid topicId,
              String topicName
          );
  
          public Builder addPartition(
              Uuid topicId,
              String topicName,
              int partitionIndex,
              Errors error
          ) {
              final OffsetCommitResponseTopic topicResponse = getOrCreate(topicId, topicName);
              topicResponse.partitions().add(new OffsetCommitResponsePartition()
                  .setPartitionIndex(partitionIndex)
                  .setErrorCode(error.code()));
              return this;
          }
  
          public <P> Builder addPartitions(
              Uuid topicId,
              String topicName,
              List<P> partitions,
              Function<P, Integer> partitionIndex,
              Errors error
          ) {
              final OffsetCommitResponseTopic topicResponse = getOrCreate(topicId, topicName);
              partitions.forEach(partition ->
                  topicResponse.partitions().add(new OffsetCommitResponsePartition()
                      .setPartitionIndex(partitionIndex.apply(partition))
                      .setErrorCode(error.code()))
              );
              return this;
          }
  
          public Builder merge(
              OffsetCommitResponseData newData
          ) {
              if (data.topics().isEmpty()) {
                  // If the current data is empty, we can discard it and use the new data.
                  data = newData;
              } else {
                  // Otherwise, we have to merge them together.
                  newData.topics().forEach(newTopic -> {
                      OffsetCommitResponseTopic existingTopic = get(newTopic.topicId(), newTopic.name());
                      if (existingTopic == null) {
                          // If no topic exists, we can directly copy the new topic data.
                          add(newTopic);
                      } else {
                          // Otherwise, we add the partitions to the existing one. Note we
                          // expect non-overlapping partitions here as we don't verify
                          // if the partition is already in the list before adding it.
                          existingTopic.partitions().addAll(newTopic.partitions());
                      }
                  });
              }
              return this;
          }
  
          public OffsetCommitResponse build() {
              return new OffsetCommitResponse(data);
          }
      }
  
      public static class TopicIdBuilder extends Builder {
          private final HashMap<Uuid, OffsetCommitResponseTopic> byTopicId = new HashMap<>();
  
          @Override
          protected void add(OffsetCommitResponseTopic topic) {
              throwIfTopicIdIsNull(topic.topicId());
              data.topics().add(topic);
              byTopicId.put(topic.topicId(), topic);
          }
  
          @Override
          protected OffsetCommitResponseTopic get(Uuid topicId, String topicName) {
              throwIfTopicIdIsNull(topicId);
              return byTopicId.get(topicId);
          }
  
          @Override
          protected OffsetCommitResponseTopic getOrCreate(Uuid topicId, String topicName) {
              throwIfTopicIdIsNull(topicId);
              OffsetCommitResponseTopic topic = byTopicId.get(topicId);
              if (topic == null) {
                  topic = new OffsetCommitResponseTopic()
                      .setName(topicName)
                      .setTopicId(topicId);
                  data.topics().add(topic);
                  byTopicId.put(topicId, topic);
              }
              return topic;
          }
  
          private static void throwIfTopicIdIsNull(Uuid topicId) {
              if (topicId == null) {
                  throw new IllegalArgumentException("TopicId cannot be null.");
              }
          }
      }
  
      public static class TopicNameBuilder extends Builder {
          private final HashMap<String, OffsetCommitResponseTopic> byTopicName = new HashMap<>();
  
          @Override
          protected void add(OffsetCommitResponseTopic topic) {
              throwIfTopicNameIsNull(topic.name());
              data.topics().add(topic);
              byTopicName.put(topic.name(), topic);
          }
  
          @Override
          protected OffsetCommitResponseTopic get(Uuid topicId, String topicName) {
              throwIfTopicNameIsNull(topicName);
              return byTopicName.get(topicName);
          }
  
          @Override
          protected OffsetCommitResponseTopic getOrCreate(Uuid topicId, String topicName) {
              throwIfTopicNameIsNull(topicName);
              OffsetCommitResponseTopic topic = byTopicName.get(topicName);
              if (topic == null) {
                  topic = new OffsetCommitResponseTopic()
                      .setName(topicName)
                      .setTopicId(topicId);
                  data.topics().add(topic);
                  byTopicName.put(topicName, topic);
              }
              return topic;
          }
  
          private void throwIfTopicNameIsNull(String topicName) {
              if (topicName == null) {
                  throw new IllegalArgumentException("TopicName cannot be null.");
              }
          }
      }
  }
  