Package interlok.http.apache.async

Class DefaultAsyncClientBuilder

  • All Implemented Interfaces:
    HttpAsyncClientBuilderConfig
    @ComponentProfile(since="4.5.0",
                  summary="Provides some sensible default behaviour when configuring the HttpAsyncClient")
public class DefaultAsyncClientBuilder
extends java.lang.Object
implements HttpAsyncClientBuilderConfig
    Provides some sensible default behaviour for configuring an HttpAsyncClientBuilder.

    In the adapter configuration file this class is aliased as apache-http-default-async-client-builder which is the preferred alternative to the fully qualified classname when building your configuration.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.http.impl.nio.client.HttpAsyncClientBuilder configure​(org.apache.http.impl.nio.client.HttpAsyncClientBuilder builder)
      Do any additional configuration.
      protected org.apache.http.impl.nio.client.HttpAsyncClientBuilder customiseTimeouts​(org.apache.http.impl.nio.client.HttpAsyncClientBuilder builder)  
      TimeInterval getConnectTimeout()
      The connect timeout which is set on RequestConfig.Builder#setConnectTimeout(int)
      java.lang.String getHttpProxy()
      Explicitly configurd proxy server.
      TimeInterval getSocketTimeout()
      The socket timeout is set on RequestConfig.Builder#setSocketTimeout(int)
      void setConnectTimeout​(TimeInterval connectTimeout)
      The connect timeout which is set on RequestConfig.Builder#setConnectTimeout(int)
      void setHttpProxy​(java.lang.String httpProxy)
      Explicitly configurd proxy server.
      void setSocketTimeout​(TimeInterval socketTimeout)
      The socket timeout is set on RequestConfig.Builder#setSocketTimeout(int)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DefaultAsyncClientBuilder

        public DefaultAsyncClientBuilder()

    • Method Detail

      • configure

        public org.apache.http.impl.nio.client.HttpAsyncClientBuilder configure​(org.apache.http.impl.nio.client.HttpAsyncClientBuilder builder)
        Description copied from interface: HttpAsyncClientBuilderConfig
        Do any additional configuration.
        Specified by:
        configure in interface HttpAsyncClientBuilderConfig
        Parameters:
        builder - the existing builder
        Returns:
        a reconfigured builder.

      • customiseTimeouts

        protected org.apache.http.impl.nio.client.HttpAsyncClientBuilder customiseTimeouts​(org.apache.http.impl.nio.client.HttpAsyncClientBuilder builder)

      • getHttpProxy

        public java.lang.String getHttpProxy()
        Explicitly configurd proxy server.

        Follows the form scheme://host:port or more simply host:port and if it ends up being just a : then is assumed that no proxy is required (this is to make it more convenient to migrate configuration through environments, some of which may require a proxy, some not.

      • setHttpProxy

        public void setHttpProxy​(java.lang.String httpProxy)
        Explicitly configurd proxy server.

        Follows the form scheme://host:port or more simply host:port and if it ends up being just a : then is assumed that no proxy is required (this is to make it more convenient to migrate configuration through environments, some of which may require a proxy, some not.

      • getConnectTimeout

        public TimeInterval getConnectTimeout()
        The connect timeout which is set on RequestConfig.Builder#setConnectTimeout(int)

      • setConnectTimeout

        public void setConnectTimeout​(TimeInterval connectTimeout)
        The connect timeout which is set on RequestConfig.Builder#setConnectTimeout(int)

      • getSocketTimeout

        public TimeInterval getSocketTimeout()
        The socket timeout is set on RequestConfig.Builder#setSocketTimeout(int)

      • setSocketTimeout

        public void setSocketTimeout​(TimeInterval socketTimeout)
        The socket timeout is set on RequestConfig.Builder#setSocketTimeout(int)