Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc cleanups 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@777904 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2009-05-23 12:41:02 +00:00
parent d715ace629
commit 28c9b07691
14 changed files with 66 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
httpclient/src/main/java/org/apache/http/client/protocol/ClientContext.java
View File

@ -63,11 +63,35 @@ public interface ClientContext {
*/ */
public static final String COOKIE_STORE = "http.cookie-store"; 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"; 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"; 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"; 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"; 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 AUTH_SCHEME_PREF = "http.auth.scheme-pref";
public static final String USER_TOKEN = "http.user-token"; public static final String USER_TOKEN = "http.user-token";
} }

5
httpclient/src/main/java/org/apache/http/client/protocol/ClientContextConfigurer.java
View File

@ -42,6 +42,7 @@ import org.apache.http.cookie.CookieSpecRegistry;
import org.apache.http.protocol.HttpContext; import org.apache.http.protocol.HttpContext;
/** /**
* Configuration facade for {@link HttpContext} instances.
* *
* @since 4.0 * @since 4.0
*/ */
@ -72,6 +73,10 @@ public class ClientContextConfigurer implements ClientContext {
this.context.setAttribute(CREDS_PROVIDER, provider); 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) { public void setAuthSchemePref(final List<String> list) {
this.context.setAttribute(AUTH_SCHEME_PREF, list); this.context.setAttribute(AUTH_SCHEME_PREF, list);
} }

3
httpclient/src/main/java/org/apache/http/client/protocol/RequestDefaultHeaders.java
View File

@ -46,9 +46,6 @@ import org.apache.http.protocol.HttpContext;
/** /**
* Request interceptor that adds default request headers. * Request interceptor that adds default request headers.
* *
*
* @version $Revision$
*
* @since 4.0 * @since 4.0
*/ */
@Immutable @Immutable

4
httpclient/src/main/java/org/apache/http/client/protocol/RequestProxyAuthentication.java
View File

@ -48,8 +48,8 @@ import org.apache.http.auth.Credentials;
import org.apache.http.protocol.HttpContext; import org.apache.http.protocol.HttpContext;
/** /**
* * Generates authentication header for the proxy host, if required,
* @version $Revision$ * based on the actual state of the HTTP authentication context.
* *
* @since 4.0 * @since 4.0
*/ */

4
httpclient/src/main/java/org/apache/http/client/protocol/RequestTargetAuthentication.java
View File

@ -48,8 +48,8 @@ import org.apache.http.auth.Credentials;
import org.apache.http.protocol.HttpContext; import org.apache.http.protocol.HttpContext;
/** /**
* * Generates authentication header for the target host, if required,
* @version $Revision$ * based on the actual state of the HTTP authentication context.
* *
* @since 4.0 * @since 4.0
*/ */

4
httpclient/src/main/java/org/apache/http/client/protocol/package.html
View File

@ -34,7 +34,7 @@
--> -->
</head> </head>
<body> <body>
Additional request and response interceptors. Additional request and response interceptors for HTTP state and
authentication management.
</body> </body>
</html> </html>

4
httpclient/src/main/java/org/apache/http/client/utils/URIUtils.java
View File

@ -52,10 +52,6 @@ public class URIUtils {
* {@link URI#URI(String, String, String, int, String, String, String)} * {@link URI#URI(String, String, String, int, String, String, String)}
* or any of the other URI multi-argument URI constructors. * 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 * @param scheme
* Scheme name * Scheme name
* @param host * @param host

5
httpclient/src/main/java/org/apache/http/impl/auth/AuthSchemeBase.java
View File

@ -126,4 +126,9 @@ public abstract class AuthSchemeBase implements AuthScheme {
return this.proxy; return this.proxy;
} }
@Override
public String toString() {
return getSchemeName();
}
} }

24
httpclient/src/main/java/org/apache/http/impl/client/BasicCredentialsProvider.java
View File

@ -40,8 +40,7 @@ import org.apache.http.auth.Credentials;
import org.apache.http.client.CredentialsProvider; import org.apache.http.client.CredentialsProvider;
/** /**
* Default implementation of {@link CredentialsProvider} * Default implementation of {@link CredentialsProvider}.
*
* *
* @since 4.0 * @since 4.0
*/ */
@ -59,16 +58,6 @@ public class BasicCredentialsProvider implements CredentialsProvider {
this.credMap = new HashMap<AuthScope, Credentials>(); 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( public synchronized void setCredentials(
final AuthScope authscope, final AuthScope authscope,
final Credentials credentials) { final Credentials credentials) {
@ -110,14 +99,6 @@ public class BasicCredentialsProvider implements CredentialsProvider {
return creds; 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) { public synchronized Credentials getCredentials(final AuthScope authscope) {
if (authscope == null) { if (authscope == null) {
throw new IllegalArgumentException("Authentication scope may not be null"); throw new IllegalArgumentException("Authentication scope may not be null");
@ -130,9 +111,6 @@ public class BasicCredentialsProvider implements CredentialsProvider {
return credMap.toString(); return credMap.toString();
} }
/**
* Clears all credentials.
*/
public synchronized void clear() { public synchronized void clear() {
this.credMap.clear(); this.credMap.clear();
} }

5
httpclient/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java
View File

@ -208,4 +208,9 @@ public class BestMatchSpec implements CookieSpec {
return getStrict().getVersionHeader(); return getStrict().getVersionHeader();
} }
@Override
public String toString() {
return "best-match";
}
} }

5
httpclient/src/main/java/org/apache/http/impl/cookie/BrowserCompatSpec.java
View File

@ -193,4 +193,9 @@ public class BrowserCompatSpec extends CookieSpecBase {
return DATE_PATTERNS.clone(); return DATE_PATTERNS.clone();
} }
@Override
public String toString() {
return "compatibility";
}
} }

5
httpclient/src/main/java/org/apache/http/impl/cookie/NetscapeDraftSpec.java
View File

@ -177,4 +177,9 @@ public class NetscapeDraftSpec extends CookieSpecBase {
return null; return null;
} }
@Override
public String toString() {
return "netscape";
}
} }

5
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2109Spec.java
View File

@ -243,4 +243,9 @@ public class RFC2109Spec extends CookieSpecBase {
return null; return null;
} }
@Override
public String toString() {
return "rfc2109";
}
} }

5
httpclient/src/main/java/org/apache/http/impl/cookie/RFC2965Spec.java
View File

@ -248,5 +248,10 @@ public class RFC2965Spec extends RFC2109Spec {
return new BufferedHeader(buffer); return new BufferedHeader(buffer);
} }
@Override
public String toString() {
return "rfc2965";
}
} }