chia7712 commented on code in PR #17614: URL: https://github.com/apache/kafka/pull/17614#discussion_r2061148111
########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { + /** + * Enum to specify the group membership operation upon leaving group. + * + * <ul> + * <li><b>{@code LEAVE_GROUP}</b>: means the consumer will leave the group.</li> + * <li><b>{@code REMAIN_IN_GROUP}</b>: means the consumer will remain in the group.</li> + * <li><b>{@code DEFAULT}</b>: Applies the default behavior: + * <ul> + * <li>For <b>static members</b>: The consumer will remain in the group.</li> + * <li>For <b>dynamic members</b>: The consumer will leave the group.</li> + * </ul> + * </li> + * </ul> + */ + public enum GroupMembershipOperation { + LEAVE_GROUP, + REMAIN_IN_GROUP, + DEFAULT + } + + /** + * Specifies the group membership operation upon shutdown. + * By default, {@code GroupMembershipOperation.DEFAULT} will be applied, which follows the consumer's default behavior. + */ + protected GroupMembershipOperation operation = GroupMembershipOperation.DEFAULT; + + /** + * Specifies the maximum amount of time to wait for the close process to complete. + * This allows users to define a custom timeout for gracefully stopping the consumer. + * If no value is set, the default timeout {@link ConsumerUtils#DEFAULT_CLOSE_TIMEOUT_MS} will be applied. + */ + protected Optional<Duration> timeout = Optional.empty(); + + private CloseOptions() { + } + + protected CloseOptions(final CloseOptions option) { + this.operation = option.operation; + this.timeout = option.timeout; + } + + /** + * Static method to create a {@code CloseOptions} with a custom timeout. + * + * @param timeout the maximum time to wait for the consumer to close. + * @return a new {@code CloseOptions} instance with the specified timeout. + */ + public static CloseOptions timeout(final Duration timeout) { + CloseOptions option = new CloseOptions(); + option.timeout = Optional.ofNullable(timeout); + return option; Review Comment: ```java return new CloseOptions().withTimeout(timeout); ``` ########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { + /** + * Enum to specify the group membership operation upon leaving group. + * + * <ul> + * <li><b>{@code LEAVE_GROUP}</b>: means the consumer will leave the group.</li> + * <li><b>{@code REMAIN_IN_GROUP}</b>: means the consumer will remain in the group.</li> + * <li><b>{@code DEFAULT}</b>: Applies the default behavior: + * <ul> + * <li>For <b>static members</b>: The consumer will remain in the group.</li> + * <li>For <b>dynamic members</b>: The consumer will leave the group.</li> + * </ul> + * </li> + * </ul> + */ + public enum GroupMembershipOperation { + LEAVE_GROUP, + REMAIN_IN_GROUP, + DEFAULT + } + + /** + * Specifies the group membership operation upon shutdown. + * By default, {@code GroupMembershipOperation.DEFAULT} will be applied, which follows the consumer's default behavior. + */ + protected GroupMembershipOperation operation = GroupMembershipOperation.DEFAULT; + + /** + * Specifies the maximum amount of time to wait for the close process to complete. + * This allows users to define a custom timeout for gracefully stopping the consumer. + * If no value is set, the default timeout {@link ConsumerUtils#DEFAULT_CLOSE_TIMEOUT_MS} will be applied. + */ + protected Optional<Duration> timeout = Optional.empty(); + + private CloseOptions() { + } + + protected CloseOptions(final CloseOptions option) { + this.operation = option.operation; + this.timeout = option.timeout; + } + + /** + * Static method to create a {@code CloseOptions} with a custom timeout. + * + * @param timeout the maximum time to wait for the consumer to close. + * @return a new {@code CloseOptions} instance with the specified timeout. + */ + public static CloseOptions timeout(final Duration timeout) { + CloseOptions option = new CloseOptions(); + option.timeout = Optional.ofNullable(timeout); + return option; + } + + /** + * Static method to create a {@code CloseOptions} with a specified group membership operation. + * + * @param operation the group membership operation to apply. Must be one of {@code LEAVE_GROUP}, {@code REMAIN_IN_GROUP}, + * or {@code DEFAULT}. + * @return a new {@code CloseOptions} instance with the specified group membership operation. + */ + public static CloseOptions groupMembershipOperation(final GroupMembershipOperation operation) { + Objects.requireNonNull(operation, "operation should not be null"); Review Comment: Could you please consider using `return new CloseOptions().withGroupMembershipOperation(operation);` to avoid duplicate code? ########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { + /** + * Enum to specify the group membership operation upon leaving group. + * + * <ul> + * <li><b>{@code LEAVE_GROUP}</b>: means the consumer will leave the group.</li> + * <li><b>{@code REMAIN_IN_GROUP}</b>: means the consumer will remain in the group.</li> + * <li><b>{@code DEFAULT}</b>: Applies the default behavior: + * <ul> + * <li>For <b>static members</b>: The consumer will remain in the group.</li> + * <li>For <b>dynamic members</b>: The consumer will leave the group.</li> + * </ul> + * </li> + * </ul> + */ + public enum GroupMembershipOperation { + LEAVE_GROUP, + REMAIN_IN_GROUP, + DEFAULT + } + + /** + * Specifies the group membership operation upon shutdown. + * By default, {@code GroupMembershipOperation.DEFAULT} will be applied, which follows the consumer's default behavior. + */ + protected GroupMembershipOperation operation = GroupMembershipOperation.DEFAULT; + + /** + * Specifies the maximum amount of time to wait for the close process to complete. + * This allows users to define a custom timeout for gracefully stopping the consumer. + * If no value is set, the default timeout {@link ConsumerUtils#DEFAULT_CLOSE_TIMEOUT_MS} will be applied. + */ + protected Optional<Duration> timeout = Optional.empty(); + + private CloseOptions() { + } + + protected CloseOptions(final CloseOptions option) { + this.operation = option.operation; + this.timeout = option.timeout; + } + + /** + * Static method to create a {@code CloseOptions} with a custom timeout. + * + * @param timeout the maximum time to wait for the consumer to close. + * @return a new {@code CloseOptions} instance with the specified timeout. + */ + public static CloseOptions timeout(final Duration timeout) { + CloseOptions option = new CloseOptions(); + option.timeout = Optional.ofNullable(timeout); + return option; + } + + /** + * Static method to create a {@code CloseOptions} with a specified group membership operation. + * + * @param operation the group membership operation to apply. Must be one of {@code LEAVE_GROUP}, {@code REMAIN_IN_GROUP}, + * or {@code DEFAULT}. + * @return a new {@code CloseOptions} instance with the specified group membership operation. + */ + public static CloseOptions groupMembershipOperation(final GroupMembershipOperation operation) { + Objects.requireNonNull(operation, "operation should not be null"); + CloseOptions option = new CloseOptions(); + option.operation = operation; + return option; + } + + /** + * Fluent method to set the timeout for the close process. + * + * @param timeout the maximum time to wait for the consumer to close. If {@code null}, the default timeout will be used. + * @return this {@code CloseOptions} instance. + */ + public CloseOptions withTimeout(final Duration timeout) { + this.timeout = Optional.ofNullable(timeout); + return this; + } + + /** + * Fluent method to set the group membership operation upon shutdown. + * + * @param operation the group membership operation to apply. Must be one of {@code LEAVE_GROUP}, {@code REMAIN_IN_GROUP}, or {@code DEFAULT}. + * @return this {@code CloseOptions} instance. + */ + public CloseOptions withGroupMembershipOperation(final GroupMembershipOperation operation) { Review Comment: Could you please add unit test for those helpers? ########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { + /** + * Enum to specify the group membership operation upon leaving group. + * + * <ul> + * <li><b>{@code LEAVE_GROUP}</b>: means the consumer will leave the group.</li> + * <li><b>{@code REMAIN_IN_GROUP}</b>: means the consumer will remain in the group.</li> + * <li><b>{@code DEFAULT}</b>: Applies the default behavior: + * <ul> + * <li>For <b>static members</b>: The consumer will remain in the group.</li> + * <li>For <b>dynamic members</b>: The consumer will leave the group.</li> + * </ul> + * </li> + * </ul> + */ + public enum GroupMembershipOperation { + LEAVE_GROUP, + REMAIN_IN_GROUP, + DEFAULT + } + + /** + * Specifies the group membership operation upon shutdown. + * By default, {@code GroupMembershipOperation.DEFAULT} will be applied, which follows the consumer's default behavior. + */ + protected GroupMembershipOperation operation = GroupMembershipOperation.DEFAULT; + + /** + * Specifies the maximum amount of time to wait for the close process to complete. + * This allows users to define a custom timeout for gracefully stopping the consumer. + * If no value is set, the default timeout {@link ConsumerUtils#DEFAULT_CLOSE_TIMEOUT_MS} will be applied. + */ + protected Optional<Duration> timeout = Optional.empty(); + + private CloseOptions() { + } + + protected CloseOptions(final CloseOptions option) { Review Comment: Excuse me, why to have protected constructor? ########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { Review Comment: Please update KIP for this naming change. -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
