1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.thrift.transport;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.hc.client5.http.classic.HttpClient;
import org.apache.hc.client5.http.classic.methods.HttpPost;
import org.apache.hc.client5.http.config.ConnectionConfig;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.io.entity.ByteArrayEntity;
import org.apache.hc.core5.util.Timeout;
import org.apache.thrift.TConfiguration;
import org.apache.thrift.THttpClientResponseHandler;
/**
* HTTP implementation of the TTransport interface. Used for working with a Thrift web services
* implementation (using for example TServlet).
*
* <p>This class offers two implementations of the HTTP transport. One uses HttpURLConnection
* instances, the other HttpClient from Apache Http Components. The chosen implementation depends on
* the constructor used to create the THttpClient instance. Using the THttpClient(String url)
* constructor or passing null as the HttpClient to THttpClient(String url, HttpClient client) will
* create an instance which will use HttpURLConnection.
*
* <p>When using HttpClient, the following configuration leads to 5-15% better performance than the
* HttpURLConnection implementation:
*
* <p>http.protocol.version=HttpVersion.HTTP_1_1 http.protocol.content-charset=UTF-8
* http.protocol.expect-continue=false http.connection.stalecheck=false
*
* <p>Also note that under high load, the HttpURLConnection implementation may exhaust the open file
* descriptor limit.
*
* @see <a href="https://issues.apache.org/jira/browse/THRIFT-970">THRIFT-970</a>
*/
public class THttpClient extends TEndpointTransport {
private final URL url_;
private final ByteArrayOutputStream requestBuffer_ = new ByteArrayOutputStream();
private InputStream inputStream_ = null;
private int connectTimeout_ = 0;
private int readTimeout_ = 0;
private Map<String, String> customHeaders_ = null;
private final HttpHost host;
private final HttpClient client;
private static final Map<String, String> DEFAULT_HEADERS =
Collections.unmodifiableMap(getDefaultHeaders());
public static class Factory extends TTransportFactory {
private final String url;
private final HttpClient client;
public Factory(String url) {
this.url = url;
this.client = null;
}
public Factory(String url, HttpClient client) {
this.url = url;
this.client = client;
}
@Override
public TTransport getTransport(TTransport trans) {
try {
if (null != client) {
return new THttpClient(trans.getConfiguration(), url, client);
} else {
return new THttpClient(trans.getConfiguration(), url);
}
} catch (TTransportException tte) {
return null;
}
}
}
public THttpClient(TConfiguration config, String url) throws TTransportException {
super(config);
try {
url_ = new URL(url);
this.client = null;
this.host = null;
} catch (IOException iox) {
throw new TTransportException(iox);
}
}
public THttpClient(String url) throws TTransportException {
super(new TConfiguration());
try {
url_ = new URL(url);
this.client = null;
this.host = null;
} catch (IOException iox) {
throw new TTransportException(iox);
}
}
public THttpClient(TConfiguration config, String url, HttpClient client)
throws TTransportException {
super(config);
try {
url_ = new URL(url);
this.client = client;
this.host =
new HttpHost(
url_.getProtocol(),
url_.getHost(),
-1 == url_.getPort() ? url_.getDefaultPort() : url_.getPort());
} catch (IOException iox) {
throw new TTransportException(iox);
}
}
public THttpClient(String url, HttpClient client) throws TTransportException {
super(new TConfiguration());
try {
url_ = new URL(url);
this.client = client;
this.host =
new HttpHost(
url_.getProtocol(),
url_.getHost(),
-1 == url_.getPort() ? url_.getDefaultPort() : url_.getPort());
} catch (IOException iox) {
throw new TTransportException(iox);
}
}
public void setConnectTimeout(int timeout) {
connectTimeout_ = timeout;
}
/**
* Use instead {@link
* org.apache.hc.client5.http.impl.io.BasicHttpClientConnectionManager#setConnectionConfig} or
* {@link
* org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager#setDefaultConnectionConfig}
*/
@Deprecated
public void setReadTimeout(int timeout) {
readTimeout_ = timeout;
}
public void setCustomHeaders(Map<String, String> headers) {
customHeaders_ = new HashMap<>(headers);
}
public void setCustomHeader(String key, String value) {
if (customHeaders_ == null) {
customHeaders_ = new HashMap<>();
}
customHeaders_.put(key, value);
}
@Override
public void open() {}
@Override
public void close() {
if (null != inputStream_) {
try {
inputStream_.close();
} catch (IOException ioe) {
}
inputStream_ = null;
}
}
@Override
public boolean isOpen() {
return true;
}
@Override
public int read(byte[] buf, int off, int len) throws TTransportException {
if (inputStream_ == null) {
throw new TTransportException("Response buffer is empty, no request.");
}
checkReadBytesAvailable(len);
try {
int ret = inputStream_.read(buf, off, len);
if (ret == -1) {
throw new TTransportException("No more data available.");
}
countConsumedMessageBytes(ret);
return ret;
} catch (IOException iox) {
throw new TTransportException(iox);
}
}
@Override
public void write(byte[] buf, int off, int len) {
requestBuffer_.write(buf, off, len);
}
private RequestConfig getRequestConfig() {
RequestConfig requestConfig = RequestConfig.DEFAULT;
if (connectTimeout_ > 0) {
requestConfig =
RequestConfig.copy(requestConfig)
.setConnectionRequestTimeout(Timeout.ofMilliseconds(connectTimeout_))
.build();
}
return requestConfig;
}
private ConnectionConfig getConnectionConfig() {
ConnectionConfig connectionConfig = ConnectionConfig.DEFAULT;
if (readTimeout_ > 0) {
connectionConfig =
ConnectionConfig.copy(connectionConfig)
.setSocketTimeout(Timeout.ofMilliseconds(readTimeout_))
.build();
}
return connectionConfig;
}
private static Map<String, String> getDefaultHeaders() {
Map<String, String> headers = new HashMap<>();
headers.put("Content-Type", "application/x-thrift");
headers.put("Accept", "application/x-thrift");
headers.put("User-Agent", "Java/THttpClient/HC");
return headers;
}
private void flushUsingHttpClient() throws TTransportException {
if (null == this.client) {
throw new TTransportException("Null HttpClient, aborting.");
}
// Extract request and reset buffer
byte[] data = requestBuffer_.toByteArray();
requestBuffer_.reset();
HttpPost post = new HttpPost(this.url_.getFile());
try {
// Set request to path + query string
post.setConfig(getRequestConfig());
DEFAULT_HEADERS.forEach(post::addHeader);
if (null != customHeaders_) {
customHeaders_.forEach(post::addHeader);
}
post.setEntity(new ByteArrayEntity(data, null));
inputStream_ = client.execute(this.host, post, new THttpClientResponseHandler());
} catch (IOException ioe) {
// Abort method so the connection gets released back to the connection manager
post.abort();
throw new TTransportException(ioe);
} finally {
resetConsumedMessageSize(-1);
}
}
public void flush() throws TTransportException {
if (null != this.client) {
flushUsingHttpClient();
return;
}
// Extract request and reset buffer
byte[] data = requestBuffer_.toByteArray();
requestBuffer_.reset();
try {
// Create connection object
HttpURLConnection connection = (HttpURLConnection) url_.openConnection();
// Timeouts, only if explicitly set
if (connectTimeout_ > 0) {
connection.setConnectTimeout(connectTimeout_);
}
if (readTimeout_ > 0) {
connection.setReadTimeout(readTimeout_);
}
// Make the request
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/x-thrift");
connection.setRequestProperty("Accept", "application/x-thrift");
connection.setRequestProperty("User-Agent", "Java/THttpClient");
if (customHeaders_ != null) {
for (Map.Entry<String, String> header : customHeaders_.entrySet()) {
connection.setRequestProperty(header.getKey(), header.getValue());
}
}
connection.setDoOutput(true);
connection.connect();
connection.getOutputStream().write(data);
int responseCode = connection.getResponseCode();
if (responseCode != HttpURLConnection.HTTP_OK) {
throw new TTransportException("HTTP Response code: " + responseCode);
}
// Read the responses
inputStream_ = connection.getInputStream();
} catch (IOException iox) {
throw new TTransportException(iox);
} finally {
resetConsumedMessageSize(-1);
}
}
}
|