JDK-8285400 : Add '@apiNote' to the APIs defined in Java SE 8 MR 3
  • Type: Enhancement
  • Component: security-libs
  • Sub-Component: java.security
  • Affected Version: 8u41
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2022-04-21
  • Updated: 2022-08-22
  • Resolved: 2022-04-29
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 8
8u351Fixed
Related Reports
Relates :  
JDK-8233417 - JEP 244: TLS Application-Layer Protocol Negotiation Extension (Java SE 8)
Relates :  
JDK-8285099 - (ref) Reference object should not support cloning
Relates :  
JDK-8233418 - Add support for RSASSA-PSS Signature algorithm (Java SE 8)
Description
`@since 8` in the APIs added in 8u41 [1] [2] required by MR 3 likely confuses people because they are only present in RI 8u41 and the 8 update releases that implement Java SE 8 MR 3 and later.

A suggestion is to add `@apiNote  This method is defined in Java SE 8 Maintenance Release 3."

[1] https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/b26b096d4c89
[2] https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/6bada58189de
Comments
A pull request was submitted for review. URL: https://git.openjdk.org/jdk8u-dev/pull/103 Date: 2022-08-15 18:18:50 +0000
15-08-2022
JDK 8u Fix Request: This fix is required for compliance with Java SE 8 Maintenance Release 4: https://jcp.org/en/jsr/detail?id=337
15-08-2022
I think it could have been used. However, it was decided to use apiNote rather than updating the existing @since tag to clarify that a particular method/field was defined in Java SE 8 Maintenance Release 3 .
01-08-2022
Couldn't you have used "@since 8 Maintenance Release 3" ?
31-07-2022
Changeset: 3740d05c Author: Poonam Bajaj <poonam@openjdk.org> Date: 2022-04-29 16:41:44 +0000 URL: https://git.openjdk.java.net/jdk8u-ri/commit/3740d05c063e1f80a0808a969a2cc136cafa48cb
29-04-2022
I seem to remember us discussing this at some length for 8u41. The new version definitely seems like an improvement in clarity.
29-04-2022
Fix Request This change adds "@apiNote This method/field is defined in Java SE 8 Maintenance Release 3." to the javadoc of the new APIs/fields added in Java SE MR 3 [1][2]. It would help the developers to identify which JDK 8u release contains this new APIs. PR: https://github.com/openjdk/jdk8u-ri/pull/7 The changes has been reviewed and approved. It's a spec clarification only change. [1] https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/b26b096d4c89 [2] https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/6bada58189de
26-04-2022
Technically speaking, the apiNote isn't strictly a spec change so I don't think a CSR needs to be required.
26-04-2022
This spec update, adding `@apiNote` and a couple `@since 8` in the MR 3 APIs, is spec clarification and CSR is not needed. [~darcy] any feedback for this?
26-04-2022
[~mchung] both MGF1ParameterSpec and PSSParameterSpec.TRAILER_FIELD_BC
26-04-2022
[~wetmore] and [~valeriep] also point out that SHA512_224 and SHA512_256 in ` java.security.spec.MGF1ParameterSpec` are new constants defined in MR 3 which do not have `@since`. We should add `@since 8` in this patch.
26-04-2022
A pull request was submitted for review. URL: https://git.openjdk.java.net/jdk8u-ri/pull/7 Date: 2022-04-25 21:02:05 +0000
25-04-2022