This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git
The following commit(s) were added to refs/heads/master by this push:
new 7a107e70 [MNGSITE-393] Remove legacy Maven 2 info (#212)
7a107e70 is described below
commit 7a107e70b04682ca9a598832ac0fba08ff8090a7
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Sun Sep 24 07:52:36 2023 -0400
[MNGSITE-393] Remove legacy Maven 2 info (#212)
[/MNGSITE-393} Remove legacy Maven 2 info
---
content/apt/guides/mini/guide-http-settings.apt | 40 ++++++++++++-------------
1 file changed, 19 insertions(+), 21 deletions(-)
diff --git a/content/apt/guides/mini/guide-http-settings.apt
b/content/apt/guides/mini/guide-http-settings.apt
index 4b425e4b..64d352c2 100644
--- a/content/apt/guides/mini/guide-http-settings.apt
+++ b/content/apt/guides/mini/guide-http-settings.apt
@@ -29,12 +29,10 @@
Advanced configuration to HttpClient HTTP Wagon
<<This page contains Wagon specific information, but the default transport
in Maven 3.9.0+ is NOT Wagon anymore.
- Make sure to check {{{./guide-resolver-transport.html}Resolver Transport
guide}} first, as things have changed.>>
+ Make sure to check the {{{./guide-resolver-transport.html}Resolver Transport
guide}} first, as things have changed.>>
%{toc}
-*Advanced Configuration of the HttpClient HTTP Wagon
-
You can use the default wagon implementation for a given
protocol, or you can select an alternative wagon <<<provider>>> on a
per-protocol basis.
For more information, see the {{{./guide-wagon-providers.html}Guide to Wagon
Providers}} \[3\].
@@ -45,11 +43,11 @@ Advanced configuration to HttpClient HTTP Wagon
* http(s) connection pool: default to 20.
- * readTimeout: default to 1,800,000ms (~30 minutes) (see section <<<Read
time out>>> below)
+ * readTimeout: default to 1800000 (~30 minutes) (see section <<<Read time
out>>> below)
* default Preemptive Authentication only with PUT (GET doesn't use anymore
default Preemptive Authentication)
-**Introduction
+*Introduction
The HttpClient-based HTTP wagon offers more control over the
configuration used to access HTTP-based Maven repositories. For starters,
you have fine-grained control over what HTTP headers
@@ -57,7 +55,7 @@ Advanced configuration to HttpClient HTTP Wagon
of HttpClient itself. Best of all, you have the ability to control these
headers and parameters for all requests, or individual
request types (GET, HEAD, and PUT).
-**The Basics
+*The Basics
Without any special configuration, Maven's HTTP wagon uses some default HTTP
headers and client parameters when managing
artifacts. The default headers are:
@@ -106,10 +104,10 @@ problems with HTTP servers and proxies that do not
support HTTP/1.1 protocol.
We'll discuss preemptive authentication in another example, below.
-**Configuring GET, HEAD, PUT, or All of the Above
+*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.>>
+ but it will WARN about its 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:
@@ -132,8 +130,8 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
</settings>
+---+
- On the other hand, if you can live with the default configuration for most
requests - say, HEAD and GET requests, which are used to
- check for the existence of a file and retrieve a file respectively - maybe
you only need to configure the PUT method:
+ On the other hand, if you can live with the default configuration for most
requests — say, HEAD and GET requests, which are used to
+ check for the existence of a file and retrieve a file respectively — maybe
you only need to configure the PUT method:
+---+
<settings>
@@ -156,7 +154,7 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
For clarity, the other two sections are <<<\<get\>>>> for GET requests, and
<<<\<head\>>>> for HEAD requests. I know that's going to
be hard to remember...
-**Taking Control of Your HTTP Headers
+*Taking Control of Your HTTP Headers
As you may have noticed above, the default HTTP headers do have the
potential to cause problems. For instance, some websites
set the encoding for downloading GZipped files as <<<gzip>>>, in spite of
the fact that the HTTP request itself isn't being
@@ -209,14 +207,14 @@ problems with HTTP servers and proxies that do not
support HTTP/1.1 protocol.
</settings>
+---+
-**Fine-Tuning HttpClient Parameters
+*Fine-Tuning HttpClient Parameters
Going beyond the power of HTTP request parameters, HttpClient provides a
host of other configuration options. In most cases,
you won't need to customize these. But in case you do, Maven provides access
to specify your own fine-grained configuration
for HttpClient. Again, you can specify these parameter customizations
per-method (HEAD, GET, or PUT), or for all methods of
interacting with a given server. For a complete list of supported
parameters, see the link\[2\] in Resources section below.
-***Non-String Parameter Values
+**Non-String Parameter Values
Many of the configuration parameters for HttpClient have simple string
values; however, there are important exceptions to
this. In some cases, you may need to specify boolean, integer, or long
values. In others, you may even need to specify
@@ -291,7 +289,7 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
</settings>
+---+
-***Example: Lifting auth scope restriction for external authentication systems
+**Example: Lifting auth scope restriction for external authentication systems
Maven Wagon by default limits supplied credentials to the host:port
combination
scope, ignoring any other target servers. When the target server delegates
@@ -324,7 +322,7 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
</settings>
+---+
-***Ignoring Cookies
+**Ignoring Cookies
Like the example above, telling the HttpClient to ignore cookies for all
methods of request is a simple matter of
configuring the <<<http.protocol.cookie-policy>>> parameter (it uses a
regular string value, so no special syntax
@@ -358,13 +356,13 @@ problems with HTTP servers and proxies that do not
support HTTP/1.1 protocol.
the one used by the client to access the server. If you have this problem,
and know that you don't need to use
this session cookie, you can ignore cookies from this server with the above
configuration.
-**Support for General-Wagon Configuration Standards
+*Support for General-Wagon Configuration Standards
It should be noted that configuration options previously available in the
HttpClient-driven HTTP wagon are still
supported in addition to this new, fine-grained approach. These include the
configuration of HTTP headers
and connection timeouts. Let's examine each of these briefly:
-***HTTP Headers
+**HTTP Headers
In all HTTP Wagon implementations, you can add your own HTTP headers like
this:
@@ -390,7 +388,7 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
does it allow you to specify headers on a per-method basis. However, this
configuration remains available in both the
lightweight and httpclient-based Wagon implementations.
-***Connection Timeouts
+**Connection Timeouts
All wagon implementations that extend the <<<AbstractWagon>>> class,
including those for SCP, HTTP, FTP, and more,
allow the configuration of a connection timeout, to allow the user to tell
Maven how long to wait before giving
@@ -434,9 +432,9 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
parameter. If you need to separate timeout preferences according to HTTP
method, you can use one more like that
specified directly above.
-*** Read time out
+** Read time out
- With Wagon 2.0 and Apache Maven 3.0.4, a default timeout of 30 minutes comes
by default.
+ The default timeout is 30 minutes.
If you want to change this value, you can add the following setup in your
settings:
+---+
@@ -456,7 +454,7 @@ problems with HTTP servers and proxies that do not support
HTTP/1.1 protocol.
</settings>
+---+
-**Resources
+*Resources
[[1]] {{{https://hc.apache.org/httpcomponents-client-4.5.x/}HttpClient
website}}
