RFR: 8330542: Template for Creating Strict JAXP Configuration File [v14]

[Sean Mullan]

On Fri, 24 May 2024 16:36:32 GMT, Joe Wang <joehw at openjdk.org> wrote:

>> Add two sample configuration files:
>> 
>>   jaxp-strict.properties: used to set strict configuration, stricter than jaxp.properties in previous versions such as JDK 22
>> 
>>>   jaxp-compat.properties: used to regain compatibility from any more restricted configuration than previous versions such as JDK 22
>> 
>> Updated on 5/16/2024
>> 
>> Design change:
>> The design is changed to include in the JDK two configuration files that are the default jaxp.properties and jaxp-strict.properties, instead of three, dropping jaxp-compat.properties.
>> 
>> Updated on 5/18/2024
>> 
>> Withdraw changes to jaxp.properties. The original idea was to match jaxp-strict.properties with regard to the properties. However, that change impact the configuration process, resulting in tests that verify the process to fail.
>> 
>> Updated on 5/23/2024
>> 
>> Provide a template `jaxp-strict.template` instead of a properties file. This template can be used to create custom configuration files.
>
> Joe Wang has updated the pull request incrementally with one additional commit since the last revision:
> 
>   rename the template to jaxp-strict.properties.template

Just some wording suggestions.

src/java.xml/share/conf/jaxp-strict.properties.template line 36:

> 34: # This property determines whether XSLT and XPath extension functions are allowed.
> 35: # The value type is boolean and the default value is true (allowing
> 36: # extension functions). The following entry would override the default value and

I prefer the latter wording suggestion as in other places like the Limits section, you use present tense, which I also think sounds better.

s/would/will/ 
or 
s/would override/overrides/
s/disallow/disallows/

src/java.xml/share/conf/jaxp-strict.properties.template line 44:

> 42: # Overriding the default parser:
> 43: #
> 44: # This property allows using a third party implementation to override the default

s/using a third party implementation/a third party implementation/

src/java.xml/share/conf/jaxp-strict.properties.template line 60:

> 58: #     strict -- indicates that the resolver should throw a CatalogException
> 59: #
> 60: # The following setting would cause the resolve to throw a CatalogException when

s/would/will/ 
or 
s/would cause/causes/

s/resolve/CatalogResolver/ ?

src/java.xml/share/conf/jaxp-strict.properties.template line 67:

> 65: # Implementation Specific Properties - DTD
> 66: #
> 67: # This property instructs the parsers to: deny, ignore or allow DTD processing.

s/to:/to/

src/java.xml/share/conf/jaxp-strict.properties.template line 68:

> 66: #
> 67: # This property instructs the parsers to: deny, ignore or allow DTD processing.
> 68: # The following setting would cause the parser to reject DTD by throwing an exception.

s/would/will/
or
s/would cause/causes/

s/DTD/DTDs/

src/java.xml/share/conf/jaxp.properties line 1:

> 1: ################################################################################

Similar wording suggestions as in the `jaxp-strict.properties.template` file.

-------------

PR Review: https://git.openjdk.org/jdk/pull/18831#pullrequestreview-2083052633
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617388223
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617389854
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617392917
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617394277
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617395992
PR Review Comment: https://git.openjdk.org/jdk/pull/18831#discussion_r1617407662