From 5ddc794bb9a42a77543ae048a162f7bcf4283628 Mon Sep 17 00:00:00 2001 From: Michael Peter Christen Date: Mon, 24 Oct 2022 23:34:39 +0200 Subject: [PATCH] code cleanup in http clieant --- .../yacy/cora/protocol/http/HTTPClient.java | 882 +++++++++--------- 1 file changed, 441 insertions(+), 441 deletions(-) diff --git a/source/net/yacy/cora/protocol/http/HTTPClient.java b/source/net/yacy/cora/protocol/http/HTTPClient.java index 0ca7eda55..063433518 100644 --- a/source/net/yacy/cora/protocol/http/HTTPClient.java +++ b/source/net/yacy/cora/protocol/http/HTTPClient.java @@ -120,88 +120,88 @@ import net.yacy.kelondro.util.NamePrefixThreadFactory; * */ public class HTTPClient implements Closeable { - + private static final int default_timeout = 6000; - + /** Maximum number of simultaneously open outgoing HTTP connections in the pool */ - private static final int maxcon = 200; - - /** Default sleep time in seconds between each run of the connection evictor */ - private static final int DEFAULT_CONNECTION_EVICTOR_SLEEP_TIME = 5; - - /** Default maximum time in seconds to keep alive an idle connection in the pool */ - private static final int DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE = 30; - - private static final RequestConfig DFLTREQUESTCONFIG = initRequestConfig(); - - /** Use the custom YaCyDigestScheme for HTTP Digest Authentication */ + private static final int maxcon = 200; + + /** Default sleep time in seconds between each run of the connection evictor */ + private static final int DEFAULT_CONNECTION_EVICTOR_SLEEP_TIME = 5; + + /** Default maximum time in seconds to keep alive an idle connection in the pool */ + private static final int DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE = 30; + + private static final RequestConfig DFLTREQUESTCONFIG = initRequestConfig(); + + /** Use the custom YaCyDigestScheme for HTTP Digest Authentication */ private static final Lookup AUTHSCHEMEREGISTRY = RegistryBuilder.create() .register(AuthSchemes.BASIC, new BasicSchemeFactory()) .register(AuthSchemes.DIGEST, new YaCyDigestSchemeFactory()) .build(); - - /** The connection manager holding the configured connection pool for this client */ - public static final PoolingHttpClientConnectionManager CONNECTION_MANAGER = initPoolingConnectionManager(); - - /** Default setting to apply when the JVM system option jsse.enableSNIExtension is not defined */ - public static final boolean ENABLE_SNI_EXTENSION_DEFAULT = true; - - /** When true, Server Name Indication (SNI) extension is enabled on outgoing TLS connections. - * @see RFC 6066 definition - * @see JDK 1.7 bug on "unrecognized_name" warning for SNI */ - public static final AtomicBoolean ENABLE_SNI_EXTENSION = new AtomicBoolean( - Boolean.parseBoolean(System.getProperty("jsse.enableSNIExtension", Boolean.toString(ENABLE_SNI_EXTENSION_DEFAULT)))); - + + /** The connection manager holding the configured connection pool for this client */ + public static final PoolingHttpClientConnectionManager CONNECTION_MANAGER = initPoolingConnectionManager(); + + /** Default setting to apply when the JVM system option jsse.enableSNIExtension is not defined */ + public static final boolean ENABLE_SNI_EXTENSION_DEFAULT = true; + + /** When true, Server Name Indication (SNI) extension is enabled on outgoing TLS connections. + * @see RFC 6066 definition + * @see JDK 1.7 bug on "unrecognized_name" warning for SNI */ + public static final AtomicBoolean ENABLE_SNI_EXTENSION = new AtomicBoolean( + Boolean.parseBoolean(System.getProperty("jsse.enableSNIExtension", Boolean.toString(ENABLE_SNI_EXTENSION_DEFAULT)))); + /** - * Background daemon thread evicting expired idle connections from the pool. - * This may be eventually already done by the pool itself on connection request, - * but this background task helps when no request is made to the pool for a long - * time period. - */ - private static final IdleConnectionEvictor EXPIRED_CONNECTIONS_EVICTOR = new IdleConnectionEvictor( - CONNECTION_MANAGER, DEFAULT_CONNECTION_EVICTOR_SLEEP_TIME, TimeUnit.SECONDS, - DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE, TimeUnit.SECONDS); - - static { - EXPIRED_CONNECTIONS_EVICTOR.start(); - } - - private final static HttpClientBuilder clientBuilder = initClientBuilder(); - private final RequestConfig.Builder reqConfBuilder; - private Set> headers = null; - private long upbytes = 0L; - private String host = null; - private final long timeout; - private static ExecutorService executor = Executors - .newCachedThreadPool(new NamePrefixThreadFactory(HTTPClient.class.getSimpleName() + ".execute")); - - /** these are the main variable to hold information and to take care of closing: */ - private CloseableHttpClient client = null; - private CloseableHttpResponse httpResponse = null; - private HttpUriRequest currentRequest = null; + * Background daemon thread evicting expired idle connections from the pool. + * This may be eventually already done by the pool itself on connection request, + * but this background task helps when no request is made to the pool for a long + * time period. + */ + private static final IdleConnectionEvictor EXPIRED_CONNECTIONS_EVICTOR = new IdleConnectionEvictor( + CONNECTION_MANAGER, DEFAULT_CONNECTION_EVICTOR_SLEEP_TIME, TimeUnit.SECONDS, + DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE, TimeUnit.SECONDS); + + static { + EXPIRED_CONNECTIONS_EVICTOR.start(); + } + + private final static HttpClientBuilder clientBuilder = initClientBuilder(); + private final RequestConfig.Builder reqConfBuilder; + private Set> headers = null; + private long upbytes = 0L; + private String host = null; + private final long timeout; + private static ExecutorService executor = Executors + .newCachedThreadPool(new NamePrefixThreadFactory(HTTPClient.class.getSimpleName() + ".execute")); + + /** these are the main variable to hold information and to take care of closing: */ + private CloseableHttpClient client = null; + private CloseableHttpResponse httpResponse = null; + private HttpUriRequest currentRequest = null; + - public HTTPClient(final ClientIdentification.Agent agent) { super(); this.timeout = agent.clientTimeout; clientBuilder.setUserAgent(agent.userAgent); - reqConfBuilder = RequestConfig.copy(DFLTREQUESTCONFIG); + this.reqConfBuilder = RequestConfig.copy(DFLTREQUESTCONFIG); setTimout(agent.clientTimeout); } - + public HTTPClient(final ClientIdentification.Agent agent, final int timeout) { super(); this.timeout = timeout; clientBuilder.setUserAgent(agent.userAgent); - reqConfBuilder = RequestConfig.copy(DFLTREQUESTCONFIG); + this.reqConfBuilder = RequestConfig.copy(DFLTREQUESTCONFIG); setTimout(timeout); } - + private static RequestConfig initRequestConfig() { - final RequestConfig.Builder builder = RequestConfig.custom(); - // IMPORTANT - if not set to 'false' then servers do not process the request until a time-out of 2 seconds - builder.setExpectContinueEnabled(false); + final RequestConfig.Builder builder = RequestConfig.custom(); + // IMPORTANT - if not set to 'false' then servers do not process the request until a time-out of 2 seconds + builder.setExpectContinueEnabled(false); // timeout in milliseconds until a connection is established in milliseconds builder.setConnectionRequestTimeout(default_timeout); builder.setConnectTimeout(default_timeout); @@ -213,53 +213,53 @@ public class HTTPClient implements Closeable { builder.setRelativeRedirectsAllowed(true); return builder.build(); } - + private static HttpClientBuilder initClientBuilder() { - final HttpClientBuilder builder = HttpClientBuilder.create(); - - builder.setConnectionManager(CONNECTION_MANAGER); - builder.setConnectionManagerShared(true); - - builder.setDefaultRequestConfig(DFLTREQUESTCONFIG); - - // UserAgent - builder.setUserAgent(ClientIdentification.yacyInternetCrawlerAgent.userAgent); - - // remove retries; we expect connections to fail; therefore we should not retry - //builder.disableAutomaticRetries(); - // disable the cookiestore, cause this may cause segfaults and is not needed - builder.setDefaultCookieStore(null); - builder.disableCookieManagement(); - - // add custom keep alive strategy - builder.setKeepAliveStrategy(customKeepAliveStrategy()); - - // ask for gzip - builder.addInterceptorLast(new GzipRequestInterceptor()); - // uncompress gzip - builder.addInterceptorLast(new GzipResponseInterceptor()); - // Proxy - builder.setRoutePlanner(ProxySettings.RoutePlanner); - builder.setDefaultCredentialsProvider(ProxySettings.CredsProvider); - - return builder; + final HttpClientBuilder builder = HttpClientBuilder.create(); + + builder.setConnectionManager(CONNECTION_MANAGER); + builder.setConnectionManagerShared(true); + + builder.setDefaultRequestConfig(DFLTREQUESTCONFIG); + + // UserAgent + builder.setUserAgent(ClientIdentification.yacyInternetCrawlerAgent.userAgent); + + // remove retries; we expect connections to fail; therefore we should not retry + //builder.disableAutomaticRetries(); + // disable the cookiestore, cause this may cause segfaults and is not needed + builder.setDefaultCookieStore(null); + builder.disableCookieManagement(); + + // add custom keep alive strategy + builder.setKeepAliveStrategy(customKeepAliveStrategy()); + + // ask for gzip + builder.addInterceptorLast(new GzipRequestInterceptor()); + // uncompress gzip + builder.addInterceptorLast(new GzipResponseInterceptor()); + // Proxy + builder.setRoutePlanner(ProxySettings.RoutePlanner); + builder.setDefaultCredentialsProvider(ProxySettings.CredsProvider); + + return builder; } - + private static PoolingHttpClientConnectionManager initPoolingConnectionManager() { - final PlainConnectionSocketFactory plainsf = PlainConnectionSocketFactory.getSocketFactory(); - final Registry registry = RegistryBuilder.create() - .register("http", plainsf) - .register("https", getSSLSocketFactory()) - .build(); - final PoolingHttpClientConnectionManager pooling = new PoolingHttpClientConnectionManager(registry, null, null, new DnsResolver(){ - @Override - public InetAddress[] resolve(final String host0)throws UnknownHostException { - final InetAddress ip = Domains.dnsResolve(host0); - if (ip == null) throw new UnknownHostException(host0); - return new InetAddress[]{ip}; - }}, DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE, TimeUnit.SECONDS); + final PlainConnectionSocketFactory plainsf = PlainConnectionSocketFactory.getSocketFactory(); + final Registry registry = RegistryBuilder.create() + .register("http", plainsf) + .register("https", getSSLSocketFactory()) + .build(); + final PoolingHttpClientConnectionManager pooling = new PoolingHttpClientConnectionManager(registry, null, null, new DnsResolver(){ + @Override + public InetAddress[] resolve(final String host0)throws UnknownHostException { + final InetAddress ip = Domains.dnsResolve(host0); + if (ip == null) throw new UnknownHostException(host0); + return new InetAddress[]{ip}; + }}, DEFAULT_POOLED_CONNECTION_TIME_TO_LIVE, TimeUnit.SECONDS); initPoolMaxConnections(pooling, maxcon); - + pooling.setValidateAfterInactivity(default_timeout); // on init set to default 5000ms final SocketConfig socketConfig = SocketConfig.custom() // Defines whether the socket can be bound even though a previous connection is still in a timeout state. @@ -273,57 +273,57 @@ public class HTTPClient implements Closeable { return pooling; } - - /** - * Initialize the maximum connections for the given pool - * - * @param pool - * a pooling connection manager. Must not be null. - * @param maxConnections. - * The new maximum connections values. Must be greater than 0. - * @throws IllegalArgumentException - * when pool is null or when maxConnections is lower than 1 - */ - public static void initPoolMaxConnections(final PoolingHttpClientConnectionManager pool, int maxConnections) { - if (pool == null) { - throw new IllegalArgumentException("pool parameter must not be null"); - } - if (maxConnections <= 0) { - throw new IllegalArgumentException("maxConnections parameter must be greater than zero"); - } - pool.setMaxTotal(maxConnections); - // for statistics same value should also be set here - ConnectionInfo.setMaxcount(maxConnections); - + + /** + * Initialize the maximum connections for the given pool + * + * @param pool + * a pooling connection manager. Must not be null. + * @param maxConnections. + * The new maximum connections values. Must be greater than 0. + * @throws IllegalArgumentException + * when pool is null or when maxConnections is lower than 1 + */ + public static void initPoolMaxConnections(final PoolingHttpClientConnectionManager pool, final int maxConnections) { + if (pool == null) { + throw new IllegalArgumentException("pool parameter must not be null"); + } + if (maxConnections <= 0) { + throw new IllegalArgumentException("maxConnections parameter must be greater than zero"); + } + pool.setMaxTotal(maxConnections); + // for statistics same value should also be set here + ConnectionInfo.setMaxcount(maxConnections); + // connections per host (2 default) pool.setDefaultMaxPerRoute((int) (2 * Memory.cores())); - - // Increase max connections for localhost - final HttpHost localhost = new HttpHost(Domains.LOCALHOST); - pool.setMaxPerRoute(new HttpRoute(localhost), maxConnections); - } - /** - * This method should be called just before shutdown to stop the - * ConnectionManager and the idle connections evictor. - * - * @throws InterruptedException - * when the current thread is interrupted before the idle - * connections evictor thread termination. - */ - public static void closeConnectionManager() throws InterruptedException { - try { - if (EXPIRED_CONNECTIONS_EVICTOR != null) { - // Shut down the evictor thread - EXPIRED_CONNECTIONS_EVICTOR.shutdown(); - EXPIRED_CONNECTIONS_EVICTOR.awaitTermination(1L, TimeUnit.SECONDS); - } - } finally { - if (CONNECTION_MANAGER != null) { - CONNECTION_MANAGER.shutdown(); - } - } - } + // Increase max connections for localhost + final HttpHost localhost = new HttpHost(Domains.LOCALHOST); + pool.setMaxPerRoute(new HttpRoute(localhost), maxConnections); + } + + /** + * This method should be called just before shutdown to stop the + * ConnectionManager and the idle connections evictor. + * + * @throws InterruptedException + * when the current thread is interrupted before the idle + * connections evictor thread termination. + */ + public static void closeConnectionManager() throws InterruptedException { + try { + if (EXPIRED_CONNECTIONS_EVICTOR != null) { + // Shut down the evictor thread + EXPIRED_CONNECTIONS_EVICTOR.shutdown(); + EXPIRED_CONNECTIONS_EVICTOR.awaitTermination(1L, TimeUnit.SECONDS); + } + } finally { + if (CONNECTION_MANAGER != null) { + CONNECTION_MANAGER.shutdown(); + } + } + } /** * This method sets the Header used for the request @@ -331,7 +331,7 @@ public class HTTPClient implements Closeable { * @param entrys to be set as request header */ public void setHeader(final Set> entrys) { - this.headers = entrys; + this.headers = entrys; } /** @@ -340,9 +340,9 @@ public class HTTPClient implements Closeable { * @param timeout in milliseconds */ public void setTimout(final int timeout) { - reqConfBuilder.setSocketTimeout(timeout); - reqConfBuilder.setConnectTimeout(timeout); - reqConfBuilder.setConnectionRequestTimeout(timeout); + this.reqConfBuilder.setSocketTimeout(timeout); + this.reqConfBuilder.setConnectTimeout(timeout); + this.reqConfBuilder.setConnectionRequestTimeout(timeout); } /** @@ -351,7 +351,7 @@ public class HTTPClient implements Closeable { * @param userAgent */ public void setUserAgent(final ClientIdentification.Agent agent) { - clientBuilder.setUserAgent(agent.userAgent); + clientBuilder.setUserAgent(agent.userAgent); } /** @@ -360,7 +360,7 @@ public class HTTPClient implements Closeable { * @param host */ public void setHost(final String host) { - this.host = host; + this.host = host; } /** @@ -369,8 +369,8 @@ public class HTTPClient implements Closeable { * @param redirecting */ public void setRedirecting(final boolean redirecting) { - reqConfBuilder.setRedirectsEnabled(redirecting); - reqConfBuilder.setRelativeRedirectsAllowed(redirecting); + this.reqConfBuilder.setRedirectsEnabled(redirecting); + this.reqConfBuilder.setRelativeRedirectsAllowed(redirecting); } /** @@ -379,7 +379,7 @@ public class HTTPClient implements Closeable { * @param uri the url to get * @param username user name for HTTP authentication : only sent requesting localhost * @param pass password for HTTP authentication : only sent when requesting localhost - * @param concurrent whether a new thread should be created to handle the request. + * @param concurrent whether a new thread should be created to handle the request. * Ignored when requesting localhost or when the authentication password is not null * @return content bytes * @throws IOException @@ -394,7 +394,7 @@ public class HTTPClient implements Closeable { * @param uri the url to get * @param username user name for HTTP authentication : only sent requesting localhost * @param pass password for HTTP authentication : only sent when requesting localhost - * @param concurrent whether a new thread should be created to handle the request. + * @param concurrent whether a new thread should be created to handle the request. * Ignored when requesting localhost or when the authentication password is not null * @return content bytes * @throws IOException @@ -410,7 +410,7 @@ public class HTTPClient implements Closeable { * @param username user name for HTTP authentication : only sent requesting localhost * @param pass password for HTTP authentication : only sent when requesting localhost * @param maxBytes to get - * @param concurrent whether a new thread should be created to handle the request. + * @param concurrent whether a new thread should be created to handle the request. * Ignored when requesting localhost or when the authentication password is not null * @return content bytes * @throws IOException @@ -427,7 +427,7 @@ public class HTTPClient implements Closeable { * @param username user name for HTTP authentication : only sent requesting localhost * @param pass password for HTTP authentication : only sent when requesting localhost * @param maxBytes maximum response bytes to read - * @param concurrent whether a new thread should be created to handle the request. + * @param concurrent whether a new thread should be created to handle the request. * Ignored when requesting localhost or when the authentication password is not null * @return content bytes * @throws IOException @@ -435,34 +435,34 @@ public class HTTPClient implements Closeable { public byte[] GETbytes(final MultiProtocolURL url, final String username, final String pass, final int maxBytes, final boolean concurrent) throws IOException { final boolean localhost = Domains.isLocalhost(url.getHost()); final String urix = url.toNormalform(true); - + try { this.currentRequest = new HttpGet(urix); - } catch (IllegalArgumentException e) { + } catch (final IllegalArgumentException e) { throw new IOException(e.getMessage()); // can be caused at java.net.URI.create() } if (!localhost) setHost(url.getHost()); // overwrite resolved IP, needed for shared web hosting DO NOT REMOVE, see http://en.wikipedia.org/wiki/Shared_web_hosting_service if (!localhost || pass == null) { return getContentBytes(maxBytes, concurrent); } - - CredentialsProvider credsProvider = new BasicCredentialsProvider(); + + final CredentialsProvider credsProvider = new BasicCredentialsProvider(); credsProvider.setCredentials( - new AuthScope("localhost", url.getPort()), + new AuthScope("localhost", url.getPort()), new UsernamePasswordCredentials(username, pass)); - + try (final CloseableHttpClient httpclient = clientBuilder.setDefaultCredentialsProvider(credsProvider) .setDefaultAuthSchemeRegistry(AUTHSCHEMEREGISTRY).build()) { this.httpResponse = httpclient.execute(this.currentRequest); - HttpEntity httpEntity = this.httpResponse.getEntity(); + final HttpEntity httpEntity = this.httpResponse.getEntity(); if (httpEntity != null) { if (getStatusCode() == HttpStatus.SC_OK) { - if (maxBytes >= 0 && httpEntity.getContentLength() > maxBytes) { - /* When anticipated content length is already known and exceed the specified limit : - * throw an exception and abort the connection, consistently with getByteArray() implementation - * Otherwise returning null and consuming fully the entity can be very long on large resources */ - throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); - } + if (maxBytes >= 0 && httpEntity.getContentLength() > maxBytes) { + /* When anticipated content length is already known and exceed the specified limit : + * throw an exception and abort the connection, consistently with getByteArray() implementation + * Otherwise returning null and consuming fully the entity can be very long on large resources */ + throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); + } return getByteArray(httpEntity, maxBytes); } } @@ -471,7 +471,7 @@ public class HTTPClient implements Closeable { } return null; } - + /** * This method GETs a page from the server. * to be used for streaming out @@ -481,7 +481,7 @@ public class HTTPClient implements Closeable { * @throws IOException */ public void GET(final String uri, final boolean concurrent) throws IOException { - GET(new MultiProtocolURL(uri), concurrent); + GET(new MultiProtocolURL(uri), concurrent); } /** @@ -495,14 +495,14 @@ public class HTTPClient implements Closeable { public void GET(final MultiProtocolURL url, final boolean concurrent) throws IOException { if (this.currentRequest != null) throw new IOException("Client is in use!"); final String urix = url.toNormalform(true); - + try { this.currentRequest = new HttpGet(urix); - } catch (IllegalArgumentException e) { + } catch (final IllegalArgumentException e) { throw new IOException(e.getMessage()); // can be caused at java.net.URI.create() } setHost(url.getHost()); // overwrite resolved IP, needed for shared web hosting DO NOT REMOVE, see http://en.wikipedia.org/wiki/Shared_web_hosting_service - + execute(concurrent); } @@ -514,7 +514,7 @@ public class HTTPClient implements Closeable { * @throws IOException */ public HttpResponse HEADResponse(final String uri, final boolean concurrent) throws IOException { - return HEADResponse(new MultiProtocolURL(uri), concurrent); + return HEADResponse(new MultiProtocolURL(uri), concurrent); } /** @@ -527,8 +527,8 @@ public class HTTPClient implements Closeable { public HttpResponse HEADResponse(final MultiProtocolURL url, final boolean concurrent) throws IOException { this.currentRequest = new HttpHead(url.toNormalform(true)); setHost(url.getHost()); // overwrite resolved IP, needed for shared web hosting DO NOT REMOVE, see http://en.wikipedia.org/wiki/Shared_web_hosting_service - execute(concurrent); - return this.httpResponse; + execute(concurrent); + return this.httpResponse; } /** @@ -543,10 +543,10 @@ public class HTTPClient implements Closeable { */ /* public void POST(final String uri, final InputStream instream, final long length, final boolean concurrent) throws IOException { - POST(new MultiProtocolURL(uri), instream, length, concurrent); + POST(new MultiProtocolURL(uri), instream, length, concurrent); } */ - + /** * This method POSTs a page from the server. * to be used for streaming out @@ -558,16 +558,16 @@ public class HTTPClient implements Closeable { * @throws IOException */ public void POST(final MultiProtocolURL url, final InputStream instream, final long length, final boolean concurrent) throws IOException { - if (this.currentRequest != null) throw new IOException("Client is in use!"); - this.currentRequest = new HttpPost(url.toNormalform(true)); + if (this.currentRequest != null) throw new IOException("Client is in use!"); + this.currentRequest = new HttpPost(url.toNormalform(true)); String host = url.getHost(); if (host == null) host = Domains.LOCALHOST; setHost(host); // overwrite resolved IP, needed for shared web hosting DO NOT REMOVE, see http://en.wikipedia.org/wiki/Shared_web_hosting_service final NonClosingInputStreamEntity inputStreamEntity = new NonClosingInputStreamEntity(instream, length); - // statistics - this.upbytes = length; - ((HttpPost) this.currentRequest).setEntity(inputStreamEntity); - execute(concurrent); + // statistics + this.upbytes = length; + ((HttpPost) this.currentRequest).setEntity(inputStreamEntity); + execute(concurrent); } /** @@ -584,7 +584,7 @@ public class HTTPClient implements Closeable { return POSTbytes(url, url.getHost(), parts, usegzip, concurrent); } */ - + /** * send data to the server named by vhost * @@ -596,9 +596,9 @@ public class HTTPClient implements Closeable { * @throws IOException */ public byte[] POSTbytes(final MultiProtocolURL url, final String vhost, final Map post, final boolean usegzip, final boolean concurrent) throws IOException { - return POSTbytes(url, vhost, post, null, null, usegzip, concurrent); + return POSTbytes(url, vhost, post, null, null, usegzip, concurrent); } - + /** * Send data using HTTP POST method to the server named by vhost * @@ -611,16 +611,16 @@ public class HTTPClient implements Closeable { * @return response body * @throws IOException when an error occurred */ - public byte[] POSTbytes(final MultiProtocolURL url, final String vhost, final Map post, - final String userName, final String password, final boolean usegzip, final boolean concurrent) throws IOException { + public byte[] POSTbytes(final MultiProtocolURL url, final String vhost, final Map post, + final String userName, final String password, final boolean usegzip, final boolean concurrent) throws IOException { this.currentRequest = new HttpPost(url.toNormalform(true)); - final boolean localhost = Domains.isLocalhost(url.getHost()); + final boolean localhost = Domains.isLocalhost(url.getHost()); if (!localhost) setHost(url.getHost()); // overwrite resolved IP, needed for shared web hosting DO NOT REMOVE, see http://en.wikipedia.org/wiki/Shared_web_hosting_service - if (vhost == null) setHost(Domains.LOCALHOST); - - final MultipartEntityBuilder entityBuilder = MultipartEntityBuilder.create(); - for (final Entry part : post.entrySet()) entityBuilder.addPart(part.getKey(), part.getValue()); - final HttpEntity multipartEntity = entityBuilder.build(); + if (vhost == null) setHost(Domains.LOCALHOST); + + final MultipartEntityBuilder entityBuilder = MultipartEntityBuilder.create(); + for (final Entry part : post.entrySet()) entityBuilder.addPart(part.getKey(), part.getValue()); + final HttpEntity multipartEntity = entityBuilder.build(); // statistics this.upbytes = multipartEntity.getContentLength(); @@ -629,11 +629,11 @@ public class HTTPClient implements Closeable { } else { ((HttpPost) this.currentRequest).setEntity(multipartEntity); } - + if (!localhost || password == null) { return getContentBytes(Integer.MAX_VALUE, concurrent); } - + final CredentialsProvider credsProvider = new BasicCredentialsProvider(); credsProvider.setCredentials( new AuthScope("localhost", url.getPort()), @@ -642,7 +642,7 @@ public class HTTPClient implements Closeable { try (final CloseableHttpClient httpclient = clientBuilder.setDefaultCredentialsProvider(credsProvider) .setDefaultAuthSchemeRegistry(AUTHSCHEMEREGISTRY).build()) { this.httpResponse = httpclient.execute(this.currentRequest); - HttpEntity httpEntity = this.httpResponse.getEntity(); + final HttpEntity httpEntity = this.httpResponse.getEntity(); if (httpEntity != null) { if (getStatusCode() == HttpStatus.SC_OK) { return getByteArray(httpEntity, Integer.MAX_VALUE); @@ -680,88 +680,88 @@ public class HTTPClient implements Closeable { */ /** - * - * @return HttpResponse from call - */ + * + * @return HttpResponse from call + */ public HttpResponse getHttpResponse() { - return this.httpResponse; - } + return this.httpResponse; + } - /** - * - * @return status code from http request - */ + /** + * + * @return status code from http request + */ public int getStatusCode() { - return this.httpResponse.getStatusLine().getStatusCode(); - } - + return this.httpResponse.getStatusLine().getStatusCode(); + } + /** * Get Mime type from the response header * @return mime type (trimmed and lower cased) or null when not specified */ - public String getMimeType() { - String mimeType = null; - if (this.httpResponse != null) { + public String getMimeType() { + String mimeType = null; + if (this.httpResponse != null) { - Header contentType = this.httpResponse.getFirstHeader(HttpHeaders.CONTENT_TYPE); + final Header contentType = this.httpResponse.getFirstHeader(HttpHeaders.CONTENT_TYPE); - if (contentType != null) { + if (contentType != null) { - mimeType = contentType.getValue(); + mimeType = contentType.getValue(); - if (mimeType != null) { - mimeType = mimeType.trim().toLowerCase(Locale.ROOT); + if (mimeType != null) { + mimeType = mimeType.trim().toLowerCase(Locale.ROOT); - final int pos = mimeType.indexOf(';'); - if(pos >= 0) { - mimeType = mimeType.substring(0, pos); - } - } - } - } - return mimeType; - } - - /** - * Get character encoding from the response header - * - * @return the characters set name or null when not specified - */ - public String getCharacterEncoding() { - String charsetName = null; - if (this.httpResponse != null) { + final int pos = mimeType.indexOf(';'); + if(pos >= 0) { + mimeType = mimeType.substring(0, pos); + } + } + } + } + return mimeType; + } - Header contentTypeHeader = this.httpResponse.getFirstHeader(HttpHeaders.CONTENT_TYPE); + /** + * Get character encoding from the response header + * + * @return the characters set name or null when not specified + */ + public String getCharacterEncoding() { + String charsetName = null; + if (this.httpResponse != null) { - if (contentTypeHeader != null) { + final Header contentTypeHeader = this.httpResponse.getFirstHeader(HttpHeaders.CONTENT_TYPE); - String contentType = contentTypeHeader.getValue(); + if (contentTypeHeader != null) { - if (contentType != null) { + final String contentType = contentTypeHeader.getValue(); - final String[] parts = CommonPattern.SEMICOLON.split(contentType); - if (parts != null && parts.length > 1) { + if (contentType != null) { - for (int i = 1; i < parts.length; i++) { - final String param = parts[i].trim(); - if (param.startsWith("charset=")) { - String charset = param.substring("charset=".length()).trim(); - if (charset.length() > 0 && (charset.charAt(0) == '\"' || charset.charAt(0) == '\'')) { - charset = charset.substring(1); - } - if (charset.endsWith("\"") || charset.endsWith("'")) { - charset = charset.substring(0, charset.length() - 1); - } - charsetName = charset.trim(); - } - } - } - } - } - } + final String[] parts = CommonPattern.SEMICOLON.split(contentType); + if (parts != null && parts.length > 1) { - return charsetName; - } + for (int i = 1; i < parts.length; i++) { + final String param = parts[i].trim(); + if (param.startsWith("charset=")) { + String charset = param.substring("charset=".length()).trim(); + if (charset.length() > 0 && (charset.charAt(0) == '\"' || charset.charAt(0) == '\'')) { + charset = charset.substring(1); + } + if (charset.endsWith("\"") || charset.endsWith("'")) { + charset = charset.substring(0, charset.length() - 1); + } + charsetName = charset.trim(); + } + } + } + } + } + } + + return charsetName; + } /** * This method gets direct access to the content-stream @@ -771,7 +771,7 @@ public class HTTPClient implements Closeable { * @return the content as InputStream * @throws IOException */ - public InputStream getContentstream() throws IOException { + public InputStream getContentstream() throws IOException { if (this.httpResponse != null && this.currentRequest != null) { final HttpEntity httpEntity = this.httpResponse.getEntity(); if (httpEntity != null) try { @@ -791,7 +791,7 @@ public class HTTPClient implements Closeable { * @param outputStream * @throws IOException */ - public void writeTo(final OutputStream outputStream) throws IOException { + public void writeTo(final OutputStream outputStream) throws IOException { if (this.httpResponse != null && this.currentRequest != null) { final HttpEntity httpEntity = this.httpResponse.getEntity(); if (httpEntity != null) try { @@ -809,25 +809,25 @@ public class HTTPClient implements Closeable { * * @throws IOException */ - @Override + @Override public void close() throws IOException { - try { - if (this.httpResponse != null) { + try { + if (this.httpResponse != null) { // Ensures that the entity content Stream is closed. EntityUtils.consumeQuietly(this.httpResponse.getEntity()); - this.httpResponse.close(); - } - if (this.client != null) { - client.close(); - } - } finally { - if (this.currentRequest != null) { - ConnectionInfo.removeConnection(this.currentRequest.hashCode()); - this.currentRequest.abort(); - this.currentRequest = null; - } - } - } + this.httpResponse.close(); + } + if (this.client != null) { + this.client.close(); + } + } finally { + if (this.currentRequest != null) { + ConnectionInfo.removeConnection(this.currentRequest.hashCode()); + this.currentRequest.abort(); + this.currentRequest = null; + } + } + } private byte[] getContentBytes(final int maxBytes, final boolean concurrent) throws IOException { try { @@ -837,77 +837,77 @@ public class HTTPClient implements Closeable { final HttpEntity httpEntity = this.httpResponse.getEntity(); if (httpEntity != null) { if (getStatusCode() == HttpStatus.SC_OK) { - if (maxBytes >= 0 && httpEntity.getContentLength() > maxBytes) { - /* When anticipated content length is already known and exceed the specified limit : - * throw an exception and abort the connection, consistently with getByteArray() implementation - * Otherwise returning null and consuming fully the entity can be very long on large resources */ - throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); - } + if (maxBytes >= 0 && httpEntity.getContentLength() > maxBytes) { + /* When anticipated content length is already known and exceed the specified limit : + * throw an exception and abort the connection, consistently with getByteArray() implementation + * Otherwise returning null and consuming fully the entity can be very long on large resources */ + throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); + } return getByteArray(httpEntity, maxBytes); } } } finally { - close(); + close(); } - return null; + return null; } private void execute(final boolean concurrent) throws IOException { - final HttpClientContext context = HttpClientContext.create(); - context.setRequestConfig(reqConfBuilder.build()); - if (this.host != null) - context.setTargetHost(new HttpHost(this.host)); - - setHeaders(); - // statistics - storeConnectionInfo(); - // execute the method; some asserts confirm that that the request can be send with Content-Length and is therefore not terminated by EOF - if (this.currentRequest instanceof HttpEntityEnclosingRequest) { - final HttpEntityEnclosingRequest hrequest = (HttpEntityEnclosingRequest) this.currentRequest; - final HttpEntity entity = hrequest.getEntity(); - assert entity != null; - //assert !entity.isChunked(); - //assert entity.getContentLength() >= 0; - assert !hrequest.expectContinue(); - } + final HttpClientContext context = HttpClientContext.create(); + context.setRequestConfig(this.reqConfBuilder.build()); + if (this.host != null) + context.setTargetHost(new HttpHost(this.host)); - final String initialThreadName = Thread.currentThread().getName(); - final String uri = this.currentRequest.getURI().toString(); - Thread.currentThread().setName("HTTPClient-" + uri); + setHeaders(); + // statistics + storeConnectionInfo(); + // execute the method; some asserts confirm that that the request can be send with Content-Length and is therefore not terminated by EOF + if (this.currentRequest instanceof HttpEntityEnclosingRequest) { + final HttpEntityEnclosingRequest hrequest = (HttpEntityEnclosingRequest) this.currentRequest; + final HttpEntity entity = hrequest.getEntity(); + assert entity != null; + //assert !entity.isChunked(); + //assert entity.getContentLength() >= 0; + assert !hrequest.expectContinue(); + } + + final String initialThreadName = Thread.currentThread().getName(); + final String uri = this.currentRequest.getURI().toString(); + Thread.currentThread().setName("HTTPClient-" + uri); final long time = System.currentTimeMillis(); - try { - - this.client = clientBuilder.build(); - if (concurrent) { - FutureTask t = new FutureTask(new Callable() { - @Override + try { + + this.client = clientBuilder.build(); + if (concurrent) { + final FutureTask t = new FutureTask(new Callable() { + @Override public CloseableHttpResponse call() throws ClientProtocolException, IOException { - CloseableHttpResponse response = client.execute(currentRequest, context); - return response; - } - }); - executor.execute(t); - try { - this.httpResponse = t.get(this.timeout, TimeUnit.MILLISECONDS); - } catch (ExecutionException e) { - throw e.getCause(); - } catch (Throwable e) {} - try {t.cancel(true);} catch (Throwable e) {} - if (this.httpResponse == null) { - throw new IOException("timout to client after " + this.timeout + "ms" + " for url " + uri); - } - } else { - this.httpResponse = client.execute(this.currentRequest, context); - } + final CloseableHttpResponse response = HTTPClient.this.client.execute(HTTPClient.this.currentRequest, context); + return response; + } + }); + executor.execute(t); + try { + this.httpResponse = t.get(this.timeout, TimeUnit.MILLISECONDS); + } catch (final ExecutionException e) { + throw e.getCause(); + } catch (final Throwable e) {} + try {t.cancel(true);} catch (final Throwable e) {} + if (this.httpResponse == null) { + throw new IOException("timout to client after " + this.timeout + "ms" + " for url " + uri); + } + } else { + this.httpResponse = this.client.execute(this.currentRequest, context); + } this.httpResponse.setHeader(HeaderFramework.RESPONSE_TIME_MILLIS, Long.toString(System.currentTimeMillis() - time)); } catch (final Throwable e) { close(); throw new IOException("Client can't execute: " - + (e.getCause() == null ? e.getMessage() : e.getCause().getMessage()) - + " duration=" + Long.toString(System.currentTimeMillis() - time) + " for url " + uri); + + (e.getCause() == null ? e.getMessage() : e.getCause().getMessage()) + + " duration=" + Long.toString(System.currentTimeMillis() - time) + " for url " + uri); } finally { - /* Restore the thread initial name */ - Thread.currentThread().setName(initialThreadName); + /* Restore the thread initial name */ + Thread.currentThread().setName(initialThreadName); } } @@ -918,81 +918,81 @@ public class HTTPClient implements Closeable { * @return content bytes or null when entity content is null. * @throws IOException when a read error occured or content length is over maxBytes */ - public static byte[] getByteArray(final HttpEntity entity, int maxBytes) throws IOException { - try (final InputStream instream = entity.getContent()) { - if (instream == null) { - return null; - } - long contentLength = entity.getContentLength(); - /* - * When no maxBytes is specified, the default limit is - * Integer.MAX_VALUE as a byte array size can not be over - */ - if (maxBytes < 0) { - maxBytes = Integer.MAX_VALUE; - } - /* - * Content length may already be known now : check it before - * downloading - */ - if (contentLength > maxBytes) { - throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); - } - int initialSize = Math.min(maxBytes, (int) contentLength); - /* ContentLenght may be negative because unknown for now */ - if (initialSize < 0) { - initialSize = 4096; - } - final ByteArrayBuffer buffer = new ByteArrayBuffer(initialSize); - byte[] tmp = new byte[4096]; - int l = 0; - /* Sum is a long to enable check against Integer.MAX_VALUE */ - long sum = 0; - while ((l = instream.read(tmp)) != -1) { - sum += l; - /* - * Check total length while downloading as content length might - * not be known at beginning - */ - if (sum > maxBytes) { - throw new IOException("Download exceeded maximum value of " + Formatter.bytesToString(maxBytes)); - } - buffer.append(tmp, 0, l); - } - return buffer.toByteArray(); - } catch (final OutOfMemoryError e) { - throw new IOException(e.toString()); - } finally { - // Ensures that the entity content is fully consumed and the content stream, if exists, is closed. + public static byte[] getByteArray(final HttpEntity entity, int maxBytes) throws IOException { + try (final InputStream instream = entity.getContent()) { + if (instream == null) { + return null; + } + final long contentLength = entity.getContentLength(); + /* + * When no maxBytes is specified, the default limit is + * Integer.MAX_VALUE as a byte array size can not be over + */ + if (maxBytes < 0) { + maxBytes = Integer.MAX_VALUE; + } + /* + * Content length may already be known now : check it before + * downloading + */ + if (contentLength > maxBytes) { + throw new IOException("Content to download exceed maximum value of " + Formatter.bytesToString(maxBytes)); + } + int initialSize = Math.min(maxBytes, (int) contentLength); + /* ContentLenght may be negative because unknown for now */ + if (initialSize < 0) { + initialSize = 4096; + } + final ByteArrayBuffer buffer = new ByteArrayBuffer(initialSize); + final byte[] tmp = new byte[4096]; + int l = 0; + /* Sum is a long to enable check against Integer.MAX_VALUE */ + long sum = 0; + while ((l = instream.read(tmp)) != -1) { + sum += l; + /* + * Check total length while downloading as content length might + * not be known at beginning + */ + if (sum > maxBytes) { + throw new IOException("Download exceeded maximum value of " + Formatter.bytesToString(maxBytes)); + } + buffer.append(tmp, 0, l); + } + return buffer.toByteArray(); + } catch (final OutOfMemoryError e) { + throw new IOException(e.toString()); + } finally { + // Ensures that the entity content is fully consumed and the content stream, if exists, is closed. EntityUtils.consume(entity); - } - } + } + } private void setHeaders() { - if (this.headers != null) { + if (this.headers != null) { for (final Entry entry : this.headers) { this.currentRequest.setHeader(entry.getKey(),entry.getValue()); } - } - if (this.host != null) this.currentRequest.setHeader(HTTP.TARGET_HOST, this.host); - this.currentRequest.setHeader(HTTP.CONN_DIRECTIVE, "close"); // don't keep alive, prevent CLOSE_WAIT state + } + if (this.host != null) this.currentRequest.setHeader(HTTP.TARGET_HOST, this.host); + this.currentRequest.setHeader(HTTP.CONN_DIRECTIVE, "close"); // don't keep alive, prevent CLOSE_WAIT state } private void storeConnectionInfo() { - final int port = this.currentRequest.getURI().getPort(); - final String thost = this.currentRequest.getURI().getHost(); - //assert thost != null : "uri = " + httpUriRequest.getURI().toString(); - ConnectionInfo.addConnection(new ConnectionInfo( - this.currentRequest.getURI().getScheme(), - port == -1 ? thost : thost + ":" + port, - this.currentRequest.getMethod() + " " + this.currentRequest.getURI().getPath(), - this.currentRequest.hashCode(), - System.currentTimeMillis(), - this.upbytes)); + final int port = this.currentRequest.getURI().getPort(); + final String thost = this.currentRequest.getURI().getHost(); + //assert thost != null : "uri = " + httpUriRequest.getURI().toString(); + ConnectionInfo.addConnection(new ConnectionInfo( + this.currentRequest.getURI().getScheme(), + port == -1 ? thost : thost + ":" + port, + this.currentRequest.getMethod() + " " + this.currentRequest.getURI().getPath(), + this.currentRequest.hashCode(), + System.currentTimeMillis(), + this.upbytes)); } private static SSLConnectionSocketFactory getSSLSocketFactory() { - final TrustManager trustManager = new X509TrustManager() { + final TrustManager trustManager = new X509TrustManager() { @Override public void checkClientTrusted(final X509Certificate[] chain, final String authType) throws CertificateException { @@ -1007,9 +1007,9 @@ public class HTTPClient implements Closeable { public X509Certificate[] getAcceptedIssuers() { return null; } - }; - SSLContext sslContext = null; - try { + }; + SSLContext sslContext = null; + try { sslContext = SSLContext.getInstance("TLS"); sslContext.init(null, new TrustManager[] { trustManager }, null); } catch (final NoSuchAlgorithmException e) { @@ -1023,17 +1023,17 @@ public class HTTPClient implements Closeable { return new SSLConnectionSocketFactory( sslContext, new NoopHostnameVerifier()) { - - @Override - protected void prepareSocket(SSLSocket socket) throws IOException { - if(!ENABLE_SNI_EXTENSION.get()) { - /* Set the SSLParameters server names to empty so we don't use SNI extension. - * See https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#ClientSNIExamples */ - final SSLParameters sslParams = socket.getSSLParameters(); - sslParams.setServerNames(Collections.emptyList()); - socket.setSSLParameters(sslParams); - } - } + + @Override + protected void prepareSocket(final SSLSocket socket) throws IOException { + if(!ENABLE_SNI_EXTENSION.get()) { + /* Set the SSLParameters server names to empty so we don't use SNI extension. + * See https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#ClientSNIExamples */ + final SSLParameters sslParams = socket.getSSLParameters(); + sslParams.setServerNames(Collections.emptyList()); + socket.setSSLParameters(sslParams); + } + } }; } @@ -1044,15 +1044,15 @@ public class HTTPClient implements Closeable { * * @param defaultHttpClient */ - private static ConnectionKeepAliveStrategy customKeepAliveStrategy() { - return new DefaultConnectionKeepAliveStrategy() { - @Override - public long getKeepAliveDuration(HttpResponse response, HttpContext context) { - long keepAlive = super.getKeepAliveDuration(response, context); - return Math.min(Math.max(keepAlive, 5000), 25000); - } - }; - } + private static ConnectionKeepAliveStrategy customKeepAliveStrategy() { + return new DefaultConnectionKeepAliveStrategy() { + @Override + public long getKeepAliveDuration(final HttpResponse response, final HttpContext context) { + final long keepAlive = super.getKeepAliveDuration(response, context); + return Math.min(Math.max(keepAlive, 5000), 25000); + } + }; + } /** * testing @@ -1084,28 +1084,28 @@ public class HTTPClient implements Closeable { } } // Head some -// try { -// client.HEADResponse(url); -// } catch (final IOException e) { -// e.printStackTrace(); -// } +// try { +// client.HEADResponse(url); +// } catch (final IOException e) { +// e.printStackTrace(); +// } for (final Header header: client.getHttpResponse().getAllHeaders()) { System.out.println("Header " + header.getName() + " : " + header.getValue()); -// for (HeaderElement element: header.getElements()) -// System.out.println("Element " + element.getName() + " : " + element.getValue()); +// for (HeaderElement element: header.getElements()) +// System.out.println("Element " + element.getName() + " : " + element.getValue()); } // System.out.println(client.getHttpResponse().getLocale()); System.out.println(client.getHttpResponse().getProtocolVersion()); System.out.println(client.getHttpResponse().getStatusLine()); // Post some -// try { -// System.out.println(UTF8.String(client.POSTbytes(url, newparts))); -// } catch (final IOException e1) { -// e1.printStackTrace(); -// } +// try { +// System.out.println(UTF8.String(client.POSTbytes(url, newparts))); +// } catch (final IOException e1) { +// e1.printStackTrace(); +// } // Close out connection manager try { - client.close(); + client.close(); HTTPClient.closeConnectionManager(); } catch (final InterruptedException | IOException e) { e.printStackTrace();