RFR: 8288493: Document JDK specific system properties in jdk.httpserver [v5]

[Michael McMahon]

On Thu, 20 Oct 2022 10:38:47 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:

>> Michael McMahon has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   blank line removed
>
> src/jdk.httpserver/share/classes/module-info.java line 44:
> 
>> 42:  * <p>
>> 43:  * The following is a list of JDK specific system properties used by the HTTP
>> 44:  * server implementation.
> 
> Hello Michael, given that the HttpServer is based on a SPI and the `sun.net.httpserver.HttpServerImpl`  (and its Https equivalent) are just default implementations, should either of these 2 sentences note that these system properties are only applicable for the default HttpServer implementation? Something like:
> 
>>
>><b id="httpserverprops">System properties used by the default HTTP server</b>
> The following is a list of JDK specific system properties used by the default HTTP server implementation.

Maybe, I should include the property that is used to locate the impl as first in the list and say the remaining properties apply to the default impl in the JDK?

> src/jdk.httpserver/share/classes/module-info.java line 83:
> 
>> 81:  * exceeded then the connection is terminated and the handler will receive a
>> 82:  * {@link java.io.IOException}. This timer has an implementation specific granularity
>> 83:  * that may mean responses are aborted later than the specified interval.
> 
> I think the `maxReqTime` and the `maxRspTime` will need a bit more clarification on how they differ. Specifically the `maxReqTime` as used by the current server implementation is the duration to read the entire request content. It however, doesn't include the time it takes to generate the response nor process the request through the handler.

Okay, I can specifically refer to "request headers and body" and "response headers and body".

So, for example replace "The maximum duration in milliseconds of a request." with

"The maximum time in milliseconds allowed to receive the request headers and body".

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

PR: https://git.openjdk.org/jdk/pull/10766