You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ro...@apache.org on 2007/04/22 10:01:17 UTC
svn commit: r531154 - in
/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http: auth/
auth/params/ client/ cookie/ impl/auth/
Author: rolandw
Date: Sun Apr 22 01:01:16 2007
New Revision: 531154
URL: http://svn.apache.org/viewvc?view=rev&rev=531154
Log:
JavaDoc fixes in client/cookie/auth
Modified:
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthSchemeRegistry.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthScope.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/UsernamePasswordCredentials.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/params/AuthParams.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/client/HttpState.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/cookie/CookieSpecRegistry.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/BasicScheme.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/DigestScheme.java
jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/RFC2617Scheme.java
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthSchemeRegistry.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthSchemeRegistry.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthSchemeRegistry.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthSchemeRegistry.java Sun Apr 22 01:01:16 2007
@@ -55,7 +55,7 @@
/**
* Registers a {@link AuthSchemeFactory} with the given identifier. If a factory with the
* given name already exists it will be overridden. This name is the same one used to
- * retrieve the {@link AuthScheme authentication scheme} from {@link #getAuthScheme(String)}.
+ * retrieve the {@link AuthScheme authentication scheme} from {@link #getAuthScheme}.
*
* <p>
* Please note that custom authentication preferences, if used, need to be updated accordingly
@@ -65,7 +65,7 @@
* @param name the identifier for this scheme
* @param factory the {@link AuthSchemeFactory} class to register
*
- * @see #getAuthScheme(String)
+ * @see #getAuthScheme
*/
public synchronized void registerAuthScheme(
final String name,
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthScope.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthScope.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthScope.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/AuthScope.java Sun Apr 22 01:01:16 2007
@@ -35,7 +35,7 @@
/**
* The class represents an authentication scope consisting of a host name,
* a port number, a realm name and an authentication scheme name which
- * {@link org.apache.commons.httpclient.Credentials} apply to.
+ * {@link Credentials Credentials} apply to.
*
* @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
* @author <a href="mailto:adrian@intencha.com">Adrian Sutton</a>
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/UsernamePasswordCredentials.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/UsernamePasswordCredentials.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/UsernamePasswordCredentials.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/UsernamePasswordCredentials.java Sun Apr 22 01:01:16 2007
@@ -104,7 +104,6 @@
* User name property getter.
*
* @return the userName
- * @see #setUserName(String)
*/
public String getPrincipalName() {
return userName;
@@ -115,7 +114,6 @@
* Password property getter.
*
* @return the password
- * @see #setPassword(String)
*/
public String getPassword() {
return password;
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/params/AuthParams.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/params/AuthParams.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/params/AuthParams.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/auth/params/AuthParams.java Sun Apr 22 01:01:16 2007
@@ -48,8 +48,11 @@
/**
* Defines the charset to be used when encoding
- * {@link org.apache.http.auth.Credentials}. If not defined then the
- * {@link #HTTP_ELEMENT_CHARSET} should be used.
+ * {@link org.apache.http.auth.Credentials}.
+ * If not defined then the
+ * {@link org.apache.http.params.HttpProtocolParams#HTTP_ELEMENT_CHARSET
+ * HttpProtocolParams.HTTP_ELEMENT_CHARSET}
+ * should be used.
* <p>
* This parameter expects a value of type {@link String}.
* </p>
@@ -62,8 +65,11 @@
}
/**
- * Returns the charset to be used when encoding {@link org.apache.http.auth.Credentials}.
- * If not configured the {@link HTTP.DEFAULT_PROTOCOL_CHARSET} is used instead.
+ * Defines the charset to be used when encoding
+ * {@link org.apache.http.auth.Credentials}.
+ * If not configured,
+ * {@link HTTP#DEFAULT_PROTOCOL_CHARSET HTTP.DEFAULT_PROTOCOL_CHARSET}
+ * is used instead.
*
* @return The charset
*/
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/client/HttpState.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/client/HttpState.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/client/HttpState.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/client/HttpState.java Sun Apr 22 01:01:16 2007
@@ -138,9 +138,6 @@
* state currently contains.
*
* @return an array of {@link Cookie cookies}.
- *
- * @see #getCookies(String, int, String, boolean)
- *
*/
public synchronized Cookie[] getCookies() {
return (Cookie[]) (cookies.toArray(new Cookie[cookies.size()]));
@@ -150,11 +147,9 @@
* Removes all of {@link Cookie cookies} in this HTTP state
* that have expired by the specified {@link java.util.Date date}.
*
- * @param date The {@link java.util.Date date} to compare against.
- *
* @return true if any cookies were purged.
*
- * @see Cookie#isExpired(java.util.Date)
+ * @see Cookie#isExpired()
*
* @see #purgeExpiredCookies()
*/
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/cookie/CookieSpecRegistry.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/cookie/CookieSpecRegistry.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/cookie/CookieSpecRegistry.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/cookie/CookieSpecRegistry.java Sun Apr 22 01:01:16 2007
@@ -84,7 +84,7 @@
/**
* Unregisters the {@link CookieSpecFactory} with the given ID.
*
- * @param name the identifier of the {@link CookieSpec cookie specification} to unregister
+ * @param id the identifier of the {@link CookieSpec cookie specification} to unregister
*/
public synchronized void unregister(final String id) {
if (id == null) {
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/BasicScheme.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/BasicScheme.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/BasicScheme.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/BasicScheme.java Sun Apr 22 01:01:16 2007
@@ -84,7 +84,7 @@
/**
* Processes the Basic challenge.
*
- * @param challenge the challenge string
+ * @param header the challenge header
*
* @throws MalformedChallengeException is thrown if the authentication challenge
* is malformed
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/DigestScheme.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/DigestScheme.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/DigestScheme.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/DigestScheme.java Sun Apr 22 01:01:16 2007
@@ -57,11 +57,12 @@
* </p>
* <p>
* Credential charset is configured via the
- * {@link org.apache.commons.httpclient.params.HttpMethodParams#CREDENTIAL_CHARSET credential
- * charset} parameter. 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.commons.httpclient.params.HttpMethodParams#HTTP_ELEMENT_CHARSET http element
- * charset}.
+ * {@link AuthParams#CREDENTIAL_CHARSET credential charset} parameter.
+ * 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.HttpProtocolParams#HTTP_ELEMENT_CHARSET
+ * http element charset}.
* </p>
*
* @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
@@ -112,7 +113,7 @@
/**
* Processes the Digest challenge.
*
- * @param challenge the challenge string
+ * @param header the challenge header
*
* @throws MalformedChallengeException is thrown if the authentication challenge
* is malformed
@@ -198,7 +199,7 @@
* {@link Credentials}, method name and URI.
*
* @param credentials A set of credentials to be used for athentication
- * @param method The method being authenticated
+ * @param request The request being authenticated
*
* @throws InvalidCredentialsException if authentication credentials
* are not valid or not applicable for this authentication scheme
Modified: jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/RFC2617Scheme.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/RFC2617Scheme.java?view=diff&rev=531154&r1=531153&r2=531154
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/RFC2617Scheme.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/src/java/org/apache/http/impl/auth/RFC2617Scheme.java Sun Apr 22 01:01:16 2007
@@ -78,7 +78,7 @@
* may involve multiple challenge-response exchanges. Such schemes must be able
* to maintain the state information when dealing with sequential challenges
*
- * @param challenge the challenge string
+ * @param header the challenge header
*
* @throws MalformedChallengeException is thrown if the authentication challenge
* is malformed