You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ol...@apache.org on 2005/09/23 20:13:37 UTC

svn commit: r291181 - in /jakarta/commons/proper/httpclient/trunk: src/java/org/apache/commons/httpclient/ src/java/org/apache/commons/httpclient/auth/ src/java/org/apache/commons/httpclient/util/ xdocs/

Author: olegk
Date: Fri Sep 23 11:13:25 2005
New Revision: 291181

URL: http://svn.apache.org/viewcvs?rev=291181&view=rev
Log:
Various, mostly minor, documentation changes suggested by the users or required as a result of user feedback

Modified:
    jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java
    jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/ChunkedInputStream.java
    jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java
    jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/util/TimeoutController.java
    jakarta/commons/proper/httpclient/trunk/xdocs/authentication.xml
    jakarta/commons/proper/httpclient/trunk/xdocs/troubleshooting.xml
    jakarta/commons/proper/httpclient/trunk/xdocs/tutorial.xml

Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java (original)
+++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/AutoCloseInputStream.java Fri Sep 23 11:13:25 2005
@@ -37,7 +37,7 @@
  * Closes an underlying stream as soon as the end of the stream is reached, and
  * notifies a client when it has done so.
  *
- * @author Ortwin Glück
+ * @author Ortwin Glueck
  * @author Eric Johnson
  * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
  *

Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/ChunkedInputStream.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/ChunkedInputStream.java?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/ChunkedInputStream.java (original)
+++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/ChunkedInputStream.java Fri Sep 23 11:13:25 2005
@@ -49,7 +49,7 @@
  * not requiring the client to remember to read the entire contents of the
  * response.</p>
  *
- * @author Ortwin Glück
+ * @author Ortwin Glueck
  * @author Sean C. Sullivan
  * @author Martin Elwin
  * @author Eric Johnson

Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java (original)
+++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java Fri Sep 23 11:13:25 2005
@@ -38,9 +38,21 @@
  * to request authentication credentials if no credentials have been given 
  * or given credentials are incorrect. 
  * </p>
- * 
+ * <p>
+ * HttpClient makes no provisions to check whether the same credentials have 
+ * been tried already. It is a responsibility of the custom credentials 
+ * provider to keep track of authentication attempts and to ensure that 
+ * credentials known to be invalid are not retried. HttpClient will simply 
+ * store the set of credentials returned by the custom credentials provider 
+ * in the {@link HttpState http state} object and will attempt to use these 
+ * credentials for all subsequent requests with the given authentication 
+ * scope.
+ * </p>
+ * <p>
  * Classes implementing this interface must synchronize access to shared
  * data as methods of this interfrace may be executed from multiple threads 
+ * </p>
+ * 
  * 
  * @author Ortwin Glueck
  * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>

Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/util/TimeoutController.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/util/TimeoutController.java?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/util/TimeoutController.java (original)
+++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/util/TimeoutController.java Fri Sep 23 11:13:25 2005
@@ -33,7 +33,7 @@
  * <p>
  * Executes a task with a specified timeout.
  * </p>
- * @author Ortwin Glück
+ * @author Ortwin Glueck
  * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
  * @version $Revision$
  * @since 2.0

Modified: jakarta/commons/proper/httpclient/trunk/xdocs/authentication.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/xdocs/authentication.xml?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/xdocs/authentication.xml (original)
+++ jakarta/commons/proper/httpclient/trunk/xdocs/authentication.xml Fri Sep 23 11:13:25 2005
@@ -252,6 +252,21 @@
          <strong>Workaround:</strong> Disable stale connection check or upgrade to Java 1.4 or above.
          </p>         
         </li>
+        <li>
+         <p>
+          <strong>Cannot authenticate with Microsoft IIS using NTLM authentication scheme</strong>
+         </p>
+         <p>
+           NT Lan Manager (NTLM) authentication is a proprietary, closed challenge/response authentication 
+           protocol for Microsoft Windows. Only some details about NTLM protocol are available through 
+           reverse engineering. HttpClient provides limited support for what is known as NTLMv1, the early 
+           version of the NTLM protocol. HttpClient does not support NTLMv2 at all.
+         </p>
+         <p>
+         <strong>Workaround:</strong> Disable NTLMv2. For details refer to this Microsoft Support
+         <a href="http://support.microsoft.com/default.aspx?scid=KB;en-us;239869">Article</a>
+         </p>         
+        </li>
       </ol>
       
     </section>

Modified: jakarta/commons/proper/httpclient/trunk/xdocs/troubleshooting.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/xdocs/troubleshooting.xml?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/xdocs/troubleshooting.xml (original)
+++ jakarta/commons/proper/httpclient/trunk/xdocs/troubleshooting.xml Fri Sep 23 11:13:25 2005
@@ -32,6 +32,16 @@
           <em>HttpClient</em> as described in the <a
         href="tutorial.html">tutorial</a>.</li>
 
+        <li>Set the <code>User-Agent</code> request header to masquerade <em>HttpClient
+        </em> as a popular browser such as IE or Firefox. Certain web sites are optimized
+        to work with just one or a number of specific browser applications. These sites 
+        frequently reject requests originating from user agents they do not recognize.
+        For example, setting the <code>User-Agent</code> request header to <code>
+        Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)</code> would deceive the target 
+        server into believing that the request was issues by Microsoft Internet Explorer 
+        6.0 on Windows 2000.
+        </li>
+
         <li>Set the <a href="logging.html">logging level</a> to debug and check
         the output for the cause of the problem.</li>
 

Modified: jakarta/commons/proper/httpclient/trunk/xdocs/tutorial.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/httpclient/trunk/xdocs/tutorial.xml?rev=291181&r1=291180&r2=291181&view=diff
==============================================================================
--- jakarta/commons/proper/httpclient/trunk/xdocs/tutorial.xml (original)
+++ jakarta/commons/proper/httpclient/trunk/xdocs/tutorial.xml Fri Sep 23 11:13:25 2005
@@ -20,7 +20,7 @@
     </section>
 
     <section name="Getting Ready">
-      <p>The first thing you need to do is get a copy of <em>HttpClient</em> and it's
+      <p>The first thing you need to do is get a copy of <em>HttpClient</em> and its
       <a href="dependencies.html">dependencies</a>. This tutorial was
       written for <em>HttpClient</em> 3.0.  You will also need JDK 1.3 or above.</p>
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org