Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect JavaDoc for KafkaMessageHeaderAccessor.getBlockingRetryDeliveryAttempt() #3408

Closed
lm231290 opened this issue Aug 5, 2024 · 4 comments

Comments

@lm231290
Copy link

lm231290 commented Aug 5, 2024

Version 3.2.2

JavaDoc says:

Access the header value when the blocking delivery attempt header is present.
Returns:
1 if there is no header present; the decoded header value otherwise.
Throws:
IllegalStateException – if the header is not present.
See Also:
org.springframework.kafka.listener.ContainerProperties.setDeliveryAttemptHeader(boolean)

Actually, it doesn't return 1, if no header present, it throws IllegalStateException

@artembilan
Copy link
Member

Agreed.
Feel free to contribute the fix: https://github.com/spring-projects/spring-kafka/blob/main/CONTRIBUTING.adoc
Thanks

@MichaelMoyles
Copy link
Contributor

MichaelMoyles commented Aug 13, 2024

I can take this issue and update the docs, if it can be assigned to me

@sobychacko
Copy link
Contributor

@MichaelMoyles, please send a PR addressing this issue. See the contribution guidelines above.

@artembilan
Copy link
Member

Thanks. @MichaelMoyles , for suggesting the help!
You definitely can take and open PR.
However only team members can be assigned for the issue.
Either way your contribution will be accepted and credited on release motes.

spring-builds pushed a commit that referenced this issue Aug 14, 2024
Fixes: #3408

updating KafkaMessageHeaderAccessor.getBlockingRetryDeliveryAttempt javadoc

(cherry picked from commit d8de5b9)
spring-builds pushed a commit that referenced this issue Aug 14, 2024
Fixes: #3408

updating KafkaMessageHeaderAccessor.getBlockingRetryDeliveryAttempt javadoc

(cherry picked from commit d8de5b9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants