ok2c commented on a change in pull request #63: [WAGON-576] Retry handler docs
are possibly wrong
URL: https://github.com/apache/maven-wagon/pull/63#discussion_r383143310
##########
File path: wagon-providers/wagon-http/src/site/apt/index.apt
##########
@@ -66,13 +66,20 @@ Features
* <<<default>>> will use an instance of
{{{http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/DefaultHttpRequestRetryHandler.html}<<<DefaultHttpRequestRetryHandler>>>}}
respecting <<<requestSentEnabled>>>, <<<count>>> and <<<nonRetryableClasses>>>.
- *<< <standard>>> will use an instance of
{{{http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/StandardHttpRequestRetryHandler.html}<<<StandardHttpRequestRetryHandler>>>}}
respecting <<<requestSentEnabled>>> and <<<count>>>.
+ *<<<standard>>> will use an instance of
{{{http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/StandardHttpRequestRetryHandler.html}<<<StandardHttpRequestRetryHandler>>>}}
respecting <<<requestSentEnabled>>> and <<<count>>>.
* Any fully qualified name of a
{{{https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/client/HttpRequestRetryHandler.html}<<<HttpRequestRetryHandler>>>}}
implementation will be instantiated with its default constructor.
+ [Attention] This will not work with the shaded version bundled with
Maven.
+
* <<<maven.wagon.http.retryHandler.requestSentEnabled>>> =
<<<requestSentEnabled>>> for <<<default>>> or <<<standard>>> implementations.
* <<<maven.wagon.http.retryHandler.count>>> = number of retries for
<<<default>>> or <<<standard>>> implementations.
* <<<maven.wagon.http.retryHandler.nonRetryableClasses>>> = a comma-separated
list of fully qualified class names bypassing the retries (only the
<<<default>>> implementation).
If not set, the default value from
{{{http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/DefaultHttpRequestRetryHandler.html}<<<DefaultHttpRequestRetryHandler>>>}}
will be used.
+
+ []
+
+ [Attention] Any retry handler will only react on initial exceptions,
it will <not> salvage in-flight failures of ongoing streams.
Review comment:
@michael-o I would rather say
```
Any retry handler can only react to exception when executing the request and
receiving the response head. It will <not> salvage in-flight failures of
ongoing response body streams.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
