Document list of reserved keys in java.security.Security::getProperty…

…/setProperty APIs. Co-authored-by: Martin Balao <[email protected]> Co-authored-by: Francisco Ferrari Bihurriet <[email protected]>
franferrax · Aug 21, 2024 · 3b6f99c · 3b6f99c
1 parent 580d34a
commit 3b6f99c
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/java.base/share/classes/java/security/Security.java b/src/java.base/share/classes/java/security/Security.java
@@ -865,7 +865,8 @@ static Object[] getImpl(String algorithm, String type, Provider provider,
      *          access to retrieve the specified security property value
      * @throws  NullPointerException if key is {@code null}
      * @throws  IllegalArgumentException if key is reserved and cannot be
-     *          used as a Security property name.
+     *          used as a Security property name. Reserved keys are:
+     *          "include".
      *
      * @see #setProperty
      * @see java.security.SecurityPermission
@@ -898,7 +899,8 @@ public static String getProperty(String key) {
      *          denies access to set the specified security property value
      * @throws  NullPointerException if key or datum is {@code null}
      * @throws  IllegalArgumentException if key is reserved and cannot be
-     *          used as a Security property name.
+     *          used as a Security property name. Reserved keys are:
+     *          "include".
      *
      * @see #getProperty
      * @see java.security.SecurityPermission