Add @since 4.0 tags
git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@744698 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastian Bazley
parent
5ea4bb730c
commit
56ed074057
|
|
@ -37,6 +37,8 @@ import java.security.Principal;
|
|||
*
|
||||
*
|
||||
* @version $Revision$ $Date$
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface Credentials {
|
||||
|
||||
|
|
|
|||
|
|
@ -40,6 +40,8 @@ import org.apache.http.util.LangUtils;
|
|||
*
|
||||
* @version $Revision$ $Date$
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class UsernamePasswordCredentials implements Credentials {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.apache.http.auth.MalformedChallengeException;
|
|||
import org.apache.http.protocol.HttpContext;
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface AuthenticationHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -34,6 +34,8 @@ import java.io.IOException;
|
|||
|
||||
/**
|
||||
* Signals an error in the HTTP protocol.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ClientProtocolException extends IOException {
|
||||
|
||||
|
|
|
|||
|
|
@ -44,6 +44,8 @@ import org.apache.http.protocol.HttpContext;
|
|||
* data as methods of this interfrace may be executed from multiple threads
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface HttpRequestRetryHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/*
|
||||
* $HeadURL: $
|
||||
* $Revision: $
|
||||
* $Date: $
|
||||
* $HeadURL$
|
||||
* $Revision$
|
||||
* $Date$
|
||||
*
|
||||
* ====================================================================
|
||||
*
|
||||
|
|
@ -32,6 +32,8 @@ package org.apache.http.client;
|
|||
|
||||
/**
|
||||
* Signals a non 2xx HTTP response.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class HttpResponseException extends ClientProtocolException {
|
||||
|
||||
|
|
|
|||
|
|
@ -47,6 +47,8 @@ import org.apache.http.protocol.HttpContext;
|
|||
* data as methods of this interfrace may be executed from multiple threads
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface RedirectHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -40,6 +40,8 @@ import org.apache.http.protocol.HTTP;
|
|||
/**
|
||||
* An entity composed of a list of url-encoded pairs.
|
||||
* This is typically useful while sending an HTTP POST request.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class UrlEncodedFormEntity extends StringEntity {
|
||||
|
||||
|
|
|
|||
|
|
@ -45,6 +45,8 @@ import java.net.URI;
|
|||
* status code returned from the origin server indicates that the action
|
||||
* has been completed successfully.
|
||||
* </blockquote>
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class HttpDelete extends HttpRequestBase {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ package org.apache.http.client.protocol;
|
|||
/**
|
||||
* {@link org.apache.http.protocol.HttpContext Context}
|
||||
* attribute names for client.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface ClientContext {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ import java.lang.reflect.Method;
|
|||
|
||||
/**
|
||||
* A collection of utilities to workaround limitations of Java clone framework.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class CloneUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -32,6 +32,8 @@ package org.apache.http.client.utils;
|
|||
|
||||
/**
|
||||
* Abstraction of international domain name (IDN) conversion.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface Idn {
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ import java.lang.reflect.Method;
|
|||
|
||||
/**
|
||||
* Uses the java.net.IDN class through reflection.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class JdkIdn implements Idn {
|
||||
private Method toUnicode;
|
||||
|
|
|
|||
|
|
@ -33,6 +33,8 @@ package org.apache.http.client.utils;
|
|||
/**
|
||||
* Facade that provides conversion between Unicode and Punycode domain names.
|
||||
* It will use an appropriate implementation.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class Punycode {
|
||||
private static Idn impl;
|
||||
|
|
|
|||
|
|
@ -34,6 +34,8 @@ import java.util.StringTokenizer;
|
|||
|
||||
/**
|
||||
* Implementation from pseudo code in RFC 3492.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class Rfc3492Idn implements Idn {
|
||||
private static final int base = 36;
|
||||
|
|
|
|||
|
|
@ -38,6 +38,8 @@ import org.apache.http.HttpHost;
|
|||
/**
|
||||
* A collection of utilities for {@link URI URIs}, to workaround
|
||||
* bugs within the class or for ease-of-use features.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class URIUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -48,6 +48,8 @@ import org.apache.http.util.EntityUtils;
|
|||
|
||||
/**
|
||||
* A collection of utilities for encoding URLs.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class URLEncodedUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ import java.util.concurrent.TimeUnit;
|
|||
|
||||
/**
|
||||
* Encapsulates a request for a {@link ManagedClientConnection}.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface ClientConnectionRequest {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,6 +37,8 @@ import org.apache.http.HttpHost;
|
|||
/**
|
||||
* A {@link ConnectException} that specifies the {@link HttpHost} that was
|
||||
* being connected to.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class HttpHostConnectException extends ConnectException {
|
||||
|
||||
|
|
|
|||
|
|
@ -51,6 +51,8 @@ import org.apache.http.params.HttpParams;
|
|||
* the {@link #connectSocket(Socket, String, int, InetAddress, int, HttpParams)}
|
||||
* method cannot be reliably interrupted by closing the socket returned by the
|
||||
* {@link #createSocket()} method.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public final class MultihomePlainSocketFactory implements SocketFactory {
|
||||
|
||||
|
|
|
|||
|
|
@ -38,6 +38,8 @@ import org.apache.http.params.HttpParams;
|
|||
* Allows for setting parameters relating to connections on
|
||||
* {@link HttpParams}. This class ensures that the values set on the params
|
||||
* are type-safe.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ConnConnectionParamBean extends HttpAbstractParamBean {
|
||||
|
||||
|
|
|
|||
|
|
@ -38,6 +38,8 @@ import org.apache.http.params.HttpParams;
|
|||
* Allows for setting parameters relating to connection managers on
|
||||
* {@link HttpParams}. This class ensures that the values set on the params
|
||||
* are type-safe.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ConnManagerParamBean extends HttpAbstractParamBean {
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import org.apache.http.params.HttpParams;
|
|||
* Allows for setting parameters relating to connection routes on
|
||||
* {@link HttpParams}. This class ensures that the values set on the params
|
||||
* are type-safe.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ConnRouteParamBean extends HttpAbstractParamBean {
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import org.apache.http.protocol.HttpContext;
|
|||
* Encapsulates logic to compute a {@link HttpRoute} to a target host.
|
||||
* Implementations may for example be based on parameters, or on the
|
||||
* standard Java system properties.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface HttpRoutePlanner {
|
||||
|
||||
|
|
|
|||
|
|
@ -44,6 +44,8 @@ import org.apache.http.params.HttpParams;
|
|||
/**
|
||||
* The default class for creating sockets.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public final class PlainSocketFactory implements SocketFactory {
|
||||
|
||||
|
|
|
|||
|
|
@ -49,6 +49,8 @@ import org.apache.http.util.LangUtils;
|
|||
* SchemeRegistry.DEFAULT.register(https);
|
||||
* </pre>
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public final class Scheme {
|
||||
|
||||
|
|
|
|||
|
|
@ -47,6 +47,8 @@ import org.apache.http.params.HttpParams;
|
|||
* and {@link java.lang.Object#hashCode() Object.hashCode()}
|
||||
* must be overridden for the correct operation of some connection managers.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface SocketFactory {
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,8 @@ import javax.net.ssl.SSLSocket;
|
|||
* Abstract base class for all standard {@link X509HostnameVerifier}
|
||||
* implementations.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public abstract class AbstractVerifier implements X509HostnameVerifier {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ package org.apache.http.conn.ssl;
|
|||
* The ALLOW_ALL HostnameVerifier essentially turns hostname verification
|
||||
* off. This implementation is a no-op, and never throws the SSLException.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class AllowAllHostnameVerifier extends AbstractVerifier {
|
||||
|
||||
|
|
|
|||
|
|
@ -43,6 +43,8 @@ import javax.net.ssl.SSLException;
|
|||
* (such as "*.foo.com") with BROWSER_COMPATIBLE matches all subdomains,
|
||||
* including "a.b.foo.com".
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BrowserCompatHostnameVerifier extends AbstractVerifier {
|
||||
|
||||
|
|
|
|||
|
|
@ -134,6 +134,8 @@ import java.security.UnrecoverableKeyException;
|
|||
* </p>
|
||||
* </li>
|
||||
* </ul>
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
|
||||
public class SSLSocketFactory implements LayeredSocketFactory {
|
||||
|
|
|
|||
|
|
@ -50,6 +50,8 @@ import javax.net.ssl.SSLException;
|
|||
* level, for example "a.foo.com". It does not match deeper subdomains
|
||||
* such as "a.b.foo.com".
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class StrictHostnameVerifier extends AbstractVerifier {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ import java.util.regex.Pattern;
|
|||
|
||||
/**
|
||||
* A collection of utilities relating to InetAddresses.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class InetAddressUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import java.util.Comparator;
|
|||
* their domain attributes match ignoring case.
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class CookieIdentityComparator implements Serializable, Comparator<Cookie> {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import java.util.Comparator;
|
|||
* comparison is undefined.
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class CookiePathComparator implements Serializable, Comparator<Cookie> {
|
||||
|
||||
|
|
|
|||
|
|
@ -53,6 +53,8 @@ import org.apache.http.protocol.HttpContext;
|
|||
import org.apache.http.util.CharArrayBuffer;
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public abstract class AbstractAuthenticationHandler implements AuthenticationHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -73,6 +73,8 @@ import org.apache.http.params.AbstractHttpParams;
|
|||
*
|
||||
*
|
||||
* @version $Revision$
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ClientParamsStack extends AbstractHttpParams {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import org.apache.http.protocol.ExecutionContext;
|
|||
/**
|
||||
* The default {@link HttpRequestRetryHandler} used by request executors.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class DefaultHttpRequestRetryHandler implements HttpRequestRetryHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.apache.http.auth.MalformedChallengeException;
|
|||
import org.apache.http.protocol.HttpContext;
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class DefaultProxyAuthenticationHandler extends AbstractAuthenticationHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.apache.http.auth.MalformedChallengeException;
|
|||
import org.apache.http.protocol.HttpContext;
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class DefaultTargetAuthenticationHandler extends AbstractAuthenticationHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,6 +37,8 @@ import java.util.Set;
|
|||
|
||||
/**
|
||||
* A collection of URIs that were used as redirects.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class RedirectLocations {
|
||||
|
||||
|
|
|
|||
|
|
@ -53,6 +53,8 @@ import org.apache.http.conn.params.ConnRouteParams;
|
|||
* {@link org.apache.http.conn.params.ConnRoutePNames parameters}.
|
||||
* It will not make use of any Java system properties,
|
||||
* nor of system or browser proxy settings.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class DefaultHttpRoutePlanner implements HttpRoutePlanner {
|
||||
|
||||
|
|
|
|||
|
|
@ -62,6 +62,8 @@ import org.apache.http.conn.params.ConnRouteParams;
|
|||
* {@link org.apache.http.conn.params.ConnRoutePNames parameters},
|
||||
* though not the {@link
|
||||
* org.apache.http.conn.params.ConnRoutePNames#DEFAULT_PROXY DEFAULT_PROXY}.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ProxySelectorRoutePlanner implements HttpRoutePlanner {
|
||||
|
||||
|
|
|
|||
|
|
@ -54,6 +54,8 @@ import org.apache.http.impl.conn.IdleConnectionHandler;
|
|||
* The abstract pool includes a {@link #poolLock}, which is used to
|
||||
* synchronize access to the internal pool datastructures.
|
||||
* Don't use <code>synchronized</code> for that purpose!
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public abstract class AbstractConnPool implements RefQueueHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import org.apache.http.impl.conn.AbstractPoolEntry;
|
|||
|
||||
/**
|
||||
* Basic implementation of a connection pool entry.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BasicPoolEntry extends AbstractPoolEntry {
|
||||
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import org.apache.http.conn.routing.HttpRoute;
|
|||
* A weak reference to a {@link BasicPoolEntry BasicPoolEntry}.
|
||||
* This reference explicitly keeps the planned route, so the connection
|
||||
* can be reclaimed if it is lost to garbage collection.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BasicPoolEntryRef extends WeakReference<BasicPoolEntry> {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.apache.http.impl.conn.AbstractPooledConnAdapter;
|
|||
* A connection wrapper and callback handler.
|
||||
* All connections given out by the manager are wrappers which
|
||||
* can be {@link #detach detach}ed to prevent further use on release.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BasicPooledConnAdapter extends AbstractPooledConnAdapter {
|
||||
|
||||
|
|
|
|||
|
|
@ -62,6 +62,8 @@ import org.apache.http.params.HttpParams;
|
|||
* {@link AbstractConnPool#poolLock poolLock} in the base class,
|
||||
* not via <code>synchronized</code> methods.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class ConnPoolByRoute extends AbstractConnPool {
|
||||
|
||||
|
|
|
|||
|
|
@ -36,6 +36,8 @@ import org.apache.http.conn.ConnectionPoolTimeoutException;
|
|||
|
||||
/**
|
||||
* Encapsulates a request for a {@link BasicPoolEntry}.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface PoolEntryRequest {
|
||||
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@ import java.lang.ref.Reference;
|
|||
|
||||
/**
|
||||
* Callback handler for {@link RefQueueWorker RefQueueWorker}.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public interface RefQueueHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import org.apache.commons.logging.LogFactory;
|
|||
* If that feature is used, a daemon thread should be executing
|
||||
* this worker. It will pick up the queued references and pass them
|
||||
* on to a handler for appropriate processing.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class RefQueueWorker implements Runnable {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import org.apache.http.util.LangUtils;
|
|||
* A connection sub-pool for a specific route, used by {@link ConnPoolByRoute}.
|
||||
* The methods in this class are unsynchronized. It is expected that the
|
||||
* containing pool takes care of synchronization.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class RouteSpecificPool {
|
||||
|
||||
|
|
|
|||
|
|
@ -45,6 +45,8 @@ import java.util.concurrent.locks.Condition;
|
|||
* passed to the constructor.
|
||||
* Instances of this class do <i>not</i> synchronize access!
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class WaitingThread {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import org.apache.http.cookie.SetCookie;
|
|||
*
|
||||
*
|
||||
* @version $Revision$
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BasicClientCookie implements SetCookie, ClientCookie, Cloneable {
|
||||
|
||||
|
|
|
|||
|
|
@ -40,6 +40,8 @@ import org.apache.http.cookie.SetCookie2;
|
|||
* that the HTTP agent and the target server can exchange to maintain
|
||||
* a session as specified by RFC2965.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class BasicClientCookie2 extends BasicClientCookie implements SetCookie2 {
|
||||
|
||||
|
|
|
|||
|
|
@ -37,6 +37,8 @@ package org.apache.http.impl.cookie;
|
|||
*
|
||||
* @see DateUtils
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class DateParseException extends Exception {
|
||||
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ import java.util.TimeZone;
|
|||
* other headers. This class handles dates as defined by RFC 2616 section
|
||||
* 3.3.1 as well as some other common non-standard formats.
|
||||
*
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public final class DateUtils {
|
||||
|
||||
|
|
|
|||
|
|
@ -49,6 +49,8 @@ import org.apache.http.cookie.SetCookie;
|
|||
* cookies from apparent domains that are not publicly available.
|
||||
* An uptodate list of suffixes can be obtained from
|
||||
* <a href="http://publicsuffix.org/">publicsuffix.org</a>
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class PublicSuffixFilter implements CookieAttributeHandler {
|
||||
private CookieAttributeHandler wrapped;
|
||||
|
|
|
|||
|
|
@ -40,6 +40,8 @@ import java.util.Collection;
|
|||
/**
|
||||
* Parses the list from <a href="http://publicsuffix.org/">publicsuffix.org</a>
|
||||
* and configures a PublicSuffixFilter.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class PublicSuffixListParser {
|
||||
private static final int MAX_LINE_LEN = 256;
|
||||
|
|
|
|||
|
|
@ -43,6 +43,8 @@ import org.apache.http.cookie.SetCookie2;
|
|||
|
||||
/**
|
||||
* <tt>"Port"</tt> cookie attribute handler for RFC 2965 cookie spec.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class RFC2965PortAttributeHandler implements CookieAttributeHandler {
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ import org.apache.http.cookie.SetCookie2;
|
|||
|
||||
/**
|
||||
* <tt>"Version"</tt> cookie attribute handler for RFC 2965 cookie spec.
|
||||
*
|
||||
* @since 4.0
|
||||
*/
|
||||
public class RFC2965VersionAttributeHandler implements CookieAttributeHandler {
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue