Folks,
I have spotted a few (rather minor) factual mistakes in the HttpClient
3.0 documentation. Corrective patch attached below. Please review.
Oleg
***************************************************************************************************
The information in this email is confidential and may be legally privileged. Access
to this email by anyone other than the intended addressee is unauthorized. If you are
not the intended recipient of this message, any review, disclosure, copying,
distribution, retention, or any action taken or omitted to be taken in reliance on it
is prohibited and may be unlawful. If you are not the intended recipient, please
reply to or forward a copy of this message to the sender and delete the message, any
attachments, and any copies thereof from your system.
***************************************************************************************************
Index: authentication.xml
===================================================================
RCS file: /home/cvspublic/jakarta-commons/httpclient/xdocs/authentication.xml,v
retrieving revision 1.13
diff -u -r1.13 authentication.xml
--- authentication.xml 6 Sep 2004 20:10:02 -0000 1.13
+++ authentication.xml 20 Sep 2004 16:41:57 -0000
@@ -49,10 +49,6 @@
Credentials cred)</code> and <code>getCredentials(AuthScope authscope)</code>
methods.</p>
- <p><i>Note:</i> To set default Credentials for any realm that has not been
- explicitly specified, pass in <code>null</code> as the value of
- <code>realm</code>.</p>
-
<p>The automatic authorization built in to HttpClient can be disabled
with the method <code>setDoAuthentication(boolean doAuthentication)</code>
in the HttpMethod class. The change only affects that method instance.</p>
@@ -63,7 +59,7 @@
the server gives an unauthorized response in certain situations, thus reducing the overhead
of making the connection. To enable this use the following:</p>
- <source>client.getState().setAuthenticationPreemptive(true);</source>
+ <source>client.getParams().setAuthenticationPreemptive(true);</source>
<p>Preemptive authentication mode also requires default Credentials to be set
for the target or proxy host against which preemptive authentication is to be
Index: redirects.xml
===================================================================
RCS file: /home/cvspublic/jakarta-commons/httpclient/xdocs/redirects.xml,v
retrieving revision 1.4
diff -u -r1.4 redirects.xml
--- redirects.xml 16 Sep 2004 06:24:43 -0000 1.4
+++ redirects.xml 20 Sep 2004 16:41:57 -0000
@@ -15,17 +15,19 @@
with <em>HttpClient</em>.</p>
<p>There are a few types of redirect that HttpClient can't handle
- automatically either because they require user interaction or are
- outside of the scope of HttpClient. These status codes are listed <a
- href="#Special%20Redirect%20Codes">below</a>.</p>
+ automatically either because they require user interaction, or they are
+ outside of the scope of HttpClient (these status codes are listed <a
+ href="#Special%20Redirect%20Codes">below</a>), or due to internal
+ limitations. Currently HttpClient is unable to automatically handle
+ redirects of entity enclosing methods such as <tt>POST</tt> and
+ <tt>PUT</tt>. There can also be situations when manual processing
+ of redirects is desired due to specific application requirements.
+ </p>
</section>
- <section name="Handling Redirects">
- <p>When a server returns a redirect instruction to HttpClient that
- requires connecting to a different host, HttpClient will simply return
- the redirect status code as the response status. All response codes
- between 300 and 399 inclusive are redirect responses of
- some form. The most common redirect response codes are:</p>
+ <section name="Handling redirects manually">
+ <p>All response codes between 300 and 399 inclusive are redirect responses
+ of some form. The most common redirect response codes are:</p>
<ul>
<li>301 Moved Permanently.
Index: tutorial.xml
===================================================================
RCS file: /home/cvspublic/jakarta-commons/httpclient/xdocs/tutorial.xml,v
retrieving revision 1.7
diff -u -r1.7 tutorial.xml
--- tutorial.xml 16 Sep 2004 06:24:43 -0000 1.7
+++ tutorial.xml 20 Sep 2004 16:41:57 -0000
@@ -103,7 +103,7 @@
<subsection name="HttpException">
<p>An HttpException represents a logical error and is thrown when the request
cannot be sent or the response cannot be processed due to a fatal violation of
- the HTTP protocol violation. Usually this kind of exceptions cannot be recovered
+ the HTTP specification. Usually this kind of exceptions cannot be recovered
from. For a detailed discussion on protocol exceptions please refer to
<a href="exception-handling.html#Protocol exceptions">the HttpClient exception
handling guide</a>. Note that HttpException actually extends IOException
@@ -124,7 +124,7 @@
<subsection name="Method recovery">
<p>Per default HttpClient will automatically attempt to recover from the not-fatal
errors, that is, when a plain IOException is thrown. HttpClient will retry the
- method five times provided that the request has never been fully transmitted to
+ method three times provided that the request has never been fully transmitted to
the target server. For a detailed discussion on HTTP method recovery please refer
to <a href="exception-handling.html#HTTP transport safety">the HttpClient
exception handling guide</a></p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
