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
parent
d715ace629
commit
28c9b07691
|
|
@ -63,11 +63,35 @@ public interface ClientContext {
|
|||
*/
|
||||
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";
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -42,6 +42,7 @@ import org.apache.http.cookie.CookieSpecRegistry;
|
|||
import org.apache.http.protocol.HttpContext;
|
||||
|
||||
/**
|
||||
* Configuration facade for {@link HttpContext} instances.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
|
|
@ -72,6 +73,10 @@ public class ClientContextConfigurer implements ClientContext {
|
|||
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);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -46,9 +46,6 @@ import org.apache.http.protocol.HttpContext;
|
|||
/**
|
||||
* Request interceptor that adds default request headers.
|
||||
*
|
||||
*
|
||||
* @version $Revision$
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
@Immutable
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ import org.apache.http.auth.Credentials;
|
|||
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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ import org.apache.http.auth.Credentials;
|
|||
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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
-->
|
||||
</head>
|
||||
<body>
|
||||
Additional request and response interceptors.
|
||||
|
||||
Additional request and response interceptors for HTTP state and
|
||||
authentication management.
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -52,10 +52,6 @@ public class URIUtils {
|
|||
* {@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
|
||||
|
|
|
|||
|
|
@ -126,4 +126,9 @@ public abstract class AuthSchemeBase implements AuthScheme {
|
|||
return this.proxy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return getSchemeName();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -40,8 +40,7 @@ import org.apache.http.auth.Credentials;
|
|||
import org.apache.http.client.CredentialsProvider;
|
||||
|
||||
/**
|
||||
* Default implementation of {@link CredentialsProvider}
|
||||
*
|
||||
* Default implementation of {@link CredentialsProvider}.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
|
|
@ -59,16 +58,6 @@ public class BasicCredentialsProvider implements CredentialsProvider {
|
|||
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 @@ public class BasicCredentialsProvider implements CredentialsProvider {
|
|||
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 @@ public class BasicCredentialsProvider implements CredentialsProvider {
|
|||
return credMap.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears all credentials.
|
||||
*/
|
||||
public synchronized void clear() {
|
||||
this.credMap.clear();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -208,4 +208,9 @@ public class BestMatchSpec implements CookieSpec {
|
|||
return getStrict().getVersionHeader();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "best-match";
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -193,4 +193,9 @@ public class BrowserCompatSpec extends CookieSpecBase {
|
|||
return DATE_PATTERNS.clone();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "compatibility";
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -177,4 +177,9 @@ public class NetscapeDraftSpec extends CookieSpecBase {
|
|||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "netscape";
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -243,4 +243,9 @@ public class RFC2109Spec extends CookieSpecBase {
|
|||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "rfc2109";
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -248,5 +248,10 @@ public class RFC2965Spec extends RFC2109Spec {
|
|||
return new BufferedHeader(buffer);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "rfc2965";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue