m1a2st commented on code in PR #19955:
URL: https://github.com/apache/kafka/pull/19955#discussion_r2410608521
##########
streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java:
##########
@@ -1588,28 +1598,50 @@ public synchronized boolean close(final Duration
timeout) throws IllegalArgument
throw new IllegalArgumentException("Timeout can't be negative.");
}
- return close(Optional.of(timeoutMs), false);
+ return close(Optional.of(timeoutMs),
org.apache.kafka.streams.CloseOptions.GroupMembershipOperation.REMAIN_IN_GROUP);
}
/**
* Shutdown this {@code KafkaStreams} by signaling all the threads to
stop, and then wait up to the timeout for the
* threads to join.
+ * This method is deprecated and replaced by {@link
#close(org.apache.kafka.streams.CloseOptions)}.
* @param options contains timeout to specify how long to wait for the
threads to shut down, and a flag leaveGroup to
* trigger consumer leave call
* @return {@code true} if all threads were successfully
stopped—{@code false} if the timeout was reached
* before all threads stopped
* Note that this method must not be called in the {@link
StateListener#onChange(KafkaStreams.State, KafkaStreams.State)} callback of
{@link StateListener}.
* @throws IllegalArgumentException if {@code timeout} can't be
represented as {@code long milliseconds}
*/
+ @Deprecated(since = "4.2")
public synchronized boolean close(final CloseOptions options) throws
IllegalArgumentException {
+ final org.apache.kafka.streams.CloseOptions closeOptions =
org.apache.kafka.streams.CloseOptions.timeout(options.timeout)
+ .withGroupMembershipOperation(options.leaveGroup ?
+
org.apache.kafka.streams.CloseOptions.GroupMembershipOperation.LEAVE_GROUP :
+
org.apache.kafka.streams.CloseOptions.GroupMembershipOperation.REMAIN_IN_GROUP);
+ return close(closeOptions);
+ }
+
+ /**
+ * Shutdown this {@code KafkaStreams} by signaling all the threads to
stop, and then wait up to the timeout for the
+ * threads to join.
+ * @param options contains timeout to specify how long to wait for the
threads to shut down,
+ * and a {@link
org.apache.kafka.streams.CloseOptions.GroupMembershipOperation}
+ * to trigger consumer leave call or remain in the group
+ * @return {@code true} if all threads were successfully
stopped—{@code false} if the timeout was reached
+ * before all threads stopped
+ * Note that this method must not be called in the {@link
StateListener#onChange(KafkaStreams.State, KafkaStreams.State)} callback of
{@link StateListener}.
+ * @throws IllegalArgumentException if {@code timeout} can't be
represented as {@code long milliseconds}
+ */
+ public synchronized boolean close(final
org.apache.kafka.streams.CloseOptions options) throws IllegalArgumentException {
Objects.requireNonNull(options, "options cannot be null");
- final String msgPrefix =
prepareMillisCheckFailMsgPrefix(options.timeout, "timeout");
- final long timeoutMs = validateMillisecondDuration(options.timeout,
msgPrefix);
+ final CloseOptionsInternal optionsInternal = new
CloseOptionsInternal(options);
+ final String msgPrefix =
prepareMillisCheckFailMsgPrefix(optionsInternal.timeout(), "timeout");
Review Comment:
It’s safe to pass an `Optional` object, but we shouldn’t change the error
message. Therefore, I’ll update it to use `Duration` instead.
```
Invalid value for parameter "timeout" (value was: PT1M).
Invalid value for parameter "timeout" (value was: Optional[PT1M]).
```
--
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]
