You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2009/05/23 14:41:03 UTC
svn commit: r777904 - in
/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http:
client/protocol/ client/utils/ impl/auth/ impl/client/ impl/cookie/
Author: olegk
Date: Sat May 23 12:41:02 2009
New Revision: 777904
URL: http://svn.apache.org/viewvc?rev=777904&view=rev
Log:
Javadoc cleanups
Modified:
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/package.html
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java Sat May 23 12:41:02 2009
@@ -63,11 +63,35 @@
*/
public static final String COOKIE_STORE = "http.cookie-store";
+ /**
+ * Attribute name of a {@link org.apache.http.auth.AuthSchemeRegistry}
+ * object that represents the actual authentication scheme registry.
+ */
public static final String AUTHSCHEME_REGISTRY = "http.authscheme-registry";
+
+ /**
+ * Attribute name of a {@link org.apache.http.client.CredentialsProvider}
+ * object that represents the actual crednetials provider.
+ */
public static final String CREDS_PROVIDER = "http.auth.credentials-provider";
+
+ /**
+ * Attribute name of a {@link org.apache.http.auth.AuthState}
+ * object that represents the actual target authentication state.
+ */
public static final String TARGET_AUTH_STATE = "http.auth.target-scope";
+
+ /**
+ * Attribute name of a {@link org.apache.http.auth.AuthState}
+ * object that represents the actual proxy authentication state.
+ */
public static final String PROXY_AUTH_STATE = "http.auth.proxy-scope";
+
+ /**
+ * RESERVED. DO NOT USE!!!
+ */
public static final String AUTH_SCHEME_PREF = "http.auth.scheme-pref";
+
public static final String USER_TOKEN = "http.user-token";
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java Sat May 23 12:41:02 2009
@@ -42,6 +42,7 @@
import org.apache.http.protocol.HttpContext;
/**
+ * Configuration facade for {@link HttpContext} instances.
*
* @since 4.0
*/
@@ -72,6 +73,10 @@
this.context.setAttribute(CREDS_PROVIDER, provider);
}
+ /**
+ * @deprecated to be replaced with a special parameter in 4.1
+ */
+ @Deprecated
public void setAuthSchemePref(final List<String> list) {
this.context.setAttribute(AUTH_SCHEME_PREF, list);
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java Sat May 23 12:41:02 2009
@@ -45,9 +45,6 @@
/**
* Request interceptor that adds default request headers.
- *
- *
- * @version $Revision$
*
* @since 4.0
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java Sat May 23 12:41:02 2009
@@ -48,8 +48,8 @@
import org.apache.http.protocol.HttpContext;
/**
- *
- * @version $Revision$
+ * Generates authentication header for the proxy host, if required,
+ * based on the actual state of the HTTP authentication context.
*
* @since 4.0
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java Sat May 23 12:41:02 2009
@@ -48,8 +48,8 @@
import org.apache.http.protocol.HttpContext;
/**
- *
- * @version $Revision$
+ * Generates authentication header for the target host, if required,
+ * based on the actual state of the HTTP authentication context.
*
* @since 4.0
*/
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/package.html
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/package.html?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/package.html (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/protocol/package.html Sat May 23 12:41:02 2009
@@ -34,7 +34,7 @@
-->
</head>
<body>
-Additional request and response interceptors.
-
+Additional request and response interceptors for HTTP state and
+authentication management.
</body>
</html>
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java Sat May 23 12:41:02 2009
@@ -52,10 +52,6 @@
* {@link URI#URI(String, String, String, int, String, String, String)}
* or any of the other URI multi-argument URI constructors.
*
- * See <a
- * href="https://issues.apache.org/jira/browse/HTTPCLIENT-730">HTTPCLIENT-730</a>
- * for more information.
- *
* @param scheme
* Scheme name
* @param host
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java Sat May 23 12:41:02 2009
@@ -125,5 +125,10 @@
public boolean isProxy() {
return this.proxy;
}
+
+ @Override
+ public String toString() {
+ return getSchemeName();
+ }
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java Sat May 23 12:41:02 2009
@@ -40,8 +40,7 @@
import org.apache.http.client.CredentialsProvider;
/**
- * Default implementation of {@link CredentialsProvider}
- *
+ * Default implementation of {@link CredentialsProvider}.
*
* @since 4.0
*/
@@ -59,16 +58,6 @@
this.credMap = new HashMap<AuthScope, Credentials>();
}
- /**
- * Sets the {@link Credentials credentials} for the given authentication
- * scope. Any previous credentials for the given scope will be overwritten.
- *
- * @param authscope the {@link AuthScope authentication scope}
- * @param credentials the authentication {@link Credentials credentials}
- * for the given scope.
- *
- * @see #getCredentials(AuthScope)
- */
public synchronized void setCredentials(
final AuthScope authscope,
final Credentials credentials) {
@@ -110,14 +99,6 @@
return creds;
}
- /**
- * Get the {@link Credentials credentials} for the given authentication scope.
- *
- * @param authscope the {@link AuthScope authentication scope}
- * @return the credentials
- *
- * @see #setCredentials(AuthScope, Credentials)
- */
public synchronized Credentials getCredentials(final AuthScope authscope) {
if (authscope == null) {
throw new IllegalArgumentException("Authentication scope may not be null");
@@ -130,9 +111,6 @@
return credMap.toString();
}
- /**
- * Clears all credentials.
- */
public synchronized void clear() {
this.credMap.clear();
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java Sat May 23 12:41:02 2009
@@ -208,4 +208,9 @@
return getStrict().getVersionHeader();
}
+ @Override
+ public String toString() {
+ return "best-match";
+ }
+
}
\ No newline at end of file
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java Sat May 23 12:41:02 2009
@@ -193,4 +193,9 @@
return DATE_PATTERNS.clone();
}
+ @Override
+ public String toString() {
+ return "compatibility";
+ }
+
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java Sat May 23 12:41:02 2009
@@ -177,4 +177,9 @@
return null;
}
+ @Override
+ public String toString() {
+ return "netscape";
+ }
+
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java Sat May 23 12:41:02 2009
@@ -243,4 +243,9 @@
return null;
}
+ @Override
+ public String toString() {
+ return "rfc2109";
+ }
+
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java?rev=777904&r1=777903&r2=777904&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java Sat May 23 12:41:02 2009
@@ -248,5 +248,10 @@
return new BufferedHeader(buffer);
}
+ @Override
+ public String toString() {
+ return "rfc2965";
+ }
+
}