JDK-8328914 : Document the java.security.debug property in javadoc
  • Type: Enhancement
  • Component: security-libs
  • Sub-Component: java.security
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2024-03-25
  • Updated: 2025-05-28
  • Resolved: 2025-05-01
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 25
25 b22Fixed
Related Reports
CSR :  
Relates :  
Relates :  
Relates :  
Sub Tasks
JDK-8350384 :  
Description
java.security.debug is a widely used debug system property for JDK security libs. It's time to capture details about this property via javadoc.
Comments
Changeset: 394961c8 Branch: master Author: Koushik Thirupattur <koushik.thirupattur@oracle.com> Committer: Sean Mullan <mullan@openjdk.org> Date: 2025-05-01 17:26:32 +0000 URL: https://git.openjdk.org/jdk/commit/394961c8fe87da7376cc7522580cd4ac104c3cf5
01-05-2025

A pull request was submitted for review. Branch: master URL: https://git.openjdk.org/jdk/pull/23569 Date: 2025-02-11 19:16:01 +0000
13-02-2025

The security guide has https://docs.oracle.com/en/java/javase/23/security/troubleshooting-security.html#GUID-05F3E865-20FF-46EB-AC35-84D4B552CA48. We can reuse some text from it.
11-02-2025

Good idea. We can also describe javax.net.debug in javax.net package, and, add one or two lines to `java -XshowSettings:security`. And yes, I mis-understood your previous comment about what `java.security` meant.
06-02-2025

I meant the java.security/package.info file. But on second thought, adding a new file in java.security/doc-files is probably a better location. We could call it security-properties.html and start to use it to document common or standard system properties.
06-02-2025

This is the only text file we have, but its title shows 'This is the "master security properties file"' and this is only a system property.
06-02-2025

I would probably document it in the `java.security` package and then link to it from other places, as appropriate.
25-03-2024