svn commit: r479415 - in /jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http: HttpEntityEnclosingRequest.java HttpHost.java protocol/HttpRequestExecutor.java protocol/HttpRequestHandlerRegistry.java

[og...@apache.org]

Author: oglueck
Date: Sun Nov 26 11:34:01 2006
New Revision: 479415

URL: http://svn.apache.org/viewvc?view=rev&rev=479415
Log:
doc

Modified:
    jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java
    jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpHost.java
    jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java
    jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestHandlerRegistry.java

Modified: jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java?view=diff&rev=479415&r1=479414&r2=479415
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java Sun Nov 26 11:34:01 2006
@@ -40,8 +40,20 @@
  */
 public interface HttpEntityEnclosingRequest extends HttpRequest {
 
+    /**
+     * Tells if this request should use the expect-continue handshake.
+     * The expect continue handshake gives the server a chance to decide
+     * whether to accept the entity enclosing request before the possibly
+     * lengthy entity is sent across the wire.
+     * @return true if the expect continue handshake should be used, false if
+     * not.
+     */
 	boolean expectContinue();
 	
+    /**
+     * Hands the entity to the request.
+     * @param entity the entity to send.
+     */
     void setEntity(HttpEntity entity);
     
     HttpEntity getEntity();

Modified: jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpHost.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpHost.java?view=diff&rev=479415&r1=479414&r2=479415
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpHost.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpHost.java Sun Nov 26 11:34:01 2006
@@ -44,7 +44,7 @@
  * @since 3.0 
  */
 public class HttpHost {
-
+    /** The default scheme is "http". */
     public static final String DEFAULT_SCHEME_NAME = "http";
     
     /** The host to use. */

Modified: jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java?view=diff&rev=479415&r1=479414&r2=479415
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestExecutor.java Sun Nov 26 11:34:01 2006
@@ -54,6 +54,7 @@
  */
 public class HttpRequestExecutor {
 
+    //TODO make this value customizable, just use this as a default
     protected static final int WAIT_FOR_CONTINUE_MS = 10000;
 
     private HttpParams params;

Modified: jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestHandlerRegistry.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestHandlerRegistry.java?view=diff&rev=479415&r1=479414&r2=479415
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestHandlerRegistry.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/protocol/HttpRequestHandlerRegistry.java Sun Nov 26 11:34:01 2006
@@ -36,8 +36,14 @@
 
 /**
  * Maintains a map of HTTP request handlers keyed by a request URI pattern. 
- * {@link HttpRequestHandler} instances can be looked by request URI
- * using {@link HttpRequestHandlerResolver} interface.
+ * {@link HttpRequestHandler} instances can be looked up by request URI
+ * using the {@link HttpRequestHandlerResolver} interface.<br/>
+ * Patterns may have three formats:
+ * <ul>
+ *   <li><code>*</code></li>
+ *   <li><code>*&lt;uri&gt;</code></li>
+ *   <li><code>&lt;uri&gt;*</code></li>
+ * </ul>
  *
  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
  *