* Please note that custom authentication preferences, if used, need to be updated accordingly @@ -65,7 +65,7 @@ public final class AuthSchemeRegistry { * @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, diff --git a/src/java/org/apache/http/auth/AuthScope.java b/src/java/org/apache/http/auth/AuthScope.java index 7a3d5b74a..58b4564dc 100644 --- a/src/java/org/apache/http/auth/AuthScope.java +++ b/src/java/org/apache/http/auth/AuthScope.java @@ -35,7 +35,7 @@ import org.apache.http.util.LangUtils; /** * 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 Oleg Kalnichevski * @author Adrian Sutton diff --git a/src/java/org/apache/http/auth/UsernamePasswordCredentials.java b/src/java/org/apache/http/auth/UsernamePasswordCredentials.java index 3b1da7816..3ee24339a 100644 --- a/src/java/org/apache/http/auth/UsernamePasswordCredentials.java +++ b/src/java/org/apache/http/auth/UsernamePasswordCredentials.java @@ -104,7 +104,6 @@ public class UsernamePasswordCredentials implements Credentials { * User name property getter. * * @return the userName - * @see #setUserName(String) */ public String getPrincipalName() { return userName; @@ -115,7 +114,6 @@ public class UsernamePasswordCredentials implements Credentials { * Password property getter. * * @return the password - * @see #setPassword(String) */ public String getPassword() { return password; diff --git a/src/java/org/apache/http/auth/params/AuthParams.java b/src/java/org/apache/http/auth/params/AuthParams.java index 19addccc9..421682285 100644 --- a/src/java/org/apache/http/auth/params/AuthParams.java +++ b/src/java/org/apache/http/auth/params/AuthParams.java @@ -48,8 +48,11 @@ public final class AuthParams { /** * 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. *
* This parameter expects a value of type {@link String}. *
@@ -62,8 +65,11 @@ public final class AuthParams { } /** - * 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 */ diff --git a/src/java/org/apache/http/client/HttpState.java b/src/java/org/apache/http/client/HttpState.java index 7a3e37cb4..490345689 100644 --- a/src/java/org/apache/http/client/HttpState.java +++ b/src/java/org/apache/http/client/HttpState.java @@ -138,9 +138,6 @@ public class HttpState { * 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 @@ public class HttpState { * 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() */ diff --git a/src/java/org/apache/http/cookie/CookieSpecRegistry.java b/src/java/org/apache/http/cookie/CookieSpecRegistry.java index da19e0e8f..8fef281f7 100644 --- a/src/java/org/apache/http/cookie/CookieSpecRegistry.java +++ b/src/java/org/apache/http/cookie/CookieSpecRegistry.java @@ -84,7 +84,7 @@ public final class CookieSpecRegistry { /** * 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) { diff --git a/src/java/org/apache/http/impl/auth/BasicScheme.java b/src/java/org/apache/http/impl/auth/BasicScheme.java index 2d2c9a818..186829134 100644 --- a/src/java/org/apache/http/impl/auth/BasicScheme.java +++ b/src/java/org/apache/http/impl/auth/BasicScheme.java @@ -84,7 +84,7 @@ public class BasicScheme extends RFC2617Scheme { /** * Processes the Basic challenge. * - * @param challenge the challenge string + * @param header the challenge header * * @throws MalformedChallengeException is thrown if the authentication challenge * is malformed diff --git a/src/java/org/apache/http/impl/auth/DigestScheme.java b/src/java/org/apache/http/impl/auth/DigestScheme.java index 05ff6108b..b57cf621c 100644 --- a/src/java/org/apache/http/impl/auth/DigestScheme.java +++ b/src/java/org/apache/http/impl/auth/DigestScheme.java @@ -57,11 +57,12 @@ import org.apache.http.util.EncodingUtils; * ** 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}. *
* * @author Remy Maucherat @@ -112,7 +113,7 @@ public class DigestScheme extends RFC2617Scheme { /** * 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 @@ public class DigestScheme extends RFC2617Scheme { * {@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 diff --git a/src/java/org/apache/http/impl/auth/RFC2617Scheme.java b/src/java/org/apache/http/impl/auth/RFC2617Scheme.java index ce36373bc..0115755b9 100644 --- a/src/java/org/apache/http/impl/auth/RFC2617Scheme.java +++ b/src/java/org/apache/http/impl/auth/RFC2617Scheme.java @@ -78,7 +78,7 @@ public abstract class RFC2617Scheme implements AuthScheme { * 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