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/04/15 20:09:27 UTC
svn commit: r765290 - in /httpcomponents/httpcore/trunk:
httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/
httpcore/src/main/java/org/apache/http/impl/
httpcore/src/main/java/org/apache/http/impl/entity/
httpcore/src/main/java/org/apache/htt...
Author: olegk
Date: Wed Apr 15 18:09:24 2009
New Revision: 765290
URL: http://svn.apache.org/viewvc?rev=765290&view=rev
Log:
Javadoc cleanups
Modified:
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/AbstractIOReactor.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpClientConnection.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpServerConnection.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpClientConnection.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpServerConnection.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/entity/LaxContentLengthStrategy.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractMessageParser.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionInputBuffer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionOutputBuffer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpRequestParser.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpResponseParser.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketOutputBuffer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/message/BasicHttpRequest.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestExpectContinue.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestUserAgent.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/ResponseServer.java
httpcomponents/httpcore/trunk/httpcore/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/AbstractIOReactor.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/AbstractIOReactor.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/AbstractIOReactor.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/AbstractIOReactor.java Wed Apr 15 18:09:24 2009
@@ -579,9 +579,8 @@
}
/**
- * Adds an {@link org.apache.http.impl.nio.reactor.IOSessionQueueElement IOSessionQueueElement}
- * to the {@link java.nio.channels.SelectionKey#interestOps(int) interestOps(int)} queue for
- * this instance.
+ * Adds an {@link InterestOpEntry} to the interest ops queue for this instance.
+ *
* @return <code>true</code> if the operation could be performed successfully,
* <code>false</code> otherwise.
*/
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpClientConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpClientConnection.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpClientConnection.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpClientConnection.java Wed Apr 15 18:09:24 2009
@@ -34,7 +34,6 @@
import java.io.IOException;
import java.net.Socket;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
@@ -55,23 +54,14 @@
/**
* {@inheritDoc}
* <p>
- * {@link CoreConnectionPNames#TCP_NODELAY} parameter determines whether
- * Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve
- * bandwidth by minimizing the number of segments that are sent. When
- * applications wish to decrease network latency and increase performance,
- * they can disable Nagle's algorithm (that is enable TCP_NODELAY). Data
- * will be sent earlier, at the cost of an increase in bandwidth
- * consumption.
- * <p>
- * {@link CoreConnectionPNames#SO_TIMEOUT} parameter defines the socket
- * timeout in milliseconds, which is the timeout for waiting for data.
- * A timeout value of zero is interpreted as an infinite timeout.
- * <p>
- * {@link CoreConnectionPNames#SO_LINGER} parameter defines linger time
- * in seconds. The maximum timeout value is platform specific. Value
- * <code>0</code> implies that the option is disabled. Value <code>-1</code>
- * implies that the JRE default is to be used. The setting only affects
- * socket close.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#TCP_NODELAY}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_TIMEOUT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_LINGER}</li>
+ * </ul>
+ * </p>
*/
public void bind(
final Socket socket,
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpServerConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpServerConnection.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpServerConnection.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/DefaultHttpServerConnection.java Wed Apr 15 18:09:24 2009
@@ -34,7 +34,6 @@
import java.io.IOException;
import java.net.Socket;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
@@ -55,23 +54,14 @@
/**
* {@inheritDoc}
* <p>
- * {@link CoreConnectionPNames#TCP_NODELAY} parameter determines whether
- * Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve
- * bandwidth by minimizing the number of segments that are sent. When
- * applications wish to decrease network latency and increase performance,
- * they can disable Nagle's algorithm (that is enable TCP_NODELAY). Data
- * will be sent earlier, at the cost of an increase in bandwidth
- * consumption.
- * <p>
- * {@link CoreConnectionPNames#SO_TIMEOUT} parameter defines the socket
- * timeout in milliseconds, which is the timeout for waiting for data.
- * A timeout value of zero is interpreted as an infinite timeout.
- * <p>
- * {@link CoreConnectionPNames#SO_LINGER} parameter defines linger time
- * in seconds. The maximum timeout value is platform specific. Value
- * <code>0</code> implies that the option is disabled. Value <code>-1</code>
- * implies that the JRE default is to be used. The setting only affects
- * socket close.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#TCP_NODELAY}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_TIMEOUT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_LINGER}</li>
+ * </ul>
+ * </p>
*/
public void bind(final Socket socket, final HttpParams params) throws IOException {
if (socket == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpClientConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpClientConnection.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpClientConnection.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpClientConnection.java Wed Apr 15 18:09:24 2009
@@ -41,7 +41,6 @@
import org.apache.http.impl.io.SocketOutputBuffer;
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.io.SessionOutputBuffer;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
@@ -135,12 +134,11 @@
* After this method's execution the connection status will be reported
* as open and the {@link #isOpen()} will return <code>true</code>.
* <p>
- * The following HTTP parameters affect configuration of this connection:
- * <p>
- * The {@link CoreConnectionPNames#SOCKET_BUFFER_SIZE}
- * parameter determines the size of the internal socket buffer. If not
- * defined or set to <code>-1</code> the default value will be chosen
- * automatically.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SOCKET_BUFFER_SIZE}</li>
+ * </ul>
*
* @param socket the socket.
* @param params HTTP parameters.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpServerConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpServerConnection.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpServerConnection.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/SocketHttpServerConnection.java Wed Apr 15 18:09:24 2009
@@ -41,7 +41,6 @@
import org.apache.http.impl.io.SocketOutputBuffer;
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.io.SessionOutputBuffer;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
@@ -154,12 +153,11 @@
* After this method's execution the connection status will be reported
* as open and the {@link #isOpen()} will return <code>true</code>.
* <p>
- * The following HTTP parameters affect configuration this connection:
- * <p>
- * The {@link CoreConnectionPNames#SOCKET_BUFFER_SIZE}
- * parameter determines the size of the internal socket buffer. If not
- * defined or set to <code>-1</code> the default value will be chosen
- * automatically.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SOCKET_BUFFER_SIZE}</li>
+ * </ul>
*
* @param socket the socket.
* @param params HTTP parameters.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/entity/LaxContentLengthStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/entity/LaxContentLengthStrategy.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/entity/LaxContentLengthStrategy.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/entity/LaxContentLengthStrategy.java Wed Apr 15 18:09:24 2009
@@ -61,6 +61,16 @@
super();
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#STRICT_TRANSFER_ENCODING}</li>
+ * </ul>
+ * </p>
+ */
public long determineLength(final HttpMessage message) throws HttpException {
if (message == null) {
throw new IllegalArgumentException("HTTP message may not be null");
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractMessageParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractMessageParser.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractMessageParser.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractMessageParser.java Wed Apr 15 18:09:24 2009
@@ -71,19 +71,12 @@
/**
* Creates an instance of this class.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * {@link CoreConnectionPNames#MAX_HEADER_COUNT} parameter determines
- * the maximum HTTP header count allowed. If set to a positive value,
- * the number of HTTP headers received from the data stream exceeding
- * this limit will cause an IOException. A negative or zero value will
- * effectively disable the check. Per default the check is disabled.
- * <p>
- * {@link CoreConnectionPNames#MAX_LINE_LENGTH} parameter determines
- * the maximum line length limit. If set to a positive value, any HTTP line
- * exceeding this limit will cause an IOException. A negative or zero value
- * will effectively disable the check the check. Per default the check is
- * disabled.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_HEADER_COUNT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @param buffer the session input buffer.
* @param parser the line parser.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionInputBuffer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionInputBuffer.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionInputBuffer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionInputBuffer.java Wed Apr 15 18:09:24 2009
@@ -37,7 +37,6 @@
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.io.HttpTransportMetrics;
import org.apache.http.params.CoreConnectionPNames;
-import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
import org.apache.http.protocol.HTTP;
@@ -73,24 +72,16 @@
/**
* Initializes this session input buffer.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * The {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET}
- * parameter determines the charset to be used for decoding HTTP lines. If
- * not specified, <code>US-ASCII</code> will be used per default.
- * <p>
- * The {@link CoreConnectionPNames#MAX_LINE_LENGTH} parameter determines
- * the maximum line length limit. If set to a positive value, any HTTP
- * line exceeding this limit will cause an IOException. A negative or zero
- * value will effectively disable the check. Per default the line length
- * check is disabled.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @param instream the source input stream.
* @param buffersize the size of the internal buffer.
* @param params HTTP parameters.
- *
- * @see CoreProtocolPNames#HTTP_ELEMENT_CHARSET
- * @see CoreConnectionPNames#MAX_LINE_LENGTH
*/
protected void init(final InputStream instream, int buffersize, final HttpParams params) {
if (instream == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionOutputBuffer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionOutputBuffer.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionOutputBuffer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/AbstractSessionOutputBuffer.java Wed Apr 15 18:09:24 2009
@@ -36,7 +36,6 @@
import org.apache.http.io.SessionOutputBuffer;
import org.apache.http.io.HttpTransportMetrics;
-import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;
import org.apache.http.protocol.HTTP;
@@ -70,17 +69,16 @@
/**
* Initializes this session output buffer.
* <p>
- * The following HTTP parameters affect the initialization:
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * </ul>
* <p>
- * The {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET}
- * parameter determines the charset to be used for encoding HTTP lines. If
- * not specified, <code>US-ASCII</code> will be used per default.
*
* @param outstream the destination output stream.
* @param buffersize the size of the internal buffer.
* @param params HTTP parameters.
- *
- * @see CoreProtocolPNames#HTTP_ELEMENT_CHARSET
*/
protected void init(final OutputStream outstream, int buffersize, final HttpParams params) {
if (outstream == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpRequestParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpRequestParser.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpRequestParser.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpRequestParser.java Wed Apr 15 18:09:24 2009
@@ -43,7 +43,6 @@
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.message.LineParser;
import org.apache.http.message.ParserCursor;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpParams;
import org.apache.http.util.CharArrayBuffer;
@@ -61,19 +60,12 @@
/**
* Creates an instance of this class.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * {@link CoreConnectionPNames#MAX_HEADER_COUNT} parameter determines
- * the maximum HTTP header count allowed. If set to a positive value,
- * the number of HTTP headers received from the data stream exceeding
- * this limit will cause an IOException. A negative or zero value will
- * effectively disable the check. Per default the check is disabled.
- * <p>
- * {@link CoreConnectionPNames#MAX_LINE_LENGTH} parameter determines
- * the maximum line length limit. If set to a positive value, any HTTP line
- * exceeding this limit will cause an IOException. A negative or zero value
- * will effectively disable the check the check. Per default the check is
- * disabled.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_HEADER_COUNT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @param buffer the session input buffer.
* @param parser the line parser.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpResponseParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpResponseParser.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpResponseParser.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/HttpResponseParser.java Wed Apr 15 18:09:24 2009
@@ -43,7 +43,6 @@
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.message.LineParser;
import org.apache.http.message.ParserCursor;
-import org.apache.http.params.CoreConnectionPNames;
import org.apache.http.params.HttpParams;
import org.apache.http.util.CharArrayBuffer;
@@ -61,19 +60,12 @@
/**
* Creates an instance of this class.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * {@link CoreConnectionPNames#MAX_HEADER_COUNT} parameter determines
- * the maximum HTTP header count allowed. If set to a positive value,
- * the number of HTTP headers received from the data stream exceeding
- * this limit will cause an IOException. A negative or zero value will
- * effectively disable the check. Per default the check is disabled.
- * <p>
- * {@link CoreConnectionPNames#MAX_LINE_LENGTH} parameter determines
- * the maximum line length limit. If set to a positive value, any HTTP line
- * exceeding this limit will cause an IOException. A negative or zero value
- * will effectively disable the check the check. Per default the check is
- * disabled.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_HEADER_COUNT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @param buffer the session input buffer.
* @param parser the line parser.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java Wed Apr 15 18:09:24 2009
@@ -37,8 +37,6 @@
import org.apache.http.io.EofSensor;
import org.apache.http.io.SessionInputBuffer;
-import org.apache.http.params.CoreConnectionPNames;
-import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpParams;
/**
@@ -82,17 +80,12 @@
/**
* Creates an instance of this class.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * The {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET}
- * parameter determines the charset to be used for decoding HTTP lines. If
- * not specified, <code>US-ASCII</code> will be used per default.
- * <p>
- * The {@link CoreConnectionPNames#MAX_LINE_LENGTH} parameter determines
- * the maximum line length limit. If set to a positive value, any HTTP
- * line exceeding this limit will cause an IOException. A negative or zero
- * value will effectively disable the check. Per default the line length
- * check is disabled.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @param socket the socket to read data from.
* @param buffersize the size of the internal buffer. If this number is less
@@ -100,9 +93,6 @@
* {@link Socket#getReceiveBufferSize()}. If resultant number is less
* than <code>1024</code> it is set to <code>1024</code>.
* @param params HTTP parameters.
- *
- * @see CoreProtocolPNames#HTTP_ELEMENT_CHARSET
- * @see CoreConnectionPNames#MAX_LINE_LENGTH
*/
public SocketInputBuffer(
final Socket socket,
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketOutputBuffer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketOutputBuffer.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketOutputBuffer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/io/SocketOutputBuffer.java Wed Apr 15 18:09:24 2009
@@ -35,7 +35,6 @@
import java.net.Socket;
import org.apache.http.io.SessionOutputBuffer;
-import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpParams;
/**
@@ -51,11 +50,11 @@
/**
* Creates an instance of this class.
* <p>
- * The following HTTP parameters affect the initialization:
- * <p>
- * The {@link CoreProtocolPNames#HTTP_ELEMENT_CHARSET}
- * parameter determines the charset to be used for encoding HTTP lines. If
- * not specified, <code>US-ASCII</code> will be used per default.
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * </ul>
*
* @param socket the socket to write data to.
* @param buffersize the size of the internal buffer. If this number is less
@@ -63,8 +62,6 @@
* {@link Socket#getSendBufferSize()}. If resultant number is less
* than <code>1024</code> it is set to <code>1024</code>.
* @param params HTTP parameters.
- *
- * @see CoreProtocolPNames#HTTP_ELEMENT_CHARSET
*/
public SocketOutputBuffer(
final Socket socket,
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/message/BasicHttpRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/message/BasicHttpRequest.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/message/BasicHttpRequest.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/message/BasicHttpRequest.java Wed Apr 15 18:09:24 2009
@@ -122,6 +122,12 @@
* Returns the request line of this request. If an HTTP protocol version
* was not explicitly set at the construction time, this method will obtain
* it from the {@link HttpParams} instance associated with the object.
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#PROTOCOL_VERSION}</li>
+ * </ul>
*
* @see #BasicHttpRequest(String, String)
*/
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java Wed Apr 15 18:09:24 2009
@@ -95,6 +95,12 @@
/**
* Sends the request and obtain a response.
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#WAIT_FOR_CONTINUE}</li>
+ * </ul>
*
* @param request the request to execute.
* @param conn the connection over which to execute the request.
@@ -175,6 +181,12 @@
* If it does not have to handle an expect-continue handshake, it will
* not use the connection for reading or anything else that depends on
* data coming in over the connection.
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#WAIT_FOR_CONTINUE}</li>
+ * </ul>
*
* @param request the request to send, already
* {@link #preProcess preprocessed}
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestExpectContinue.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestExpectContinue.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestExpectContinue.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestExpectContinue.java Wed Apr 15 18:09:24 2009
@@ -58,6 +58,16 @@
super();
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#USE_EXPECT_CONTINUE}</li>
+ * </ul>
+ * </p>
+ */
public void process(final HttpRequest request, final HttpContext context)
throws HttpException, IOException {
if (request == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestUserAgent.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestUserAgent.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestUserAgent.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/RequestUserAgent.java Wed Apr 15 18:09:24 2009
@@ -53,6 +53,16 @@
super();
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#USER_AGENT}</li>
+ * </ul>
+ * </p>
+ */
public void process(final HttpRequest request, final HttpContext context)
throws HttpException, IOException {
if (request == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/ResponseServer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/ResponseServer.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/ResponseServer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/protocol/ResponseServer.java Wed Apr 15 18:09:24 2009
@@ -53,6 +53,16 @@
super();
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * The following parameters can be used to customize the behavior
+ * of this method:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#ORIGIN_SERVER}</li>
+ * </ul>
+ * </p>
+ */
public void process(final HttpResponse response, final HttpContext context)
throws HttpException, IOException {
if (response == null) {
Modified: httpcomponents/httpcore/trunk/httpcore/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java?rev=765290&r1=765289&r2=765290&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java Wed Apr 15 18:09:24 2009
@@ -41,8 +41,7 @@
import org.apache.http.params.HttpParams;
/**
- * {@link org.apache.http.impl.io.IdentityInputStream} mockup implementation.
- *
+ * {@link org.apache.http.io.SessionInputBuffer} mockup implementation.
*/
public class SessionInputBufferMockup extends AbstractSessionInputBuffer {