JAL-2418 source formatting
[jalview.git] / src / jalview / ws / HttpClientUtils.java
index 740b669..b19d606 100644 (file)
@@ -1,19 +1,22 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.ws;
 
@@ -26,6 +29,7 @@ import java.util.List;
 
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpResponse;
+import org.apache.http.HttpVersion;
 import org.apache.http.NameValuePair;
 import org.apache.http.client.ClientProtocolException;
 import org.apache.http.client.HttpClient;
@@ -37,11 +41,16 @@ import org.apache.http.entity.mime.content.FileBody;
 import org.apache.http.entity.mime.content.InputStreamBody;
 import org.apache.http.entity.mime.content.StringBody;
 import org.apache.http.impl.client.DefaultHttpClient;
+import org.apache.http.params.BasicHttpParams;
+import org.apache.http.params.CoreProtocolPNames;
+import org.apache.http.params.HttpConnectionParams;
+import org.apache.http.params.HttpParams;
 
 /**
  * Helpful procedures for working with services via HTTPClient
+ * 
  * @author jimp
- *
+ * 
  */
 public class HttpClientUtils
 {
@@ -57,10 +66,23 @@ public class HttpClientUtils
    * @throws Exception
    */
   public static BufferedReader doHttpUrlPost(String postUrl,
-          List<NameValuePair> vals) throws ClientProtocolException,
-          IOException
+          List<NameValuePair> vals, int connectionTimeoutMs,
+          int readTimeoutMs) throws ClientProtocolException, IOException
   {
-    HttpClient httpclient = new DefaultHttpClient();
+    // todo use HttpClient 4.3 or later and class RequestConfig
+    HttpParams params = new BasicHttpParams();
+    params.setParameter(CoreProtocolPNames.PROTOCOL_VERSION,
+            HttpVersion.HTTP_1_1);
+    if (connectionTimeoutMs > 0)
+    {
+      HttpConnectionParams.setConnectionTimeout(params,
+              connectionTimeoutMs);
+    }
+    if (readTimeoutMs > 0)
+    {
+      HttpConnectionParams.setSoTimeout(params, readTimeoutMs);
+    }
+    HttpClient httpclient = new DefaultHttpClient(params);
     HttpPost httppost = new HttpPost(postUrl);
     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
     httppost.setEntity(ue);
@@ -69,8 +91,8 @@ public class HttpClientUtils
 
     if (resEntity != null)
     {
-      BufferedReader r = new BufferedReader(new InputStreamReader(
-              resEntity.getContent()));
+      BufferedReader r = new BufferedReader(
+              new InputStreamReader(resEntity.getContent()));
       return r;
     }
     else
@@ -80,18 +102,20 @@ public class HttpClientUtils
   }
 
   public static BufferedReader doHttpMpartFilePost(String postUrl,
-          List<NameValuePair> vals, String fparm,File file, String mtype) throws ClientProtocolException,
-          IOException
+          List<NameValuePair> vals, String fparm, File file, String mtype)
+          throws ClientProtocolException, IOException
   {
     HttpClient httpclient = new DefaultHttpClient();
     HttpPost httppost = new HttpPost(postUrl);
-    MultipartEntity mpe = new MultipartEntity(HttpMultipartMode.BROWSER_COMPATIBLE);
-    for (NameValuePair nvp:vals)
+    MultipartEntity mpe = new MultipartEntity(
+            HttpMultipartMode.BROWSER_COMPATIBLE);
+    for (NameValuePair nvp : vals)
     {
       mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
     }
-    
-    FileBody fb = new FileBody(file, mtype!=null ? mtype : "application/octet-stream");
+
+    FileBody fb = new FileBody(file,
+            mtype != null ? mtype : "application/octet-stream");
     mpe.addPart(fparm, fb);
     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
     httppost.setEntity(ue);
@@ -100,8 +124,8 @@ public class HttpClientUtils
 
     if (resEntity != null)
     {
-      BufferedReader r = new BufferedReader(new InputStreamReader(
-              resEntity.getContent()));
+      BufferedReader r = new BufferedReader(
+              new InputStreamReader(resEntity.getContent()));
       return r;
     }
     else
@@ -109,19 +133,23 @@ public class HttpClientUtils
       return null;
     }
   }
+
   public static BufferedReader doHttpMpartInputstreamPost(String postUrl,
-          List<NameValuePair> vals, String fparm,String fname, InputStream is, String mtype) throws ClientProtocolException,
-          IOException
+          List<NameValuePair> vals, String fparm, String fname,
+          InputStream is, String mtype)
+          throws ClientProtocolException, IOException
   {
     HttpClient httpclient = new DefaultHttpClient();
     HttpPost httppost = new HttpPost(postUrl);
     MultipartEntity mpe = new MultipartEntity(HttpMultipartMode.STRICT);
-    for (NameValuePair nvp:vals)
+    for (NameValuePair nvp : vals)
     {
       mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
     }
-    
-    InputStreamBody fb = (mtype!=null) ? new InputStreamBody(is, fname, mtype) : new InputStreamBody(is, fname);
+
+    InputStreamBody fb = (mtype != null)
+            ? new InputStreamBody(is, fname, mtype)
+            : new InputStreamBody(is, fname);
     mpe.addPart(fparm, fb);
     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
     httppost.setEntity(ue);
@@ -130,8 +158,8 @@ public class HttpClientUtils
 
     if (resEntity != null)
     {
-      BufferedReader r = new BufferedReader(new InputStreamReader(
-              resEntity.getContent()));
+      BufferedReader r = new BufferedReader(
+              new InputStreamReader(resEntity.getContent()));
       return r;
     }
     else