You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ol...@apache.org on 2003/07/26 12:05:32 UTC
cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods ExpectContinueMethod.java
olegk 2003/07/26 03:05:32
Modified: httpclient/src/java/org/apache/commons/httpclient/methods
ExpectContinueMethod.java
Log:
Javadocs update for the ExpectContinueMethod class
Revision Changes Path
1.7 +39 -7 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/ExpectContinueMethod.java
Index: ExpectContinueMethod.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/ExpectContinueMethod.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ExpectContinueMethod.java 5 Jul 2003 18:43:04 -0000 1.6
+++ ExpectContinueMethod.java 26 Jul 2003 10:05:31 -0000 1.7
@@ -78,6 +78,17 @@
* </p>
*
* <p>
+ * The purpose of the 100 (Continue) status (refer to section 10.1.1
+ * of the RFC 2616 for more details) is 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 sends the request body. In some cases,
+ * it might either be inappropriate or highly inefficient for the
+ * client to send the body if the server will reject the message
+ * without looking at the body.
+ * </p>
+ *
+ * <p>
* 'Expect: 100-continue' handshake should be used with caution,
* as it may cause problems with HTTP servers and proxies that
* do not support HTTP/1.1 protocol.
@@ -118,9 +129,17 @@
}
/**
- * Returns the useExpectHeader.
+ * <p>
+ * Returns <tt>true</tt> if the 'Expect: 100-Continue' handshake
+ * is activated. 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 sends the request body.
+ * </p>
*
- * @return boolean
+ * @return <tt>true</tt> if 'Expect: 100-Continue' handshake is to
+ * be used, <tt>false</tt> otherwise.
*
* @since 2.0beta1
*/
@@ -129,7 +148,20 @@
}
/**
- * Sets the useExpectHeader.
+ * <p>
+ * Activates 'Expect: 100-Continue' handshake. 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 sends the request body.
+ * </p>
+ *
+ * <p>
+ * The use of the 'Expect: 100-continue' handshake can result in
+ * noticable peformance improvement for entity enclosing requests
+ * (such as POST and PUT) that require the target server's
+ * authentication.
+ * </p>
*
* <p>
* 'Expect: 100-continue' handshake should be used with
@@ -137,7 +169,7 @@
* proxies that do not support HTTP/1.1 protocol.
* </p>
*
- * @param value The useExpectHeader to set
+ * @param value boolean value
*
*
* @since 2.0beta1
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org