2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import java.io.BufferedReader;
25 import java.io.IOException;
26 import java.io.InputStream;
27 import java.io.InputStreamReader;
28 import java.util.List;
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.HttpGet;
38 import org.apache.http.client.methods.HttpPost;
39 import org.apache.http.entity.mime.HttpMultipartMode;
40 import org.apache.http.entity.mime.MultipartEntity;
41 import org.apache.http.entity.mime.content.FileBody;
42 import org.apache.http.entity.mime.content.InputStreamBody;
43 import org.apache.http.entity.mime.content.StringBody;
44 import org.apache.http.impl.client.DefaultHttpClient;
45 import org.apache.http.params.BasicHttpParams;
46 import org.apache.http.params.CoreProtocolPNames;
47 import org.apache.http.params.HttpConnectionParams;
48 import org.apache.http.params.HttpParams;
51 * Helpful procedures for working with services via HTTPClient
56 public class HttpClientUtils
59 * do a minimal HTTP post with URL-Encoded parameters passed in the Query
64 * @return Reader containing content, if any, or null if no entity returned.
66 * @throws ClientProtocolException
69 public static BufferedReader doHttpUrlPost(String postUrl,
70 List<NameValuePair> vals, int connectionTimeoutMs,
71 int readTimeoutMs) throws ClientProtocolException, IOException
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)
79 HttpConnectionParams.setConnectionTimeout(params,
82 if (readTimeoutMs > 0)
84 HttpConnectionParams.setSoTimeout(params, readTimeoutMs);
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();
93 if (resEntity != null)
95 BufferedReader r = new BufferedReader(
96 new InputStreamReader(resEntity.getContent()));
105 public static BufferedReader doHttpMpartFilePost(String postUrl,
106 List<NameValuePair> vals, String fparm, File file, String mtype)
107 throws ClientProtocolException, IOException
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)
115 mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
118 FileBody fb = new FileBody(file,
119 mtype != null ? mtype : "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();
126 if (resEntity != null)
128 BufferedReader r = new BufferedReader(
129 new InputStreamReader(resEntity.getContent()));
138 public static BufferedReader doHttpMpartInputstreamPost(String postUrl,
139 List<NameValuePair> vals, String fparm, String fname,
140 InputStream is, String mtype)
141 throws ClientProtocolException, IOException
143 HttpClient httpclient = new DefaultHttpClient();
144 HttpPost httppost = new HttpPost(postUrl);
145 MultipartEntity mpe = new MultipartEntity(HttpMultipartMode.STRICT);
146 for (NameValuePair nvp : vals)
148 mpe.addPart(nvp.getName(), new StringBody(nvp.getValue()));
151 InputStreamBody fb = (mtype != null)
152 ? new InputStreamBody(is, fname, mtype)
153 : new InputStreamBody(is, fname);
154 mpe.addPart(fparm, fb);
155 UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
156 httppost.setEntity(ue);
157 HttpResponse response = httpclient.execute(httppost);
158 HttpEntity resEntity = response.getEntity();
160 if (resEntity != null)
162 BufferedReader r = new BufferedReader(
163 new InputStreamReader(resEntity.getContent()));
173 * do an HTTP GET with URL-Encoded parameters passed in the Query string
177 * @return Reader containing content, if any, or null if no entity returned.
178 * @throws IOException
179 * @throws ClientProtocolException
182 public static BufferedReader doHttpGet(String url,
183 List<NameValuePair> vals, int connectionTimeoutMs,
184 int readTimeoutMs) throws ClientProtocolException, IOException
186 // todo use HttpClient 4.3 or later and class RequestConfig
187 HttpParams params = new BasicHttpParams();
188 params.setParameter(CoreProtocolPNames.PROTOCOL_VERSION,
189 HttpVersion.HTTP_1_1);
190 if (connectionTimeoutMs > 0)
192 HttpConnectionParams.setConnectionTimeout(params,
193 connectionTimeoutMs);
195 if (readTimeoutMs > 0)
197 HttpConnectionParams.setSoTimeout(params, readTimeoutMs);
199 boolean first = true;
200 for (NameValuePair param : vals)
210 url += param.getName();
212 url += param.getValue();
214 HttpClient httpclient = new DefaultHttpClient(params);
215 HttpGet httpGet = new HttpGet(url);
216 // UrlEncodedFormEntity ue = new UrlEncodedFormEntity(vals, "UTF-8");
217 // httpGet.setEntity(ue);
218 HttpResponse response = httpclient.execute(httpGet);
219 HttpEntity resEntity = response.getEntity();
221 if (resEntity != null)
223 BufferedReader r = new BufferedReader(
224 new InputStreamReader(resEntity.getContent()));