* - * An instance of this class will cache every HTTP 1.1 connections and close them when the {@link AsyncHttpClientConfig#getIdleConnectionTimeoutInMs()} + * An instance of this class will cache every HTTP 1.1 connections and close them when the {@link AsyncHttpClientConfig#getReadTimeout()} * expires. This object can hold many persistent connections to different host. */ -public class AsyncHttpClient { +public class AsyncHttpClient implements Closeable { private final static String DEFAULT_PROVIDER = "com.ning.http.client.providers.netty.NettyAsyncHttpProvider"; private final AsyncHttpProvider httpProvider; @@ -206,31 +212,20 @@ public AsyncHttpClient(String providerClass, AsyncHttpClientConfig config) { } public class BoundRequestBuilder extends RequestBuilderBase- * AsyncHttpClient c = new AsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(...).build()); + * AsyncHttpClient c = new AsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeout(...).build()); * Futuref = c.prepareGet(TARGET_URL).execute(); * Response r = f.get(); *
true if both the application and reaper thread pools
+ * haven't yet been shutdown.
*
- * @return true if the query parameters will be stripped from the request when a redirect is requested.
+ * @since 1.7.21
*/
- public boolean isRemoveQueryParamOnRedirect() {
- return removeQueryParamOnRedirect;
- }
-
- /**
- * Return true if one of the {@link java.util.concurrent.ExecutorService} has been shutdown.
- *
- * @return true if one of the {@link java.util.concurrent.ExecutorService} has been shutdown.
- */
- public boolean isClosed() {
- return applicationThreadPool.isShutdown() || reaper.isShutdown();
+ public boolean isValid() {
+ try {
+ return applicationThreadPool.isShutdown();
+ } catch (Exception ignore) {
+ // isShutdown() will thrown an exception in an EE7 environment
+ // when using a ManagedExecutorService.
+ // When this is the case, we assume it's running.
+ return true;
+ }
}
/**
@@ -449,6 +386,17 @@ public boolean isClosed() {
* @return the {@link HostnameVerifier}
*/
public HostnameVerifier getHostnameVerifier() {
+ if (hostnameVerifier == null) {
+ synchronized (this) {
+ if (hostnameVerifier == null)
+ hostnameVerifier = acceptAnyCertificate ? new HostnameVerifier() {
+ @Override
+ public boolean verify(String hostname, SSLSession session) {
+ return true;
+ }
+ } : new DefaultHostnameVerifier();
+ }
+ }
return hostnameVerifier;
}
@@ -476,54 +424,99 @@ public boolean isStrict302Handling() {
return strict302Handling;
}
+ /**
+ * @returntrue if AHC should use relative URIs instead of absolute ones when talking with a SSL proxy
+ * or WebSocket proxy, otherwise false.
+ *
+ * @since 1.8.13
+ */
+ public boolean isUseRelativeURIsWithConnectProxies() {
+ return useRelativeURIsWithConnectProxies;
+ }
+
+ /**
+ * Return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection in the pool, or -1 to keep connection while possible.
+ *
+ * @return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection in the pool, or -1 to keep connection while possible.
+ */
+ public int getConnectionTTL() {
+ return connectionTTL;
+ }
+
+ /**
+ * since 1.9.0
+ */
+ public boolean isAcceptAnyCertificate() {
+ return acceptAnyCertificate;
+ }
+
+ /**
+ * since 1.9.0
+ */
+ public String[] getEnabledProtocols() {
+ return enabledProtocols;
+ }
+
+ /**
+ * since 1.9.0
+ */
+ public String[] getEnabledCipherSuites() {
+ return enabledCipherSuites;
+ }
+
+ /**
+ * since 1.9.13
+ */
+ public Integer getSslSessionCacheSize() {
+ return sslSessionCacheSize;
+ }
+
+ /**
+ * since 1.9.13
+ */
+ public Integer getSslSessionTimeout() {
+ return sslSessionTimeout;
+ }
+
/**
* Builder for an {@link AsyncHttpClient}
*/
public static class Builder {
- private int defaultMaxTotalConnections = Integer.getInteger(ASYNC_CLIENT + "defaultMaxTotalConnections", -1);
- private int defaultMaxConnectionPerHost = Integer.getInteger(ASYNC_CLIENT + "defaultMaxConnectionsPerHost", -1);
- private int defaultConnectionTimeOutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultConnectionTimeoutInMS", 60 * 1000);
- private int defaultWebsocketIdleTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultWebsocketTimoutInMS", 15 * 60 * 1000);
- private int defaultIdleConnectionInPoolTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionInPoolTimeoutInMS", 60 * 1000);
- private int defaultIdleConnectionTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionTimeoutInMS", 60 * 1000);
- private int defaultRequestTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultRequestTimeoutInMS", 60 * 1000);
- private boolean redirectEnabled = Boolean.getBoolean(ASYNC_CLIENT + "defaultRedirectsEnabled");
- private int maxDefaultRedirects = Integer.getInteger(ASYNC_CLIENT + "defaultMaxRedirects", 5);
- private boolean compressionEnabled = Boolean.getBoolean(ASYNC_CLIENT + "compressionEnabled");
- private String userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "NING/1.0");
- private boolean useProxyProperties = Boolean.getBoolean(ASYNC_CLIENT + "useProxyProperties");
- private boolean allowPoolingConnection = true;
- private ScheduledExecutorService reaper = Executors.newScheduledThreadPool(Runtime.getRuntime().availableProcessors(), new ThreadFactory() {
- public Thread newThread(Runnable r) {
- Thread t = new Thread(r, "AsyncHttpClient-Reaper");
- t.setDaemon(true);
- return t;
- }
- });
- private ExecutorService applicationThreadPool = Executors.newCachedThreadPool(new ThreadFactory() {
- public Thread newThread(Runnable r) {
- Thread t = new Thread(r, "AsyncHttpClient-Callback");
- t.setDaemon(true);
- return t;
- }
- });
- private ProxyServer proxyServer = null;
+ private int connectTimeout = defaultConnectTimeout();
+ private int maxConnections = defaultMaxConnections();
+ private int maxConnectionsPerHost = defaultMaxConnectionsPerHost();
+ private int requestTimeout = defaultRequestTimeout();
+ private int readTimeout = defaultReadTimeout();
+ private int webSocketTimeout = defaultWebSocketTimeout();
+ private boolean allowPoolingConnections = defaultAllowPoolingConnections();
+ private boolean allowPoolingSslConnections = defaultAllowPoolingSslConnections();
+ private int pooledConnectionIdleTimeout = defaultPooledConnectionIdleTimeout();
+ private int connectionTTL = defaultConnectionTTL();
private SSLContext sslContext;
- private SSLEngineFactory sslEngineFactory;
- private AsyncHttpProviderConfig providerConfig;
- private ConnectionsPool connectionsPool;
+ private HostnameVerifier hostnameVerifier;
+ private boolean acceptAnyCertificate = defaultAcceptAnyCertificate();
+ private boolean followRedirect = defaultFollowRedirect();
+ private int maxRedirects = defaultMaxRedirects();
+ private boolean strict302Handling = defaultStrict302Handling();
+ private ProxyServerSelector proxyServerSelector = null;
+ private boolean useProxySelector = defaultUseProxySelector();
+ private boolean useProxyProperties = defaultUseProxyProperties();
+ private boolean useRelativeURIsWithConnectProxies = defaultUseRelativeURIsWithConnectProxies();
+ private boolean compressionEnforced = defaultCompressionEnforced();
+ private String userAgent = defaultUserAgent();
+ private ExecutorService applicationThreadPool;
private Realm realm;
- private int requestCompressionLevel = -1;
- private int maxRequestRetry = 5;
- private final Listtrue but {@link #setProxyServer(ProxyServer)}
+ * was used to explicitly set a proxy server, the latter is preferred.
+ *
+ * See http://docs.oracle.com/javase/7/docs/api/java/net/ProxySelector.html
*/
- public Builder setRemoveQueryParamsOnRedirect(boolean removeQueryParamOnRedirect) {
- this.removeQueryParamOnRedirect = removeQueryParamOnRedirect;
+ public Builder setUseProxySelector(boolean useProxySelector) {
+ this.useProxySelector = useProxySelector;
return this;
}
/**
* Sets whether AHC should use the default http.proxy* system properties
- * to obtain proxy information.
+ * to obtain proxy information. This differs from {@link #setUseProxySelector(boolean)}
+ * in that AsyncHttpClient will use its own logic to handle the system properties,
+ * potentially supporting other protocols that the the JDK ProxySelector doesn't.
*
- * If useProxyProperties is set to true but {@link #setProxyServer(ProxyServer)} was used
- * to explicitly set a proxy server, the latter is preferred.
+ * If useProxyProperties is set to true but {@link #setUseProxySelector(boolean)}
+ * was also set to true, the latter is preferred.
*
* See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html
*/
@@ -956,30 +889,77 @@ public Builder setStrict302Handling(final boolean strict302Handling) {
return this;
}
+ /**
+ * Configures this AHC instance to use relative URIs instead of absolute ones when talking with a SSL proxy or WebSocket proxy.
+ *
+ * @param useRelativeURIsWithConnectProxies
+ * @return this
+ *
+ * @since 1.8.13
+ */
+ public Builder setUseRelativeURIsWithConnectProxies(boolean useRelativeURIsWithConnectProxies) {
+ this.useRelativeURIsWithConnectProxies = useRelativeURIsWithConnectProxies;
+ return this;
+ }
+
+ /**
+ * Set the maximum time in millisecond connection can be added to the pool for further reuse
+ *
+ * @param connectionTTL the maximum time in millisecond connection can be added to the pool for further reuse
+ * @return a {@link Builder}
+ */
+ public Builder setConnectionTTL(int connectionTTL) {
+ this.connectionTTL = connectionTTL;
+ return this;
+ }
+
+ public Builder setAcceptAnyCertificate(boolean acceptAnyCertificate) {
+ this.acceptAnyCertificate = acceptAnyCertificate;
+ return this;
+ }
+
+ public Builder setEnabledProtocols(String[] enabledProtocols) {
+ this.enabledProtocols = enabledProtocols;
+ return this;
+ }
+
+ public Builder setEnabledCipherSuites(String[] enabledCipherSuites) {
+ this.enabledCipherSuites = enabledCipherSuites;
+ return this;
+ }
+
+ public Builder setSslSessionCacheSize(Integer sslSessionCacheSize) {
+ this.sslSessionCacheSize = sslSessionCacheSize;
+ return this;
+ }
+
+ public Builder setSslSessionTimeout(Integer sslSessionTimeout) {
+ this.sslSessionTimeout = sslSessionTimeout;
+ return this;
+ }
+
/**
* Create a config builder with values taken from the given prototype configuration.
*
* @param prototype the configuration to use as a prototype.
*/
public Builder(AsyncHttpClientConfig prototype) {
- allowPoolingConnection = prototype.getAllowPoolingConnection();
+ allowPoolingConnections = prototype.isAllowPoolingConnections();
providerConfig = prototype.getAsyncHttpProviderConfig();
- connectionsPool = prototype.getConnectionsPool();
- defaultConnectionTimeOutInMs = prototype.getConnectionTimeoutInMs();
- defaultIdleConnectionInPoolTimeoutInMs = prototype.getIdleConnectionInPoolTimeoutInMs();
- defaultIdleConnectionTimeoutInMs = prototype.getIdleConnectionTimeoutInMs();
- defaultMaxConnectionPerHost = prototype.getMaxConnectionPerHost();
- maxDefaultRedirects = prototype.getMaxRedirects();
- defaultMaxTotalConnections = prototype.getMaxTotalConnections();
- proxyServer = prototype.getProxyServer();
+ connectTimeout = prototype.getConnectTimeout();
+ pooledConnectionIdleTimeout = prototype.getPooledConnectionIdleTimeout();
+ readTimeout = prototype.getReadTimeout();
+ maxConnectionsPerHost = prototype.getMaxConnectionsPerHost();
+ connectionTTL = prototype.getConnectionTTL();
+ maxRedirects = prototype.getMaxRedirects();
+ maxConnections = prototype.getMaxConnections();
+ proxyServerSelector = prototype.getProxyServerSelector();
realm = prototype.getRealm();
- defaultRequestTimeoutInMs = prototype.getRequestTimeoutInMs();
+ requestTimeout = prototype.getRequestTimeout();
sslContext = prototype.getSSLContext();
- sslEngineFactory = prototype.getSSLEngineFactory();
userAgent = prototype.getUserAgent();
- redirectEnabled = prototype.isRedirectEnabled();
- compressionEnabled = prototype.isCompressionEnabled();
- reaper = prototype.reaper();
+ followRedirect = prototype.isFollowRedirect();
+ compressionEnforced = prototype.isCompressionEnforced();
applicationThreadPool = prototype.executorService();
requestFilters.clear();
@@ -990,14 +970,17 @@ public Builder(AsyncHttpClientConfig prototype) {
responseFilters.addAll(prototype.getResponseFilters());
ioExceptionFilters.addAll(prototype.getIOExceptionFilters());
- requestCompressionLevel = prototype.getRequestCompressionLevel();
- useRawUrl = prototype.isUseRawUrl();
+ disableUrlEncodingForBoundedRequests = prototype.isDisableUrlEncodingForBoundedRequests();
ioThreadMultiplier = prototype.getIoThreadMultiplier();
maxRequestRetry = prototype.getMaxRequestRetry();
- allowSslConnectionPool = prototype.getAllowPoolingConnection();
- removeQueryParamOnRedirect = prototype.isRemoveQueryParamOnRedirect();
+ allowPoolingSslConnections = prototype.isAllowPoolingConnections();
hostnameVerifier = prototype.getHostnameVerifier();
strict302Handling = prototype.isStrict302Handling();
+ enabledProtocols = prototype.enabledProtocols;
+ enabledCipherSuites = prototype.enabledCipherSuites;
+ sslSessionCacheSize = prototype.sslSessionCacheSize;
+ sslSessionTimeout = prototype.sslSessionTimeout;
+ acceptAnyCertificate = prototype.acceptAnyCertificate;
}
/**
@@ -1006,47 +989,61 @@ public Builder(AsyncHttpClientConfig prototype) {
* @return an {@link AsyncHttpClientConfig}
*/
public AsyncHttpClientConfig build() {
-
- if (applicationThreadPool.isShutdown()) {
- throw new IllegalStateException("ExecutorServices closed");
- }
-
- if (proxyServer == null && useProxyProperties) {
- proxyServer = ProxyUtils.createProxy(System.getProperties());
+ if (applicationThreadPool == null) {
+ applicationThreadPool = Executors.newCachedThreadPool(new ThreadFactory() {
+ public Thread newThread(Runnable r) {
+ Thread t = new Thread(r, "AsyncHttpClient-Callback");
+ t.setDaemon(true);
+ return t;
+ }
+ });
}
- return new AsyncHttpClientConfig(defaultMaxTotalConnections,
- defaultMaxConnectionPerHost,
- defaultConnectionTimeOutInMs,
- defaultWebsocketIdleTimeoutInMs,
- defaultIdleConnectionInPoolTimeoutInMs,
- defaultIdleConnectionTimeoutInMs,
- defaultRequestTimeoutInMs,
- redirectEnabled,
- maxDefaultRedirects,
- compressionEnabled,
- userAgent,
- allowPoolingConnection,
- reaper,
- applicationThreadPool,
- proxyServer,
- sslContext,
- sslEngineFactory,
- providerConfig,
- connectionsPool,
- realm,
- requestFilters,
- responseFilters,
- ioExceptionFilters,
- requestCompressionLevel,
- maxRequestRetry,
- allowSslConnectionPool,
- useRawUrl,
- removeQueryParamOnRedirect,
- hostnameVerifier,
- ioThreadMultiplier,
- strict302Handling);
+ if (proxyServerSelector == null && useProxySelector)
+ proxyServerSelector = ProxyUtils.getJdkDefaultProxyServerSelector();
+
+ if (proxyServerSelector == null && useProxyProperties)
+ proxyServerSelector = ProxyUtils.createProxyServerSelector(System.getProperties());
+
+ if (proxyServerSelector == null)
+ proxyServerSelector = ProxyServerSelector.NO_PROXY_SELECTOR;
+
+ if (acceptAnyCertificate)
+ hostnameVerifier = null;
+
+ return new AsyncHttpClientConfig(connectTimeout,//
+ maxConnections,//
+ maxConnectionsPerHost,//
+ requestTimeout,//
+ readTimeout,//
+ webSocketTimeout,//
+ allowPoolingConnections,//
+ allowPoolingSslConnections,//
+ pooledConnectionIdleTimeout,//
+ connectionTTL,//
+ sslContext, //
+ hostnameVerifier,//
+ acceptAnyCertificate, //
+ followRedirect, //
+ maxRedirects, //
+ strict302Handling, //
+ applicationThreadPool, //
+ proxyServerSelector, //
+ useRelativeURIsWithConnectProxies, //
+ compressionEnforced, //
+ userAgent,//
+ realm,//
+ requestFilters, //
+ responseFilters,//
+ ioExceptionFilters,//
+ maxRequestRetry, //
+ disableUrlEncodingForBoundedRequests, //
+ ioThreadMultiplier, //
+ enabledProtocols, //
+ enabledCipherSuites, //
+ sslSessionCacheSize, //
+ sslSessionTimeout, //
+ providerConfig);
}
}
}
-
diff --git a/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java b/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java
index 0924d4d760..7cd690ca89 100644
--- a/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java
+++ b/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java
@@ -12,6 +12,8 @@
*/
package com.ning.http.client;
+import static com.ning.http.client.AsyncHttpClientConfigDefaults.*;
+
import com.ning.http.client.filter.IOExceptionFilter;
import com.ning.http.client.filter.RequestFilter;
import com.ning.http.client.filter.ResponseFilter;
@@ -19,11 +21,10 @@
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;
-import javax.net.ssl.SSLSession;
+
import java.util.LinkedList;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
/**
@@ -38,50 +39,43 @@ public AsyncHttpClientConfigBean() {
}
void configureFilters() {
- requestFilters = new LinkedListAdds a listener and executor to the ListenableFuture.
* The listener will be {@linkplain java.util.concurrent.Executor#execute(Runnable) passed
@@ -97,4 +82,60 @@ public interface ListenableFuture
*/
-public class SimpleAsyncHttpClient {
+public class SimpleAsyncHttpClient implements AutoCloseable {
- private final static Logger logger = LoggerFactory.getLogger(SimpleAsyncHttpClient.class);
private final AsyncHttpClientConfig config;
private final RequestBuilder requestBuilder;
private AsyncHttpClient asyncHttpClient;
@@ -68,8 +72,9 @@ public class SimpleAsyncHttpClient {
private final ErrorDocumentBehaviour errorDocumentBehaviour;
private final SimpleAHCTransferListener listener;
private final boolean derived;
+ private String providerClass;
- private SimpleAsyncHttpClient(AsyncHttpClientConfig config, RequestBuilder requestBuilder, ThrowableHandler defaultThrowableHandler, ErrorDocumentBehaviour errorDocumentBehaviour, boolean resumeEnabled, AsyncHttpClient ahc, SimpleAHCTransferListener listener) {
+ private SimpleAsyncHttpClient(AsyncHttpClientConfig config, RequestBuilder requestBuilder, ThrowableHandler defaultThrowableHandler, ErrorDocumentBehaviour errorDocumentBehaviour, boolean resumeEnabled, AsyncHttpClient ahc, SimpleAHCTransferListener listener, String providerClass) {
this.config = config;
this.requestBuilder = requestBuilder;
this.defaultThrowableHandler = defaultThrowableHandler;
@@ -77,6 +82,7 @@ private SimpleAsyncHttpClient(AsyncHttpClientConfig config, RequestBuilder reque
this.errorDocumentBehaviour = errorDocumentBehaviour;
this.asyncHttpClient = ahc;
this.listener = listener;
+ this.providerClass = providerClass;
this.derived = ahc != null;
}
@@ -271,7 +277,7 @@ private Future
* SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder()
- * .setIdleConnectionInPoolTimeoutInMs(100)
+ * .setIdleConnectionInPoolTimeout(100)
* .setMaximumConnectionsTotal(50)
- * .setRequestTimeoutInMs(5 * 60 * 1000)
+ * .setRequestTimeout(5 * 60 * 1000)
* .setUrl(getTargetUrl())
* .setHeader("Content-Type", "text/html").build();
*
@@ -57,9 +62,8 @@
* Future