Package io.wcm.caravan.commons.httpasyncclient

Interface HttpAsyncClientFactory

  • @ProviderType
public interface HttpAsyncClientFactory
    Interface for getting a pre-configured HttpAsyncClient instance.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull org.apache.http.nio.client.HttpAsyncClient get​(@Nullable String targetUrl)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.nio.client.HttpAsyncClient get​(@Nullable URI targetUrl)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseable​(@Nullable String targetUrl)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseable​(@Nullable URI targetUrl)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseableWs​(@Nullable String targetUrl, @Nullable String wsAddressingToUri)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseableWs​(@Nullable URI targetUrl, @Nullable URI wsAddressingToUri)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.client.config.RequestConfig getDefaultRequestConfig​(@Nullable String targetUrl)
      Returns the default Request Configuration for the given target URL.
      @NotNull org.apache.http.client.config.RequestConfig getDefaultRequestConfig​(@Nullable URI targetUrl)
      Returns the default Request Configuration for the given target URL.
      @NotNull org.apache.http.nio.client.HttpAsyncClient getWs​(@Nullable String targetUrl, @Nullable String wsAddressingToUri)
      Returns a configured asynchronous Http Client for the given target URL.
      @NotNull org.apache.http.nio.client.HttpAsyncClient getWs​(@Nullable URI targetUrl, @Nullable URI wsAddressingToUri)
      Returns a configured asynchronous Http Client for the given target URL.

    • Method Detail

      • get

        @NotNull
@NotNull org.apache.http.nio.client.HttpAsyncClient get​(@Nullable
                                                        @Nullable String targetUrl)
        Returns a configured asynchronous Http Client for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Http Client

      • getCloseable

        @NotNull
@NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseable​(@Nullable
                                                                               @Nullable String targetUrl)
        Returns a configured asynchronous Http Client for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Http Client

      • get

        @NotNull
@NotNull org.apache.http.nio.client.HttpAsyncClient get​(@Nullable
                                                        @Nullable URI targetUrl)
        Returns a configured asynchronous Http Client for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Http Client

      • getCloseable

        @NotNull
@NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseable​(@Nullable
                                                                               @Nullable URI targetUrl)
        Returns a configured asynchronous Http Client for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Http Client

      • getWs

        @NotNull
@NotNull org.apache.http.nio.client.HttpAsyncClient getWs​(@Nullable
                                                          @Nullable String targetUrl,
                                                          @Nullable
                                                          @Nullable String wsAddressingToUri)
        Returns a configured asynchronous Http Client for the given target URL. The Http Client is dedicated for SOAP access and supports filtering specific configuration via the "WS Addressing To" URI. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        wsAddressingToUri - WS Addressing "To" header
        Returns:
        Http Client

      • getCloseableWs

        @NotNull
@NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseableWs​(@Nullable
                                                                                 @Nullable String targetUrl,
                                                                                 @Nullable
                                                                                 @Nullable String wsAddressingToUri)
        Returns a configured asynchronous Http Client for the given target URL. The Http Client is dedicated for SOAP access and supports filtering specific configuration via the "WS Addressing To" URI. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        wsAddressingToUri - WS Addressing "To" header
        Returns:
        Http Client

      • getWs

        @NotNull
@NotNull org.apache.http.nio.client.HttpAsyncClient getWs​(@Nullable
                                                          @Nullable URI targetUrl,
                                                          @Nullable
                                                          @Nullable URI wsAddressingToUri)
        Returns a configured asynchronous Http Client for the given target URL. The Http Client is dedicated for SOAP access and supports filtering specific configuration via the "WS Addressing To" URI. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        wsAddressingToUri - WS Addressing "To" header
        Returns:
        Http Client

      • getCloseableWs

        @NotNull
@NotNull org.apache.http.impl.nio.client.CloseableHttpAsyncClient getCloseableWs​(@Nullable
                                                                                 @Nullable URI targetUrl,
                                                                                 @Nullable
                                                                                 @Nullable URI wsAddressingToUri)
        Returns a configured asynchronous Http Client for the given target URL. The Http Client is dedicated for SOAP access and supports filtering specific configuration via the "WS Addressing To" URI. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        wsAddressingToUri - WS Addressing "To" header
        Returns:
        Http Client

      • getDefaultRequestConfig

        @NotNull
@NotNull org.apache.http.client.config.RequestConfig getDefaultRequestConfig​(@Nullable
                                                                             @Nullable String targetUrl)
        Returns the default Request Configuration for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Default Request Config

      • getDefaultRequestConfig

        @NotNull
@NotNull org.apache.http.client.config.RequestConfig getDefaultRequestConfig​(@Nullable
                                                                             @Nullable URI targetUrl)
        Returns the default Request Configuration for the given target URL. If a special configuration (e.g. timeout setting, proxy server, authentication) is configured it is applied in the factory.
        Parameters:
        targetUrl - Target URL to call (this url is not called, but required to check for configuration)
        Returns:
        Default Request Config