hachikuji commented on a change in pull request #10275: URL: https://github.com/apache/kafka/pull/10275#discussion_r597978853
########## File path: clients/src/main/java/org/apache/kafka/clients/admin/internals/AdminApiHandler.java ########## @@ -0,0 +1,127 @@ +/* + * 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.admin.internals; + +import org.apache.kafka.common.requests.AbstractRequest; +import org.apache.kafka.common.requests.AbstractResponse; + +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + +public interface AdminApiHandler<K, V> { + + /** + * Get a user-friendly name for the API this handler is implementing. + */ + String apiName(); + + /** + * Initialize the set of keys required to handle this API and how the driver + * should map them to the broker that will handle the request for these keys. + * + * Two mapping types are supported: + * + * - Static mapping: when the brokerId is known ahead of time + * - Dynamic mapping: when the brokerId must be discovered dynamically + * + * @return the key mappings + */ + KeyMappings<K> initializeKeys(); + + /** + * Build the fulfillment request. The set of keys are derived during the Lookup stage + * as the set of keys which all map to the same destination broker. + * + * @param brokerId the target brokerId for the request + * @param keys the set of keys that should be handled by this request + * + * @return a builder for the request containing the given keys + */ + AbstractRequest.Builder<?> buildRequest(Integer brokerId, Set<K> keys); + + /** + * Callback that is invoked when a Fulfillment request returns successfully. + * The handler should parse the response, check for errors, and return a + * result which indicates which keys (if any) have either been completed or + * failed with an unrecoverable error. + * + * It is also possible that the response indicates an incorrect target brokerId + * (e.g. in the case of a NotLeader error when the request is bound for a partition + * leader). In this case the key will be "unmapped" from the target brokerId + * and lookup will be retried. + * + * Note that keys which received a retriable error should be left out of the + * result. They will be retried automatically. + * + * @param brokerId the brokerId that the associated request was sent to + * @param keys the set of keys from the associated request + * @param response the response received from the broker + * + * @return result indicating key complation, failure, and unmapping + */ + ApiResult<K, V> handleResponse(Integer brokerId, Set<K> keys, AbstractResponse response); + + class KeyMappings<K> { + public final Optional<StaticKeyMapping<K>> staticMapping; Review comment: That's fair. I think I added the separate types because i wanted to express the fact that the `LookupStrategy` was only required for dynamic keys. Maybe that is overkill though and we could do the validation dynamically. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
