Class HttpClientUtils

java.lang.Object
com.inductiveautomation.ignition.gateway.http.HttpClientUtils

public class HttpClientUtils extends Object
  • Method Summary

    Modifier and Type
    Method
    Description
    static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext
    createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout)
     
    static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext
    createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout, @NonNull org.apache.hc.client5.http.auth.AuthCache authCache, @NonNull org.apache.hc.client5.http.auth.CredentialsProvider credentialsProvider)
    Builds a per-request HttpClientContext for use with the shared gateway HTTP client.
    static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext
    createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout, @NonNull org.apache.hc.client5.http.auth.AuthCache authCache, @NonNull org.apache.hc.client5.http.auth.CredentialsProvider credentialsProvider, @NonNull org.apache.hc.client5.http.cookie.CookieStore cookieStore)
    Builds a per-request HttpClientContext that shares a caller-supplied cookie store.
    static @NonNull String
    getSysPropName(@NonNull String suffix)
     
    static @NonNull org.apache.hc.core5.util.Timeout
    toTimeout(int millis)
    Converts a millisecond timeout to a Timeout, mapping non-positive values to Timeout.DISABLED (i.e.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • toTimeout

      public static @NonNull org.apache.hc.core5.util.Timeout toTimeout(int millis)
      Converts a millisecond timeout to a Timeout, mapping non-positive values to Timeout.DISABLED (i.e. no timeout).

      HttpClient 4.x encoded "infinite" as a negative or zero int, whereas Timeout.ofMilliseconds(long) rejects negatives outright. Clamping here keeps a negative configuration value behaving as it always has instead of throwing.

    • getSysPropName

      public static @NonNull String getSysPropName(@NonNull String suffix)
    • createHttpClientContext

      public static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout, @NonNull org.apache.hc.client5.http.auth.AuthCache authCache, @NonNull org.apache.hc.client5.http.auth.CredentialsProvider credentialsProvider)
      Builds a per-request HttpClientContext for use with the shared gateway HTTP client.
      Parameters:
      connectTimeout - the connect and connection-request timeouts, in milliseconds
      socketTimeout - the socket read timeout, in milliseconds
    • createHttpClientContext

      public static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout, @NonNull org.apache.hc.client5.http.auth.AuthCache authCache, @NonNull org.apache.hc.client5.http.auth.CredentialsProvider credentialsProvider, @NonNull org.apache.hc.client5.http.cookie.CookieStore cookieStore)
      Builds a per-request HttpClientContext that shares a caller-supplied cookie store.

      Use this when several exchanges need their own context -- the context is not thread-safe -- but must still see each other's cookies. BasicCookieStore is thread-safe, so one instance can back every context a caller creates.

      Parameters:
      connectTimeout - the connect and connection-request timeouts, in milliseconds
      socketTimeout - the socket read timeout, in milliseconds
      cookieStore - the cookie store to share across the contexts this caller creates
    • createHttpClientContext

      public static @NonNull org.apache.hc.client5.http.protocol.HttpClientContext createHttpClientContext(boolean areCookiesEnabled, int connectTimeout, int socketTimeout)