hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r775317 - in /httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http: auth/ auth/params/ client/params/ conn/params/ cookie/params/ impl/auth/ impl/client/
Date Fri, 15 May 2009 20:32:31 GMT
Author: olegk
Date: Fri May 15 20:32:30 2009
New Revision: 775317

URL: http://svn.apache.org/viewvc?rev=775317&view=rev
Log:
Javadoc updates

Added:
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html
  (with props)
Modified:
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeFactory.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeRegistry.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/Credentials.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTCredentials.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTUserPrincipal.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/UsernamePasswordCredentials.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/package.html
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthPNames.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParamBean.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParams.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/package.html
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnManagerParams.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnRouteParams.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/params/package.html
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicSchemeFactory.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestSchemeFactory.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngine.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMScheme.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java
    httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRequestDirector.java

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthScheme.java
Fri May 15 20:32:30 2009
@@ -34,34 +34,24 @@
 import org.apache.http.HttpRequest;
 
 /**
- * <p>
  * This interface represents an abstract challenge-response oriented 
  * authentication scheme.
- * </p>
  * <p>
  * An authentication scheme should be able to support the following
  * functions:
  * <ul>
- *   <li>Parse and process the challenge sent by the targer server
+ *   <li>Parse and process the challenge sent by the target server
  *       in response to request for a protected resource
  *   <li>Provide its textual designation
  *   <li>Provide its parameters, if available
  *   <li>Provide the realm this authentication scheme is applicable to,
  *       if available
- *   <li>Generate authorization string for the given set of credentials,
- *       request method and URI as specificed in the HTTP request line
- *       in response to the actual authorization challenge
+ *   <li>Generate authorization string for the given set of credentials
+ *       and the HTTP request in response to the authorization challenge. 
  * </ul>
- * </p>
- * <p>
- * Authentication schemes may ignore method name and URI parameters
- * if they are not relevant for the given authentication mechanism
- * </p>
  * <p>
  * Authentication schemes may be stateful involving a series of 
- * challenge-response exchanges
- * </p>
- * 
+ * challenge-response exchanges.
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeFactory.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeFactory.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeFactory.java
Fri May 15 20:32:30 2009
@@ -34,12 +34,19 @@
 import org.apache.http.params.HttpParams;
 
 /**
- * 
+ * Factory for {@link AuthScheme} implementations. 
  *
  * @since 4.0
  */
 public interface AuthSchemeFactory {    
 
+	/**
+	 * Creates an instance of {@link AuthScheme} using given HTTP parameters.
+	 * 
+	 * @param params HTTP parameters.
+	 * 
+	 * @return auth scheme.
+	 */
     AuthScheme newInstance(HttpParams params);
 
 }

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeRegistry.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeRegistry.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeRegistry.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/AuthSchemeRegistry.java
Fri May 15 20:32:30 2009
@@ -43,11 +43,8 @@
 
 /**
  * Authentication scheme registry that can be used to obtain the corresponding
- * authentication scheme implementation for a given type of authorization challenge. 
- * 
- *
- *
- * @version $Revision$
+ * authentication scheme implementation for a given type of authorization challenge.
+ *  
  * @since 4.0
  */
 @ThreadSafe

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/Credentials.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/Credentials.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/Credentials.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/Credentials.java
Fri May 15 20:32:30 2009
@@ -33,10 +33,9 @@
 import java.security.Principal;
 
 /**
- * User name and password based authentication credentials.
- * 
- * 
- * @version $Revision$ $Date$
+ * This interface represents a set of credentials consisting of a security 
+ * principal and a secret (password) that can be used to establish user
+ * identity
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTCredentials.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTCredentials.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTCredentials.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTCredentials.java
Fri May 15 20:32:30 2009
@@ -37,10 +37,11 @@
 
 import org.apache.http.util.LangUtils;
 
-/** {@link Credentials} specific to the Windows platform.
- *
+/** 
+ * {@link Credentials} implementation for Microsoft Windows platforms that includes 
+ * Windows specific attributes such as name of the domain the user belongs to.
  * 
- * @since 2.0
+ * @since 4.0
  */
 @Immutable
 public class NTCredentials implements Credentials {

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTUserPrincipal.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTUserPrincipal.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTUserPrincipal.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/NTUserPrincipal.java
Fri May 15 20:32:30 2009
@@ -37,8 +37,8 @@
 
 import org.apache.http.util.LangUtils;
 
-/**  NT (MS Windows specific) user principal used for HTTP authentication
- *
+/** 
+ * Microsoft Windows specific user principal implementation.
  * 
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/UsernamePasswordCredentials.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/UsernamePasswordCredentials.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/UsernamePasswordCredentials.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/UsernamePasswordCredentials.java
Fri May 15 20:32:30 2009
@@ -37,11 +37,8 @@
 import org.apache.http.util.LangUtils;
 
 /**
- * Username and password {@link Credentials}
- *
- * 
- * @version $Revision$ $Date$
- * 
+ * Simple {@link Credentials} implementation based on a user name / password 
+ * pair.
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/package.html
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/package.html?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/package.html
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/package.html
Fri May 15 20:32:30 2009
@@ -34,8 +34,6 @@
 -->
 </head>
 <body>
-The API for client-side HTTP authentication against a server,
-commonly referred to as <i>HttpAuth</i>.
-
+The API for client-side HTTP authentication against a server.
 </body>
 </html>

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthPNames.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthPNames.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthPNames.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthPNames.java
Fri May 15 20:32:30 2009
@@ -32,9 +32,7 @@
 package org.apache.http.auth.params;
 
 /**
- * Parameter names for HttpAuth.
- * 
- * @version $Revision$
+ * Parameter names for HTTP authentication classes.
  * 
  * @since 4.0
  */
@@ -45,11 +43,6 @@
      * {@link org.apache.http.auth.Credentials}.
      * <p>
      * This parameter expects a value of type {@link String}.
-     * If not defined, then
-     * {@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET
-     *        HttpProtocolParams.HTTP_ELEMENT_CHARSET}
-     * should be used.
-     * </p>
      */
     public static final String CREDENTIAL_CHARSET = "http.auth.credential-charset"; 
 

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParamBean.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParamBean.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParamBean.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParamBean.java
Fri May 15 20:32:30 2009
@@ -35,6 +35,9 @@
 import org.apache.http.params.HttpParams;
 
 /**
+ * This is a Java Bean class that can be used to wrap an instance of 
+ * {@link HttpParams} and manipulate HTTP authentication parameters 
+ * using Java Beans conventions.
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParams.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParams.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/AuthParams.java
Fri May 15 20:32:30 2009
@@ -37,11 +37,8 @@
 import org.apache.http.protocol.HTTP;
 
 /**
- * This class implements an adaptor around the {@link HttpParams} interface
- * to simplify manipulation of the HTTP authentication specific parameters.
- * 
- * 
- * @version $Revision$
+ * An adaptor for manipulating HTTP authentication parameters 
+ * in {@link HttpParams}.
  * 
  * @since 4.0
  *
@@ -55,15 +52,11 @@
     }
 
     /**
-     * Obtains the charset for encoding
-     * {@link org.apache.http.auth.Credentials}.
-     * If not configured,
-     * {@link HTTP#DEFAULT_PROTOCOL_CHARSET HTTP.DEFAULT_PROTOCOL_CHARSET}
-     * is used instead.
+     * Obtains the charset for encoding 
+     * {@link org.apache.http.auth.Credentials}.If not configured,
+     * {@link HTTP#DEFAULT_PROTOCOL_CHARSET}is used instead.
      * 
      * @return The charset
-     *
-     * @see AuthPNames#CREDENTIAL_CHARSET
      */
     public static String getCredentialCharset(final HttpParams params) {
         if (params == null) {
@@ -71,8 +64,6 @@
         }
         String charset = (String) params.getParameter
             (AuthPNames.CREDENTIAL_CHARSET);
-        //@@@ TODO: inconsistent with JavaDoc in AuthPNames,
-        //@@@ TODO: check HTTP_ELEMENT_CHARSET first, or fix JavaDocs
         if (charset == null) {
             charset = HTTP.DEFAULT_PROTOCOL_CHARSET;
         }

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/package.html
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/package.html?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/package.html
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/auth/params/package.html
Fri May 15 20:32:30 2009
@@ -34,7 +34,7 @@
 -->
 </head>
 <body>
-Parameters for configuring <i>HttpAuth</i>.
+Parameters for configuring HTTP authentication classes.
 
 </body>
 </html>

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/params/HttpClientParams.java
Fri May 15 20:32:30 2009
@@ -35,7 +35,7 @@
 import org.apache.http.params.HttpParams;
 
 /**
- * An adaptor for accessing HTTP client parameters in {@link HttpParams}.
+ * An adaptor for manipulating HTTP client parameters in {@link HttpParams}.
  * 
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnManagerParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnManagerParams.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnManagerParams.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnManagerParams.java
Fri May 15 20:32:30 2009
@@ -36,9 +36,8 @@
 import org.apache.http.params.HttpParams;
 
 /**
- * This class represents a collection of HTTP protocol parameters applicable
- * to client-side
- * {@link org.apache.http.conn.ClientConnectionManager connection managers}. 
+ * An adaptor for manipulating HTTP connection management 
+ * parameters in {@link HttpParams}.
  * 
  * @since 4.0
  *

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnRouteParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnRouteParams.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnRouteParams.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/params/ConnRouteParams.java
Fri May 15 20:32:30 2009
@@ -39,8 +39,8 @@
 import org.apache.http.conn.routing.HttpRoute;
 
 /**
- * An adaptor for accessing route related parameters in {@link HttpParams}.
- * See {@link ConnRoutePNames} for parameter name definitions.
+ * An adaptor for manipulating HTTP routing parameters 
+ * in {@link HttpParams}.
  * 
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/params/package.html
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/params/package.html?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/params/package.html
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/cookie/params/package.html
Fri May 15 20:32:30 2009
@@ -34,7 +34,6 @@
 -->
 </head>
 <body>
-Parameters for configuring HTTP state management 
-related classes.
+Parameters for configuring HTTP state management classes.
 </body>
 </html>

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicScheme.java
Fri May 15 20:32:30 2009
@@ -45,14 +45,16 @@
 import org.apache.http.util.EncodingUtils;
 
 /**
- * <p>
  * Basic authentication scheme as defined in RFC 2617.
- * </p>
- * 
+ * <p>
+ * The following parameters can be used to customize the behavior of this 
+ * class: 
+ * <ul>
+ *  <li>{@link org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET}</li>
+ * </ul>
  * 
  * @since 4.0
  */
-
 @NotThreadSafe
 public class BasicScheme extends RFC2617Scheme {
     
@@ -60,7 +62,7 @@
     private boolean complete;
     
     /**
-     * Default constructor for the basic authetication scheme.
+     * Default constructor for the basic authentication scheme.
      */
     public BasicScheme() {
         super();
@@ -113,10 +115,10 @@
     /**
      * Produces basic authorization header for the given set of {@link Credentials}.
      * 
-     * @param credentials The set of credentials to be used for athentication
+     * @param credentials The set of credentials to be used for authentication
      * @param request The request being authenticated
-     * @throws org.apache.http.auth.InvalidCredentialsException if authentication credentials
-     *         are not valid or not applicable for this authentication scheme
+     * @throws InvalidCredentialsException if authentication credentials are not 
+     *   valid or not applicable for this authentication scheme
      * @throws AuthenticationException if authorization string cannot 
      *   be generated due to an authentication failure
      * 

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicSchemeFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicSchemeFactory.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicSchemeFactory.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/BasicSchemeFactory.java
Fri May 15 20:32:30 2009
@@ -38,7 +38,8 @@
 import org.apache.http.params.HttpParams;
 
 /**
- * 
+ * {@link AuthSchemeFactory} implementation that creates and initializes
+ * {@link BasicScheme} instances.
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestScheme.java
Fri May 15 20:32:30 2009
@@ -51,24 +51,27 @@
 import org.apache.http.util.EncodingUtils;
 
 /**
- * <p>
  * Digest authentication scheme as defined in RFC 2617.
  * Both MD5 (default) and MD5-sess are supported.
  * Currently only qop=auth or no qop is supported. qop=auth-int
  * is unsupported. If auth and auth-int are provided, auth is
  * used.
- * </p>
  * <p>
  * Credential charset is configured via the 
- * {@link org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET
- *        credential charset} parameter.
+ * {@link org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET} 
+ * parameter of the HTTP request.
+ * <p>
  * Since the digest username is included as clear text in the generated 
  * Authentication header, the charset of the username must be compatible
  * with the 
  * {@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET
  *        http element charset}.
- * </p>
- * 
+ * <p>
+ * The following parameters can be used to customize the behavior of this 
+ * class: 
+ * <ul>
+ *  <li>{@link org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET}</li>
+ * </ul>
  * 
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestSchemeFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestSchemeFactory.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestSchemeFactory.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/DigestSchemeFactory.java
Fri May 15 20:32:30 2009
@@ -38,7 +38,8 @@
 import org.apache.http.params.HttpParams;
 
 /**
- * 
+ * {@link AuthSchemeFactory} implementation that creates and initializes
+ * {@link DigestScheme} instances.
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngine.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngine.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngine.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMEngine.java
Fri May 15 20:32:30 2009
@@ -34,9 +34,6 @@
  * Abstract NTLM authentication engine. The engine can be used to
  * generate Type1 messages and Type3 messages in response to a 
  * Type2 challenge.
- * <p/>
- * For details see <a href="http://davenport.sourceforge.net/ntlm.html">this resource</a>
- * 
  *
  * @since 4.0
  */

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMScheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMScheme.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMScheme.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/NTLMScheme.java
Fri May 15 20:32:30 2009
@@ -45,7 +45,15 @@
 import org.apache.http.util.CharArrayBuffer;
 
 /**
- *
+ * NTLM is a proprietary authentication scheme developed by Microsoft 
+ * and optimized for Windows platforms.
+ * <p>
+ * Please note that the NTLM scheme requires an external 
+ * {@link NTLMEngine} implementation to function!
+ * For details please refer to 
+ * <a href="http://hc.apache.org/httpcomponents-client/ntlm.html">
+ * this document</a>.
+ * 
  * @since 4.0
  */
 @NotThreadSafe

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/RFC2617Scheme.java
Fri May 15 20:32:30 2009
@@ -43,10 +43,9 @@
 
 /**
  * Abstract authentication scheme class that lays foundation for all
- * RFC 2617 compliant authetication schemes and provides capabilities common 
+ * RFC 2617 compliant authentication schemes and provides capabilities common 
  * to all authentication schemes defined in RFC 2617.
  *
- *
  * @since 4.0
  */
 public abstract class RFC2617Scheme extends AuthSchemeBase {
@@ -57,7 +56,7 @@
     private Map<String, String> params;
 
     /**
-     * Default constructor for RFC2617 compliant authetication schemes.
+     * Default constructor for RFC2617 compliant authentication schemes.
      */
     public RFC2617Scheme() {
         super();

Added: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html?rev=775317&view=auto
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html
(added)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html
Fri May 15 20:32:30 2009
@@ -0,0 +1,40 @@
+<html>
+<head>
+<!--
+/*
+ * $HeadURL:$
+ * $Revision:$
+ * $Date:$
+ *
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+-->
+</head>
+<body>
+Default implementations for interfaces in
+{@link org.apache.http.auth org.apache.http.auth}.
+</body>
+</html>

Propchange: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/package.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRequestDirector.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRequestDirector.java?rev=775317&r1=775316&r2=775317&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRequestDirector.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/DefaultRequestDirector.java
Fri May 15 20:32:30 2009
@@ -114,9 +114,15 @@
  *  <li>{@link org.apache.http.params.CoreConnectionPNames#TCP_NODELAY}</li>
  *  <li>{@link org.apache.http.params.CoreConnectionPNames#CONNECTION_TIMEOUT}</li>
  *  <li>{@link org.apache.http.params.CoreConnectionPNames#STALE_CONNECTION_CHECK}</li>
+ *  <li>{@link org.apache.http.conn.params.ConnRoutePNames#FORCED_ROUTE}</li>
+ *  <li>{@link org.apache.http.conn.params.ConnRoutePNames#LOCAL_ADDRESS}</li>
+ *  <li>{@link org.apache.http.conn.params.ConnRoutePNames#DEFAULT_PROXY}</li>
  *  <li>{@link org.apache.http.conn.params.ConnManagerPNames#TIMEOUT}</li>
+ *  <li>{@link org.apache.http.conn.params.ConnManagerPNames#MAX_CONNECTIONS_PER_ROUTE}</li>
+ *  <li>{@link org.apache.http.conn.params.ConnManagerPNames#MAX_TOTAL_CONNECTIONS}</li>
  *  <li>{@link org.apache.http.cookie.params.CookieSpecPNames#DATE_PATTERNS}</li>
  *  <li>{@link org.apache.http.cookie.params.CookieSpecPNames#SINGLE_COOKIE_HEADER}</li>
+ *  <li>{@link org.apache.http.auth.params.AuthPNames#CREDENTIAL_CHARSET}</li>
  *  <li>{@link org.apache.http.client.params.ClientPNames#COOKIE_POLICY}</li>
  *  <li>{@link org.apache.http.client.params.ClientPNames#VIRTUAL_HOST}</li>
  *  <li>{@link org.apache.http.client.params.ClientPNames#MAX_REDIRECTS}</li>



Mime
View raw message