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

Add documentation for the XML processing limits in java.xml module summary

    XMLWordPrintable

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P4
    • Resolution: Approved
    • Fix Version/s: 17
    • Component/s: xml
    • Labels:
      None
    • Subcomponent:
    • Compatibility Risk:
      minimal
    • Compatibility Risk Description:
      The change is documentation only.
    • Interface Kind:
      System or security property
    • Scope:
      JDK

      Description

      Summary

      Add documentation for the XML processing limits in java.xml module summary

      Problem

      The XML processing limits were previously documented in Java Tutorials (https://docs.oracle.com/javase/tutorial/jaxp/limits/index.html) and Guide (https://docs.oracle.com/javase/8/docs/technotes/guides/security/jaxp/jaxp.html). With the addition of implementation note via JDK-8260858, it would be good to add the documentation into the java.xml module summary.

      Solution

      Add the documentation into the java.xml module summary.

      In the previous documentation, the table that currently contains only Properties was named Features and Properties. Considering that we will be adding Features that would have a different prefix, the name of table shall be changed to Implementation Specific Properties.

      Specification

      1. Copy the definitions in section Processing Limit Definitions of the Java tutorial into the table Implementation Specific Properties;

      2. Change the name of the table from Features and Properties to Implementation Specific Properties;

      3. Change the description of the table to indicate that the list of the properties is not exhaustive by replacing the statement in spec_02:

        The table below lists Implementation Specific Properties supported by the JDK. 

        with the following in spec_3:

        The Implementation Specific Features and Properties reflect JDK's choice to manage the limitations
        on resources while complying with the API specification, or allow applications to alter behaviors 
        beyond those required by the standards.
        
        The table below lists the Implementation Specific Properties currently supported by the JDK. 
        More properties may be added in the future if necessary. 
      4. Add the following to note [3] of the table at the end of the statement:

        If the type is Integer, the value of the System Property is the String representation of the 
        value (e.g. "64000" for entityExpansionLimit). 

      Specification attachment: 8261670_spec_03.zip Convenient link: http://cr.openjdk.java.net/~joehw/jdk17/8261670/spec_03/java.xml/module-summary.html

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              joehw Joe Wang
              Reporter:
              joehw Joe Wang
              Reviewed By:
              Iris Clark, Lance Andersen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: