Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8249685

Document JSSE/TLS system properties in a central place in the javadoc

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Unresolved
    • Icon: P3 P3
    • None
    • None
    • security-libs

      There are many system properties that one can set to alter the default behavior of the SunJSSE TLS provider. These are all documented in the JSSE Reference Guide [1]. However, it would also be useful to document these somewhere in the javadocs to make developers more aware of them when using the JSSE APIs. Also, using the "@systemProperty" annotation would allow them to be discovered more easily using the javadoc search function.

      The effect of many of these properties typically span more than one API, so documenting them in a specific method, or even class, is not usually the best solution.

      My suggestion would be to create something similar (in the javax.net.ssl package) to the net-properties.html docs-file that is linked from the java.net package summary [2]. We should be careful to document and distinguish between SE standard properties and properties that are JDK specific.

      [1] https://docs.oracle.com/en/java/javase/14/security/java-secure-socket-extension-jsse-reference-guide.html#GUID-A41282C3-19A3-400A-A40F-86F4DA22ABA9
      [2] https://download.java.net/java/early_access/jdk15/docs/api/java.base/java/net/doc-files/net-properties.html

            rgallard Raymond Gallardo
            mullan Sean Mullan
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated: