Index: trunk/http-core/src/java/org/apache/http/RequestLine.java =================================================================== --- trunk/http-core/src/java/org/apache/http/RequestLine.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/RequestLine.java (working copy) @@ -33,8 +33,10 @@ import org.apache.http.protocol.HTTP; /** - *
- *
+ * The first line of an {@link HttpRequest HttpRequest}. + * It contains the method, URI, and HTTP version of the request. + * For details, see RFC 2616. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpProxyConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpProxyConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpProxyConnection.java (working copy) @@ -34,8 +34,8 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * An HTTP connection through a proxy. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HeaderElement.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HeaderElement.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HeaderElement.java (working copy) @@ -156,8 +156,10 @@ * This parses the value part of a header. The result is an array of * HeaderElement objects. * - * @param headerValue the array of char representation of the header value - * (as received from the web server). + * @param buffer the buffer from which to parse + * @param indexFrom where to start parsing in the buffer + * @param indexTo where to stop parsing in the buffer + * * @return array of {@link HeaderElement}s. * * @since 3.0 Index: trunk/http-core/src/java/org/apache/http/message/HttpGet.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/HttpGet.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/HttpGet.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http.message; /** - *- *
+ * A modifiable HTTP request with GET as the method. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/BasicHttpResponse.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/BasicHttpResponse.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/BasicHttpResponse.java (working copy) @@ -36,8 +36,8 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * Basic implementation of an HTTP response that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/HttpHead.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/HttpHead.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/HttpHead.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http.message; /** - *- *
+ * A modifiable HTTP request with HEAD as the method. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/HttpPost.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/HttpPost.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/HttpPost.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http.message; /** - *- *
+ * A modifiable HTTP request with POST as the method. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/BasicHttpMessage.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/BasicHttpMessage.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/BasicHttpMessage.java (working copy) @@ -38,8 +38,8 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Basic implementation of an HTTP message that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java (working copy) @@ -36,8 +36,8 @@ import org.apache.http.protocol.HTTP; /** - *- *
+ * Basic implementation of a request with an entity that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/message/BasicHttpRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/message/BasicHttpRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/message/BasicHttpRequest.java (working copy) @@ -35,8 +35,8 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * Basic implementation of an HTTP request that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/ConnectionClosedException.java =================================================================== --- trunk/http-core/src/java/org/apache/http/ConnectionClosedException.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/ConnectionClosedException.java (working copy) @@ -32,8 +32,8 @@ import java.io.IOException; /** - *- *
+ * Indicates that a connection has been closed. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpMutableResponse.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpMutableResponse.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpMutableResponse.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * An HTTP response that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestRetryHandler.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestRetryHandler.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestRetryHandler.java (working copy) @@ -41,7 +41,7 @@ import org.apache.http.protocol.HttpRequestRetryHandler; /** - * The default {@link HttpRequestRetryHandler} used by {@link HttpRequestExecutor}s. + * The default {@link HttpRequestRetryHandler} used by request executors. * * @author Michael Becke * @author Oleg Kalnichevski @@ -72,8 +72,6 @@ /** * UsedretryCount and requestSentRetryEnabled to determine
* if the given method should be retried.
- *
- * @see HttpMethodRetryHandler#retryMethod(HttpMethod, IOException, int)
*/
public boolean retryRequest(
final IOException exception,
Index: trunk/http-core/src/java/org/apache/http/impl/AbstractHttpConnection.java
===================================================================
--- trunk/http-core/src/java/org/apache/http/impl/AbstractHttpConnection.java (revision 376760)
+++ trunk/http-core/src/java/org/apache/http/impl/AbstractHttpConnection.java (working copy)
@@ -43,8 +43,8 @@
import org.apache.http.params.HttpParams;
/**
- * - *
+ * Abstract base class for HTTP connections on the client and server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpClientConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpClientConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpClientConnection.java (working copy) @@ -57,8 +57,8 @@ import org.apache.http.protocol.HTTP; /** - *- *
+ * Default implementation of a client-side HTTP connection. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpRequestFactory.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.message.BasicHttpRequest; /** - *- *
+ * Default implementation of a factory for creating request objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpProxyConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpProxyConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpProxyConnection.java (working copy) @@ -42,8 +42,8 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Default implementation of a client-side connection through a proxy. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataTransmitter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataTransmitter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataTransmitter.java (working copy) @@ -34,8 +34,8 @@ /** - *- *
+ * A data transmitter using a Java {@link Socket} and traditional IO. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataReceiver.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataReceiver.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataReceiver.java (working copy) @@ -40,7 +40,7 @@ import org.apache.http.protocol.HTTP; /** - * + * Abstract base class for data receivers. * * @author Oleg Kalnichevski * Index: trunk/http-core/src/java/org/apache/http/impl/io/SSLSocketFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/SSLSocketFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/io/SSLSocketFactory.java (working copy) @@ -40,7 +40,7 @@ import org.apache.http.params.HttpParams; /** - *A wrapper class for the standard JSSE SSLSocketFactory
+ * .A wrapper class for the standard JSSE SSLSocketFactory. * * @author Oleg Kalnichevski */ @@ -102,9 +102,7 @@ } } - /** - * @see SecureProtocolSocketFactory#createSocket(java.net.Socket,java.lang.String,int,boolean) - */ + // non-javadoc, see interface SocketFactory public Socket createSocket( Socket socket, String host, Index: trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataReceiver.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataReceiver.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/io/SocketHttpDataReceiver.java (working copy) @@ -35,8 +35,8 @@ /** - *- *
+ * A data receiver using a Java {@link Socket} and traditional IO. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataTransmitter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataTransmitter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/io/AbstractHttpDataTransmitter.java (working copy) @@ -40,7 +40,7 @@ import org.apache.http.protocol.HTTP; /** - * + * Abstract base class for data transmitters. * * @author Oleg Kalnichevski * Index: trunk/http-core/src/java/org/apache/http/impl/DefaultConnectionReuseStrategy.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultConnectionReuseStrategy.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultConnectionReuseStrategy.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.protocol.HTTP; /** - *- *
+ * Default implementation of a strategy deciding about connection re-use. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpResponseFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpResponseFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpResponseFactory.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.message.BasicHttpResponse; /** - *- *
+ * Default implementation of a factory for creating response objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/DefaultHttpServerConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/DefaultHttpServerConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/DefaultHttpServerConnection.java (working copy) @@ -51,8 +51,8 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Default implementation of a server-side HTTP connection. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/impl/entity/DefaultServerEntityWriter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/entity/DefaultServerEntityWriter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/entity/DefaultServerEntityWriter.java (working copy) @@ -42,8 +42,7 @@ import org.apache.http.io.IdentityOutputStream; /** - *- *
+ * Default implementation of an entity writer on the server side. * * @author Oleg Kalnichevski * Index: trunk/http-core/src/java/org/apache/http/impl/entity/DefaultEntityGenerator.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/entity/DefaultEntityGenerator.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/entity/DefaultEntityGenerator.java (working copy) @@ -48,6 +48,7 @@ import org.apache.http.protocol.HTTP; /** + * Default implementation of an entity generator. ** This entity generator comforms to the entity transfer rules outlined in the * Section 4.4, Index: trunk/http-core/src/java/org/apache/http/impl/entity/DefaultClientEntityWriter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/impl/entity/DefaultClientEntityWriter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/impl/entity/DefaultClientEntityWriter.java (working copy) @@ -42,8 +42,7 @@ import org.apache.http.io.HttpDataTransmitter; /** - *
- *
+ * Default implementation of an entity writer on the client side. * * @author Oleg Kalnichevski * Index: trunk/http-core/src/java/org/apache/http/protocol/HttpService.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpService.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpService.java (working copy) @@ -51,8 +51,13 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Minimalistic server-side implementation of an HTTP processor. + * We have no intention of competing with the Servlet API. + * This implementation will remain minimalistic. It is here as + * a proof-of-concept for our API. It can also be used for + * implementing simple server-side applications or tests that + * can be run without installing a servlet container first. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/AbstractHttpProcessor.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/AbstractHttpProcessor.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/AbstractHttpProcessor.java (working copy) @@ -41,8 +41,8 @@ import org.apache.http.HttpResponseInterceptor; /** - *- *
+ * Keeps lists of interceptors for processing requests and responses. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/RequestUserAgent.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/RequestUserAgent.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/RequestUserAgent.java (working copy) @@ -38,8 +38,8 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * A request interceptor that adds a User-Agent header. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/RequestExpectContinue.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/RequestExpectContinue.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/RequestExpectContinue.java (working copy) @@ -41,8 +41,8 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * A request interceptor that enables the expect-continue handshake. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/RequestConnControl.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/RequestConnControl.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/RequestConnControl.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.HttpRequestInterceptor; /** - *- *
+ * A request interceptor that suggests connection keep-alive to the server. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HttpRequestExecutor.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpRequestExecutor.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpRequestExecutor.java (working copy) @@ -45,8 +45,10 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Sends HTTP requests and receives the responses. + * Takes care of request preprocessing and response postprocessing + * by the respective interceptors. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HttpExecutionContext.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpExecutionContext.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpExecutionContext.java (working copy) @@ -34,8 +34,8 @@ /** - *- *
+ * Default implementation of the {@link HttpContext HttpContext}. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HttpRequestRetryHandler.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpRequestRetryHandler.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpRequestRetryHandler.java (working copy) @@ -50,10 +50,10 @@ * Determines if a method should be retried after an IOException * occurs during execution. * - * @param request the request being executed * @param exception the exception that occurred * @param executionCount the number of times this method has been * unsuccessfully executed + * @param context the context for the request execution * * @returntrue if the method should be retried, false
* otherwise
Index: trunk/http-core/src/java/org/apache/http/protocol/ResponseConnControl.java
===================================================================
--- trunk/http-core/src/java/org/apache/http/protocol/ResponseConnControl.java (revision 376760)
+++ trunk/http-core/src/java/org/apache/http/protocol/ResponseConnControl.java (working copy)
@@ -41,8 +41,9 @@
import org.apache.http.HttpVersion;
/**
- * - *
+ * A response interceptor that suggests connection keep-alive to the client. + * For use on the server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HTTP.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HTTP.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HTTP.java (working copy) @@ -30,15 +30,15 @@ package org.apache.http.protocol; /** - *- *
+ * Constants and static helpers related to the HTTP protocol. + * * @author Oleg Kalnichevski * * @version $Revision$ * * @since 4.0 */ -public class HTTP { +public final class HTTP { public static final int CR = 13; //- *
+ * A request interceptor that decides about the transport encoding. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HttpDateGenerator.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpDateGenerator.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpDateGenerator.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.util.DateUtils; /** - *- *
+ * Generates a date in the format required by the HTTP protocol. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/HttpContext.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/HttpContext.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/HttpContext.java (working copy) @@ -30,8 +30,12 @@ package org.apache.http.protocol; /** - *- *
+ * A context for executing a request. + * The context is used to tie together the request, the response, + * and optional application data. It is also used for internal data. + * Attribute names starting with the prefix "http." are + * {@link #RESERVED_PREFIX reserved} for internal data. + * * @author Oleg Kalnichevski * * @version $Revision$ @@ -40,6 +44,8 @@ */ public interface HttpContext { + /** The prefix reserved for use by HTTP components. "http." */ + public static final String RESERVED_PREFIX = "http."; public static final String HTTP_CONNECTION = "http.connection"; public static final String HTTP_REQUEST = "http.request"; public static final String HTTP_RESPONSE = "http.response"; Index: trunk/http-core/src/java/org/apache/http/protocol/ResponseServer.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/ResponseServer.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/ResponseServer.java (working copy) @@ -38,8 +38,9 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * A response interceptor that adds a Server header. + * For use on the server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/ResponseContent.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/ResponseContent.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/ResponseContent.java (working copy) @@ -39,8 +39,9 @@ import org.apache.http.HttpVersion; /** - *- *
+ * A response interceptor that sets up entity-related headers. + * For use on the server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/ResponseDate.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/ResponseDate.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/ResponseDate.java (working copy) @@ -38,8 +38,9 @@ import org.apache.http.HttpStatus; /** - *- *
+ * A response interceptor that adds a Date header. + * For use on the server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/protocol/RequestTargetHost.java =================================================================== --- trunk/http-core/src/java/org/apache/http/protocol/RequestTargetHost.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/protocol/RequestTargetHost.java (working copy) @@ -39,8 +39,8 @@ import org.apache.http.params.HttpProtocolParams; /** - *- *
+ * A request interceptor that sets the Host header for HTTP/1.1 requests. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpResponseFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpResponseFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpResponseFactory.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * A factory for {@link HttpResponse HttpResponse} objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpEntityEnclosingRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpEntityEnclosingRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpEntityEnclosingRequest.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * A request with an entity. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpRequest.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * An HTTP request. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpClientConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpClientConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpClientConnection.java (working copy) @@ -35,8 +35,9 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * An HTTP connection for use on the client side. + * It is used for sending requests and receiving responses. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpConnection.java (working copy) @@ -32,8 +32,8 @@ import java.io.IOException; /** - *- *
+ * A generic HTTP connection, useful on client and server side. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpMutableEntityEnclosingRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpMutableEntityEnclosingRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpMutableEntityEnclosingRequest.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * An HTTP request with an entity that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpMutableRequest.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpMutableRequest.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpMutableRequest.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * An HTTP request that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/params/HttpConnectionParams.java =================================================================== --- trunk/http-core/src/java/org/apache/http/params/HttpConnectionParams.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/params/HttpConnectionParams.java (working copy) @@ -45,7 +45,7 @@ * Defines the default socket timeout (SO_TIMEOUT) in milliseconds which is the * timeout for waiting for data. A timeout value of zero is interpreted as an infinite * timeout. This value is used when no socket timeout is set in the - * {@link HttpMethodParams HTTP method parameters}. + * method parameters. ** This parameter expects a value of type {@link Integer}. *
@@ -68,7 +68,7 @@ /** * Determines the size of the internal socket buffer used to buffer data - * while receiving / transmitting HTTP messages + * while receiving / transmitting HTTP messages. ** This parameter expects a value of type {@link Integer}. *
@@ -117,7 +117,7 @@ * Returns the default socket timeout (SO_TIMEOUT) in milliseconds which is the * timeout for waiting for data. A timeout value of zero is interpreted as an infinite * timeout. This value is used when no socket timeout is set in the - * {@link HttpMethodParams HTTP method parameters}. + * method parameters. * * @return timeout in milliseconds */ @@ -132,7 +132,7 @@ * Sets the default socket timeout (SO_TIMEOUT) in milliseconds which is the * timeout for waiting for data. A timeout value of zero is interpreted as an infinite * timeout. This value is used when no socket timeout is set in the - * {@link HttpMethodParams HTTP method parameters}. + * method parameters. * * @param timeout Timeout in milliseconds */ Index: trunk/http-core/src/java/org/apache/http/params/HttpProtocolParams.java =================================================================== --- trunk/http-core/src/java/org/apache/http/params/HttpProtocolParams.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/params/HttpProtocolParams.java (working copy) @@ -34,7 +34,7 @@ /** * This class implements an adaptor around the {@link HttpParams} interface - * to simplify manipulation of the HTTP connection specific parameters. + * to simplify manipulation of the HTTP protocol specific parameters. * * @author Oleg Kalnichevski * @@ -53,8 +53,8 @@ public static final String PROTOCOL_VERSION = "http.protocol.version"; /** - * Defines the charset to be used when encoding - * {@link org.apache.commons.httpclient.Credentials}. If not defined then the + * Defines the charset to be used when encoding credentials. + * If not defined then the * {@link #HTTP_ELEMENT_CHARSET} should be used. ** This parameter expects a value of type {@link String}. @@ -144,8 +144,7 @@ /** *
* Activates 'Expect: 100-Continue' handshake for the - * {@link org.apache.commons.httpclient.methods.ExpectContinueMethod - * entity enclosing methods}. The purpose of the 'Expect: 100-Continue' + * entity enclosing methods. The purpose of the 'Expect: 100-Continue' * handshake to allow a client that is sending a request message with * a request body to determine if the origin server is willing to * accept the request (based on the request headers) before the client @@ -230,8 +229,9 @@ } /** - * Returns the charset to be used for {@link org.apache.commons.httpclient.Credentials}. If - * not configured the {@link #HTTP_ELEMENT_CHARSET HTTP element charset} is used. + * Returns the charset to be used for credentials. + * If not configured the {@link #HTTP_ELEMENT_CHARSET HTTP element charset} + * is used. * @return The charset */ public static String getCredentialCharset(final HttpParams params) { @@ -274,8 +274,7 @@ /** * Assigns the {@link HttpVersion HTTP protocol version} to be used by the - * {@link org.apache.commons.httpclient.HttpMethod HTTP methods} that - * this collection of parameters applies to. + * HTTP methods that this collection of parameters applies to. * * @param version the {@link HttpVersion HTTP protocol version} */ Index: trunk/http-core/src/java/org/apache/http/HttpEntity.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpEntity.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpEntity.java (working copy) @@ -45,7 +45,7 @@ *
- *
+ * A factory for {@link HttpRequest HttpRequest} objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpMessage.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpMessage.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpMessage.java (working copy) @@ -32,8 +32,9 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * A generic HTTP message. + * Holds what is common between requests and responses. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpServerConnection.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpServerConnection.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpServerConnection.java (working copy) @@ -35,8 +35,9 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * An HTTP connection for use on the server side. + * Requests are received, responses are sent. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/MethodNotSupportedException.java =================================================================== --- trunk/http-core/src/java/org/apache/http/MethodNotSupportedException.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/MethodNotSupportedException.java (working copy) @@ -31,8 +31,8 @@ /** - *- *
+ * Indicates that an HTTP method is not supported. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/ConnectionReuseStrategy.java =================================================================== --- trunk/http-core/src/java/org/apache/http/ConnectionReuseStrategy.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/ConnectionReuseStrategy.java (working copy) @@ -31,8 +31,8 @@ /** - *- *
+ * Interface for deciding whether a connection should be kept alive. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/MalformedChunkCodingException.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/MalformedChunkCodingException.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/MalformedChunkCodingException.java (working copy) @@ -32,7 +32,7 @@ import java.io.IOException; /** - * Signals a malformed chunked stream + * Signals a malformed chunked stream. */ public class MalformedChunkCodingException extends IOException { Index: trunk/http-core/src/java/org/apache/http/io/HttpDataInputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataInputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataInputStream.java (working copy) @@ -33,8 +33,8 @@ import java.io.InputStream; /** - *- *
+ * A stream for reading from a {@link HttpDataReceiver HttpDataReceiver}. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitter.java (working copy) @@ -34,8 +34,10 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Interface for sending data. + * Unlike {@link java.io.OutputStream}, this interface is tailored + * to the needs of the HTTP components. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/HttpDataOutputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataOutputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataOutputStream.java (working copy) @@ -33,8 +33,8 @@ import java.io.OutputStream; /** - *- *
+ * A stream for writing to a {@link HttpDataTransmitter HttpDataTransmitter}. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/CharArrayBuffer.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/CharArrayBuffer.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/CharArrayBuffer.java (working copy) @@ -32,6 +32,8 @@ import org.apache.http.protocol.HTTP; /** + * A resizable char array. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/ContentLengthOutputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/ContentLengthOutputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/ContentLengthOutputStream.java (working copy) @@ -33,8 +33,8 @@ import java.io.OutputStream; /** - *- *
+ * A stream wrapper that closes itself after a defined number of bytes. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/ChunkedInputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/ChunkedInputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/ChunkedInputStream.java (working copy) @@ -164,8 +164,6 @@ * @return -1 of the end of the stream has been reached or the next data * byte * @throws IOException If an IO problem occurs - * - * @see HttpMethod#getResponseFooters() */ public int read() throws IOException { if (this.closed) { Index: trunk/http-core/src/java/org/apache/http/io/ChunkedOutputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/ChunkedOutputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/ChunkedOutputStream.java (working copy) @@ -116,7 +116,7 @@ // ----------------------------------------------------------- Constructors /** * Wraps a stream and chunks the output. - * @param stream to wrap + * @param out the transmitter to wrap * @param bufferSize minimum chunk size (excluding last chunk) * @throws IOException * @@ -132,7 +132,7 @@ /** * Wraps a data transmitter and chunks the output. The default buffer size of 2048 was * chosen because the chunk overhead is less than 0.5% - * @param stream + * @param datatransmitter the transmitter to wrap * @throws IOException */ public ChunkedOutputStream(final HttpDataTransmitter datatransmitter) Index: trunk/http-core/src/java/org/apache/http/io/IdentityOutputStream.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/IdentityOutputStream.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/IdentityOutputStream.java (working copy) @@ -33,8 +33,8 @@ import java.io.OutputStream; /** - *- *
+ * A stream for writing with an "identity" transport encoding. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/HttpDataReceiverFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataReceiverFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataReceiverFactory.java (working copy) @@ -33,8 +33,8 @@ import java.net.Socket; /** - *- *
+ * Factory for {@link HttpDataReceiver HttpDataReceiver} objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/SecureSocketFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/SecureSocketFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/SecureSocketFactory.java (working copy) @@ -34,10 +34,9 @@ import java.net.UnknownHostException; /** - * A ProtocolSocketFactory that is secure. + * A {@link SocketFactory SocketFactory} for secure sockets (SSL/TLS). + * See there for things to consider when implementing a socket factory. * - * @see org.apache.commons.httpclient.protocol.ProtocolSocketFactory - * * @author Michael Becke * @author Mike Bowler * @since 2.0 Index: trunk/http-core/src/java/org/apache/http/io/ByteArrayBuffer.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/ByteArrayBuffer.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/ByteArrayBuffer.java (working copy) @@ -30,6 +30,8 @@ package org.apache.http.io; /** + * A resizable byte array. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitterFactory.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitterFactory.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataTransmitterFactory.java (working copy) @@ -33,8 +33,8 @@ import java.net.Socket; /** - *- *
+ * Factory for {@link HttpDataTransmitter HttpDataTransmitter} objects. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/io/HttpDataReceiver.java =================================================================== --- trunk/http-core/src/java/org/apache/http/io/HttpDataReceiver.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/io/HttpDataReceiver.java (working copy) @@ -34,8 +34,10 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * Interface for receiving data. + * Unlike {@link java.io.InputStream}, this interface is tailored + * to the needs of the HTTP components. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/Header.java =================================================================== --- trunk/http-core/src/java/org/apache/http/Header.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/Header.java (working copy) @@ -138,7 +138,7 @@ /** * Returns an array of {@link HeaderElement}s constructed from my value. * - * @see HeaderElement#parseElements(String) + * @see HeaderElement#parseAll * * @return an array of header elements * Index: trunk/http-core/src/java/org/apache/http/NameValuePair.java =================================================================== --- trunk/http-core/src/java/org/apache/http/NameValuePair.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/NameValuePair.java (working copy) @@ -37,7 +37,7 @@ import org.apache.http.util.LangUtils; /** - *A simple class encapsulating an attribute/value pair
+ * A simple class encapsulating an attribute/value pair. ** This class comforms to the generic grammar and formatting rules outlined in the * Section 2.2 @@ -382,7 +382,7 @@ * Produces textual representaion of the attribute/value pair using * formatting rules defined in RFC 2616 * - * @params param the parameters to be formatted + * @param params the parameters to be formatted * @param alwaysUseQuotes true if the parameter values must * always be enclosed in quotation marks, false otherwise * Index: trunk/http-core/src/java/org/apache/http/StatusLine.java =================================================================== --- trunk/http-core/src/java/org/apache/http/StatusLine.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/StatusLine.java (working copy) @@ -94,7 +94,9 @@ /** * Parses the status line returned from the HTTP server. * - * @param statusLine the status line to be parsed + * @param buffer the buffer from which to parse + * @param indexFrom where to start parsing in the buffer + * @param indexTo where to stop parsing in the buffer * * @throws HttpException if the status line is invalid * Index: trunk/http-core/src/java/org/apache/http/entity/EntityGenerator.java =================================================================== --- trunk/http-core/src/java/org/apache/http/entity/EntityGenerator.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/entity/EntityGenerator.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.io.HttpDataReceiver; /** - *
- *
+ * Generates entities when HTTP messages are received. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/entity/EntityWriter.java =================================================================== --- trunk/http-core/src/java/org/apache/http/entity/EntityWriter.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/entity/EntityWriter.java (working copy) @@ -37,8 +37,8 @@ import org.apache.http.io.HttpDataTransmitter; /** - *- *
+ * Writes an entity when HTTP messages are sent. + * * @author Oleg Kalnichevski * * @version $Revision: $ Index: trunk/http-core/src/java/org/apache/http/entity/BasicHttpEntity.java =================================================================== --- trunk/http-core/src/java/org/apache/http/entity/BasicHttpEntity.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/entity/BasicHttpEntity.java (working copy) @@ -34,8 +34,8 @@ import java.io.OutputStream; /** - *- *
+ * A generic streamed entity being received on a connection. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/util/NumUtils.java =================================================================== --- trunk/http-core/src/java/org/apache/http/util/NumUtils.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/util/NumUtils.java (working copy) @@ -3,6 +3,10 @@ import org.apache.http.io.CharArrayBuffer; import org.apache.http.protocol.HTTP; + +/** + * Static helpers for dealing with numbers in string representation. + */ public class NumUtils { private NumUtils() { Index: trunk/http-core/src/java/org/apache/http/util/LangUtils.java =================================================================== --- trunk/http-core/src/java/org/apache/http/util/LangUtils.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/util/LangUtils.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http.util; /** - * A set of utility methods to help produce consistent Object#equals(Object) and - * Object#hashCode methods. + * A set of utility methods to help produce consistent + * {@link Object#equals equals} and {@link Object#hashCode hashCode} methods. * * @author Oleg Kalnichevski * Index: trunk/http-core/src/java/org/apache/http/util/DateParseException.java =================================================================== --- trunk/http-core/src/java/org/apache/http/util/DateParseException.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/util/DateParseException.java (working copy) @@ -33,7 +33,7 @@ /** * An exception to indicate an error parsing a date string. * - * @see DateUtil + * @see DateUtils * * @author Michael Becke */ Index: trunk/http-core/src/java/org/apache/http/util/EntityUtils.java =================================================================== --- trunk/http-core/src/java/org/apache/http/util/EntityUtils.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/util/EntityUtils.java (working copy) @@ -42,8 +42,8 @@ import org.apache.http.protocol.HTTP; /** - *- *
+ * Static helpers for dealing with {@link HttpEntity entities}. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpResponse.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpResponse.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpResponse.java (working copy) @@ -30,8 +30,8 @@ package org.apache.http; /** - *- *
+ * An HTTP response. + * * @author Oleg Kalnichevski * * @version $Revision$ Index: trunk/http-core/src/java/org/apache/http/HttpMutableMessage.java =================================================================== --- trunk/http-core/src/java/org/apache/http/HttpMutableMessage.java (revision 376760) +++ trunk/http-core/src/java/org/apache/http/HttpMutableMessage.java (working copy) @@ -34,8 +34,8 @@ import org.apache.http.params.HttpParams; /** - *- *
+ * An HTTP message that can be modified. + * * @author Oleg Kalnichevski * * @version $Revision$