- Continued support for non-blocking HTTPS to the internal NIO connectors, client-side and server-side.

      - Deprecated the Client#connectTimeout property as it is hard to find
        compared to other connector parameters. Also, it isn't available for
        all connectors so it can be confusing to expose it.
        Use the "socketConnectTimeoutMs" connector parameter instead or
        the "maxIoIdleTimeMs" parameter for internal NIO connectors.

Author: Jérôme Louvel

build/tmpl/text/changes.txt

@@ -5,6 +5,11 @@ Changes log
 
 - @version-full@ (@release-date@)
     - API changes
+      - Deprecated the Client#connectTimeout property as it is hard to find
+        compared to other connector parameters. Also, it isn't available for
+        all connectors so it can be confusing to expose it.
+        Use the "socketConnectTimeoutMs" connector parameter instead or
+        the "maxIoIdleTimeMs" parameter for internal NIO connectors.
     - Enhancements
       - Added support for non-blocking HTTPS to the internal NIO connectors, 
         client-side and server-side. Sponsored by NetDev.

modules/org.restlet.ext.httpclient/src/org/restlet/ext/httpclient/HttpClientHelper.java

@@ -223,7 +223,7 @@ protected void configure(HttpParams params) {
         HttpClientParams.setCookiePolicy(params,
                 CookiePolicy.BROWSER_COMPATIBILITY);
         HttpConnectionParams.setTcpNoDelay(params, getTcpNoDelay());
-        HttpConnectionParams.setConnectionTimeout(params, getConnectTimeout());
+        HttpConnectionParams.setConnectionTimeout(params, getSocketConnectTimeoutMs());
         HttpConnectionParams.setSoTimeout(params, getSocketTimeout());
 
         String httpProxyHost = getProxyHost();

modules/org.restlet.ext.net/src/org/restlet/ext/net/FtpClientHelper.java

@@ -166,7 +166,7 @@ public void handle(Request request, Response response) {
                     int minorVersionNumber = SystemUtils.getJavaMinorVersion();
                     if ((majorVersionNumber > 1)
                             || ((majorVersionNumber == 1) && (minorVersionNumber >= 5))) {
-                        connection.setConnectTimeout(getConnectTimeout());
+                        connection.setConnectTimeout(getSocketConnectTimeoutMs());
                         connection.setReadTimeout(getReadTimeout());
                     }
 

modules/org.restlet.ext.net/src/org/restlet/ext/net/internal/HttpUrlConnectionCall.java

@@ -102,7 +102,7 @@ public HttpUrlConnectionCall(HttpClientHelper helper, String method,
             if ((majorVersionNumber > 1)
                     || ((majorVersionNumber == 1) && (minorVersionNumber >= 5))) {
                 this.connection.setConnectTimeout(getHelper()
-                        .getConnectTimeout());
+                        .getSocketConnectTimeoutMs());
                 this.connection.setReadTimeout(getHelper().getReadTimeout());
             }
 

modules/org.restlet/src/org/restlet/Client.java

@@ -142,7 +142,9 @@ public Client(String protocolName) {
      * meaning an infinite timeout.
      * 
      * @return The connection timeout.
+     * @deprecated Use the equivalent "socketConnectTimeoutMs" connector parameter.
      */
+    @Deprecated
     public int getConnectTimeout() {
         return this.connectTimeout;
     }
@@ -178,11 +180,9 @@ public void handle(Request request, Response response) {
             getHelper().handle(request, response);
         } else {
             StringBuilder sb = new StringBuilder();
-            sb
-                    .append("No available client connector supports the required protocol: ");
+            sb.append("No available client connector supports the required protocol: ");
             sb.append("'").append(request.getProtocol().getName()).append("'.");
-            sb
-                    .append(" Please add the JAR of a matching connector to your classpath.");
+            sb.append(" Please add the JAR of a matching connector to your classpath.");
             response.setStatus(Status.CONNECTOR_ERROR_INTERNAL, sb.toString());
         }
     }
@@ -232,7 +232,9 @@ public boolean isAvailable() {
      * 
      * @param connectTimeout
      *            The connection timeout.
+     * @deprecated Use the equivalent connector parameters.
      */
+    @Deprecated
     public void setConnectTimeout(int connectTimeout) {
         this.connectTimeout = connectTimeout;
     }

modules/org.restlet/src/org/restlet/engine/ClientHelper.java

@@ -33,7 +33,23 @@
 import org.restlet.Client;
 
 /**
- * Client connector helper.
+ * Client connector helper. Base client helper based on NIO non blocking
+ * sockets. Here is the list of parameters that are supported. They should be
+ * set in the Client's context before it is started:
+ * <table>
+ * <tr>
+ * <th>Parameter name</th>
+ * <th>Value type</th>
+ * <th>Default value</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td>socketConnectTimeoutMs</td>
+ * <td>int</td>
+ * <td>0</td>
+ * <td>The socket connection timeout or 0 for unlimited wait.</td>
+ * </tr>
+ * </table>
  * 
  * @author Jerome Louvel
  */
@@ -54,8 +70,16 @@ public ClientHelper(Client client) {
      * 
      * @return The connection timeout.
      */
-    public int getConnectTimeout() {
-        return getHelped().getConnectTimeout();
+    @SuppressWarnings("deprecation")
+    public int getSocketConnectTimeoutMs() {
+        int result = getHelped().getConnectTimeout();
+
+        if (getHelpedParameters().getNames().contains("socketConnectTimeoutMs")) {
+            result = Integer.parseInt(getHelpedParameters().getFirstValue(
+                    "socketConnectTimeoutMs", "0"));
+        }
+
+        return result;
     }
 
 }

modules/org.restlet/src/org/restlet/engine/connector/ClientConnectionHelper.java

@@ -84,6 +84,12 @@
  * <td>The port of the HTTP proxy.</td>
  * </tr>
  * <tr>
+ * <td>socketConnectTimeoutMs</td>
+ * <td>int</td>
+ * <td>0</td>
+ * <td>The socket connection timeout or 0 for unlimited wait.</td>
+ * </tr>
+ * <tr>
  * <td>socketKeepAlive</td>
  * <td>boolean</td>
  * <td>true</td>
@@ -503,12 +509,20 @@ public String getCertAlgorithm() {
     }
 
     /**
-     * Returns the connection timeout.
+     * Returns the socket connection timeout.
      * 
-     * @return The connection timeout.
+     * @return The socket connection timeout.
      */
-    public int getConnectTimeout() {
-        return getHelped().getConnectTimeout();
+    @SuppressWarnings("deprecation")
+    public int getSocketConnectTimeoutMs() {
+        int result = getHelped().getConnectTimeout();
+
+        if (getHelpedParameters().getNames().contains("socketConnectTimeoutMs")) {
+            result = Integer.parseInt(getHelpedParameters().getFirstValue(
+                    "socketConnectTimeoutMs", "0"));
+        }
+
+        return result;
     }
 
     /**