src/jalview/ws/HttpClientUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws;
  22
  23 import java.io.BufferedReader;
  24 import java.io.File;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.io.InputStreamReader;
  28 import java.util.List;
  29
  30 import org.apache.http.HttpEntity;
  31 import org.apache.http.HttpResponse;
  32 import org.apache.http.HttpVersion;
  33 import org.apache.http.NameValuePair;
  34 import org.apache.http.client.ClientProtocolException;
  35 import org.apache.http.client.HttpClient;
  36 import org.apache.http.client.entity.UrlEncodedFormEntity;
  37 import org.apache.http.client.methods.HttpPost;
  38 import org.apache.http.entity.mime.HttpMultipartMode;
  39 import org.apache.http.entity.mime.MultipartEntity;
  40 import org.apache.http.entity.mime.content.FileBody;
  41 import org.apache.http.entity.mime.content.InputStreamBody;
  42 import org.apache.http.entity.mime.content.StringBody;
  43 import org.apache.http.impl.client.DefaultHttpClient;
  44 import org.apache.http.params.BasicHttpParams;
  45 import org.apache.http.params.CoreProtocolPNames;
  46 import org.apache.http.params.HttpConnectionParams;
  47 import org.apache.http.params.HttpParams;
  48
  49 /**
  50  * Helpful procedures for working with services via HTTPClient
  51  *
  52  * @author jimp
  53  *
  54  */
  55 public class HttpClientUtils
  56 {
  57   /**
  58    * do a minimal HTTP post with URL-Encoded parameters passed in the Query
  59    * string
  60    *
  61    * @param postUrl
  62    * @param vals
  63    * @return Reader containing content, if any, or null if no entity returned.
  64    * @throws IOException
  65    * @throws ClientProtocolException
  66    * @throws Exception
  67    */
  68   public static BufferedReader doHttpUrlPost(String postUrl,
  69           List<NameValuePair> vals, int connectionTimeoutMs,
  70           int readTimeoutMs) throws ClientProtocolException,
  71           IOException
  72   {
  73     // todo use HttpClient 4.3 or later and class RequestConfig
  74     HttpParams params = new BasicHttpParams();
  75     params.setParameter(CoreProtocolPNames.PROTOCOL_VERSION,
  76             HttpVersion.HTTP_1_1);
  77     if (connectionTimeoutMs > 0)
  78     {
  79       HttpConnectionParams
  80               .setConnectionTimeout(params, connectionTimeoutMs);
  81     }
  82     if (readTimeoutMs > 0)
  83     {
  84       HttpConnectionParams.setSoTimeout(params, readTimeoutMs);
  85     }
  86     HttpClient httpclient = new DefaultHttpClient(params);
  87     HttpPost httppost = new HttpPost(postUrl);
  88     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
  89     httppost.setEntity(ue);
  90     HttpResponse response = httpclient.execute(httppost);
  91     HttpEntity resEntity = response.getEntity();
  92
  93     if (resEntity != null)
  94     {
  95       BufferedReader r = new BufferedReader(new InputStreamReader(
  96               resEntity.getContent()));
  97       return r;
  98     }
  99     else
 100     {
 101       return null;
 102     }
 103   }
 104
 105   public static BufferedReader doHttpMpartFilePost(String postUrl,
 106           List<NameValuePair> vals, String fparm, File file, String mtype)
 107           throws ClientProtocolException, IOException
 108   {
 109     HttpClient httpclient = new DefaultHttpClient();
 110     HttpPost httppost = new HttpPost(postUrl);
 111     MultipartEntity mpe = new MultipartEntity(
 112             HttpMultipartMode.BROWSER_COMPATIBLE);
 113     for (NameValuePair nvp : vals)
 114     {
 115       mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
 116     }
 117
 118     FileBody fb = new FileBody(file, mtype != null ? mtype
 119             : "application/octet-stream");
 120     mpe.addPart(fparm, fb);
 121     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
 122     httppost.setEntity(ue);
 123     HttpResponse response = httpclient.execute(httppost);
 124     HttpEntity resEntity = response.getEntity();
 125
 126     if (resEntity != null)
 127     {
 128       BufferedReader r = new BufferedReader(new InputStreamReader(
 129               resEntity.getContent()));
 130       return r;
 131     }
 132     else
 133     {
 134       return null;
 135     }
 136   }
 137
 138   public static BufferedReader doHttpMpartInputstreamPost(String postUrl,
 139           List<NameValuePair> vals, String fparm, String fname,
 140           InputStream is, String mtype) throws ClientProtocolException,
 141           IOException
 142   {
 143     HttpClient httpclient = new DefaultHttpClient();
 144     HttpPost httppost = new HttpPost(postUrl);
 145     MultipartEntity mpe = new MultipartEntity(HttpMultipartMode.STRICT);
 146     for (NameValuePair nvp : vals)
 147     {
 148       mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
 149     }
 150
 151     InputStreamBody fb = (mtype != null) ? new InputStreamBody(is, fname,
 152             mtype) : new InputStreamBody(is, fname);
 153     mpe.addPart(fparm, fb);
 154     UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
 155     httppost.setEntity(ue);
 156     HttpResponse response = httpclient.execute(httppost);
 157     HttpEntity resEntity = response.getEntity();
 158
 159     if (resEntity != null)
 160     {
 161       BufferedReader r = new BufferedReader(new InputStreamReader(
 162               resEntity.getContent()));
 163       return r;
 164     }
 165     else
 166     {
 167       return null;
 168     }
 169   }
 170 }