bbejeck commented on code in PR #18125: URL: https://github.com/apache/kafka/pull/18125#discussion_r1880757327
########## clients/src/main/java/org/apache/kafka/clients/admin/DescribeStreamsGroupsResult.java: ########## @@ -0,0 +1,68 @@ +/* + * 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; + +import org.apache.kafka.common.KafkaFuture; +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.ExecutionException; + +/** + * The result of the {@link KafkaAdminClient#describeStreamsGroups(Collection, DescribeStreamsGroupsOptions)}} call. + * <p> + * The API of this class is evolving, see {@link Admin} for details. + */ [email protected] +public class DescribeStreamsGroupsResult { + + private final Map<String, KafkaFuture<StreamsGroupDescription>> futures; + + public DescribeStreamsGroupsResult(final Map<String, KafkaFuture<StreamsGroupDescription>> futures) { + this.futures = futures; + } + + /** + * Return a map from group id to futures which yield streams group descriptions. + */ + public Map<String, KafkaFuture<StreamsGroupDescription>> describedGroups() { + return new HashMap<>(futures); + } + + /** + * Return a future which yields all StreamsGroupDescription objects, if all the describes succeed. + */ + public KafkaFuture<Map<String, StreamsGroupDescription>> all() { + return KafkaFuture.allOf(futures.values().toArray(new KafkaFuture[0])).thenApply( + nil -> { Review Comment: Why not `futures.values().toStream`? ########## clients/src/main/java/org/apache/kafka/clients/admin/StreamsGroupDescription.java: ########## @@ -0,0 +1,180 @@ +/* + * 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; + +import org.apache.kafka.common.GroupState; +import org.apache.kafka.common.Node; +import org.apache.kafka.common.acl.AclOperation; +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.Collection; +import java.util.Objects; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * A detailed description of a single streams group in the cluster. + */ [email protected] +public class StreamsGroupDescription { + + private final String groupId; + private final int groupEpoch; + private final int targetAssignmentEpoch; + private final int topologyEpoch; + private final Collection<StreamsGroupSubtopologyDescription> subtopologies; + private final Collection<StreamsGroupMemberDescription> members; + private final GroupState groupState; + private final Node coordinator; + private final Set<AclOperation> authorizedOperations; + + public StreamsGroupDescription( + final String groupId, + final int groupEpoch, + final int targetAssignmentEpoch, + final int topologyEpoch, + final Collection<StreamsGroupSubtopologyDescription> subtopologies, + final Collection<StreamsGroupMemberDescription> members, + final GroupState groupState, + final Node coordinator, + final Set<AclOperation> authorizedOperations + ) { + this.groupId = Objects.requireNonNull(groupId, "groupId must be non-null"); + this.groupEpoch = groupEpoch; + this.targetAssignmentEpoch = targetAssignmentEpoch; + this.topologyEpoch = topologyEpoch; + this.subtopologies = Objects.requireNonNull(subtopologies, "subtopologies must be non-null"); + this.members = Objects.requireNonNull(members, "members must be non-null"); + this.groupState = groupState; + this.coordinator = coordinator; Review Comment: Same here, why is `coordinator` allowed to be `null`? ########## clients/src/main/java/org/apache/kafka/clients/admin/StreamsGroupDescription.java: ########## @@ -0,0 +1,180 @@ +/* + * 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; + +import org.apache.kafka.common.GroupState; +import org.apache.kafka.common.Node; +import org.apache.kafka.common.acl.AclOperation; +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.Collection; +import java.util.Objects; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * A detailed description of a single streams group in the cluster. + */ [email protected] +public class StreamsGroupDescription { + + private final String groupId; + private final int groupEpoch; + private final int targetAssignmentEpoch; + private final int topologyEpoch; + private final Collection<StreamsGroupSubtopologyDescription> subtopologies; + private final Collection<StreamsGroupMemberDescription> members; + private final GroupState groupState; + private final Node coordinator; + private final Set<AclOperation> authorizedOperations; + + public StreamsGroupDescription( + final String groupId, + final int groupEpoch, + final int targetAssignmentEpoch, + final int topologyEpoch, + final Collection<StreamsGroupSubtopologyDescription> subtopologies, + final Collection<StreamsGroupMemberDescription> members, + final GroupState groupState, + final Node coordinator, + final Set<AclOperation> authorizedOperations + ) { + this.groupId = Objects.requireNonNull(groupId, "groupId must be non-null"); + this.groupEpoch = groupEpoch; + this.targetAssignmentEpoch = targetAssignmentEpoch; + this.topologyEpoch = topologyEpoch; + this.subtopologies = Objects.requireNonNull(subtopologies, "subtopologies must be non-null"); + this.members = Objects.requireNonNull(members, "members must be non-null"); + this.groupState = groupState; + this.coordinator = coordinator; + this.authorizedOperations = authorizedOperations; + } + + /** + * The id of the streams group. + */ + public String groupId() { + return groupId; + } + + /** + * The epoch of the consumer group. + */ + public int groupEpoch() { + return groupEpoch; + } + + /** + * The epoch of the target assignment. + */ + public int targetAssignmentEpoch() { + return targetAssignmentEpoch; + } + + /** + * The epoch of the currently used topology. + */ + public int topologyEpoch() { + return topologyEpoch; + } + + /** + * A list of the members of the streams group. + */ + public Collection<StreamsGroupMemberDescription> members() { + return members; + } + + /** + * A list of the subtopologies in the streams group. + */ + public Collection<StreamsGroupSubtopologyDescription> subtopologies() { + return subtopologies; Review Comment: Defensive copy? Here and above. ########## clients/src/main/java/org/apache/kafka/clients/admin/DescribeStreamsGroupsResult.java: ########## @@ -0,0 +1,68 @@ +/* + * 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; + +import org.apache.kafka.common.KafkaFuture; +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.ExecutionException; + +/** + * The result of the {@link KafkaAdminClient#describeStreamsGroups(Collection, DescribeStreamsGroupsOptions)}} call. + * <p> + * The API of this class is evolving, see {@link Admin} for details. + */ [email protected] +public class DescribeStreamsGroupsResult { + + private final Map<String, KafkaFuture<StreamsGroupDescription>> futures; + + public DescribeStreamsGroupsResult(final Map<String, KafkaFuture<StreamsGroupDescription>> futures) { + this.futures = futures; Review Comment: Maybe make a defensive copy here? ########## clients/src/main/java/org/apache/kafka/clients/admin/StreamsGroupMemberAssignment.java: ########## @@ -0,0 +1,150 @@ +/* + * 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; + +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.List; +import java.util.Objects; +import java.util.stream.Collectors; + +/** + * A description of the assignments of a specific group member. + */ [email protected] +public class StreamsGroupMemberAssignment { + + private final List<TaskIds> activeTasks; + private final List<TaskIds> standbyTasks; + private final List<TaskIds> warmupTasks; + + public StreamsGroupMemberAssignment( + final List<TaskIds> activeTasks, + final List<TaskIds> standbyTasks, + final List<TaskIds> warmupTasks + ) { + this.activeTasks = activeTasks; + this.standbyTasks = standbyTasks; + this.warmupTasks = warmupTasks; + } + + /** + * Active tasks for this client. + */ + public List<TaskIds> activeTasks() { + return activeTasks; + } + + /** + * Standby tasks for this client. + */ + public List<TaskIds> standbyTasks() { + return standbyTasks; + } + + /** + * Warmup tasks for this client. + */ + public List<TaskIds> warmupTasks() { + return warmupTasks; Review Comment: Defensive copies for the getters and in the constructor? And anywhere else in this PR where we either accept or return a collection. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
