This is an automated email from the ASF dual-hosted git repository. cstamas pushed a commit to branch MNG-7739-transport-config in repository https://gitbox.apache.org/repos/asf/maven-site.git
commit d30f1dd72dac61b31907626f5bf40a1a82ad8da4 Author: Tamas Cservenak <ta...@cservenak.net> AuthorDate: Tue Mar 14 10:27:04 2023 +0100 [MNG-7739] Clear up documentation As some changes creeped in that are actually 3.9+ ONLY. Also, explain what is and what is not picked up from legacy configs. --- https://issues.apache.org/jira/browse/MNG-7739 --- content/apt/guides/mini/guide-http-settings.apt | 9 ++++++++ .../guides/mini/guide-resolver-transport.md | 25 ++++++++++++++++++++-- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/content/apt/guides/mini/guide-http-settings.apt b/content/apt/guides/mini/guide-http-settings.apt index db36a07a..47885144 100644 --- a/content/apt/guides/mini/guide-http-settings.apt +++ b/content/apt/guides/mini/guide-http-settings.apt @@ -50,6 +50,9 @@ Advanced Configuration of the Maven Wagon Transport **HTTP Headers + <<Supported starting with Maven 3.9.0. This configuration applies to ALL transports, both native HTTP and Wagon will obey these. + This mode is meant for users upgraded to Maven 3.9.0+ but being "in limbo" between new native HTTP and Wagon transport.>> + In all HTTP transports, you can add your custom HTTP headers like this: +---+ @@ -76,6 +79,9 @@ Advanced Configuration of the Maven Wagon Transport **Connection Timeouts + <<Supported starting with Maven 3.9.0. This configuration applies to ALL transports, both native HTTP and Wagon will obey these. + This mode is meant for users upgraded to Maven 3.9.0+ but being "in limbo" between new native HTTP and Wagon transport.>> + All transport implementations that perform some network access allow configuring several timeouts, for example to allow the user to tell Maven how long to wait before giving up on a connection that has not responded. @@ -173,6 +179,9 @@ problems with HTTP servers and proxies that do not support HTTP/1.1 protocol. **Configuring GET, HEAD, PUT, or All of the Above + <<Starting with Maven 3.9.0 native HTTP transport will pick up the "all" settings only (get, head, put are neglected!)" + but it will WARN about it's deprecation. For users sticking with Wagon nothing changes.>> + In all of the examples below, it's important to understand that you can configure the HTTP settings for all requests made to a given server, or for only one method. To configure all methods for a server, use the following section of the <<<settings.xml>>> file: diff --git a/content/markdown/guides/mini/guide-resolver-transport.md b/content/markdown/guides/mini/guide-resolver-transport.md index fa49c31c..32883ed7 100644 --- a/content/markdown/guides/mini/guide-resolver-transport.md +++ b/content/markdown/guides/mini/guide-resolver-transport.md @@ -33,6 +33,8 @@ The Resolver contains configuration for many aspects, including transport (see t prefixed with `aether.connector.`). They can be found on [resolver configuration page](https://maven.apache.org/resolver/configuration.html). +**This page applies only to Maven 3.9.0 and newer.** + ## Switching Between Transports The transport used by resolver can be controlled using the `-Dmaven.resolver.transport` user property, for which accepted @@ -75,10 +77,29 @@ In all HTTP transports, you can add your custom HTTP headers like this: </settings> ``` -It is important to understand that the above approach does not allow you to turn off all the default HTTP headers; -nor does it allow you to specify headers on a per-method basis. However, this configuration remains available in all +It is important to understand that the above approach does not allow you to turn off all the default HTTP headers; +nor does it allow you to specify headers on a per-method basis. However, this configuration remains available in all transports that support headers, like HTTP transports are (and works for "native" but also Wagon transport). +## Timeouts + +All transport implementations that perform some network access allow configuring several timeouts, +for example to allow the user to tell Maven how long to wait before giving up on a connection that has not responded. + +```xml +<settings> + <servers> + <server> + <id>my-server</id> + <configuration> + <connectTimeout>10000</connectTimeout> <!-- milliseconds --> + <requestTimeout>1800000</requestTimeout> <!-- milliseconds --> + </configuration> + </server> + </servers> +</settings> +``` + ## How To Upgrade from Wagon? (or "native transport does not work") If your build environment uses Wagon specific configuration (in `settings.xml` or alike), you should migrate your