Interface ClientBuilderConfiguration

public interface ClientBuilderConfiguration
Represents the ClientBuilder configuration for configuring an ClientHttpEngine.
Author:
James R. Perkins

  • Method Details

    • connectionIdleTime

      long connectionIdleTime(TimeUnit unit)
      Get the connections time to live, if set.
      Parameters:
      unit - the unit used to convert the time
      Returns:
      the time to live or -1 if not set

    • sniHostNames

      List<String> sniHostNames()
      Returns a list of SNI host names for authentication.
      Returns:
      the SNI host names or an empty list

    • defaultProxyHostname

      String defaultProxyHostname()
      Returns the default proxy host name if configured.
      Returns:
      the default proxy host name or null

    • defaultProxyPort

      int defaultProxyPort()
      Returns the default proxy port if configured.
      Returns:
      the default proxy port or -1 if not set

    • defaultProxyScheme

      String defaultProxyScheme()
      The default proxy scheme, the default is http.
      Returns:
      the proxy scheme

    • isCookieManagementEnabled

      boolean isCookieManagementEnabled()
      Indicates whether cookie management should be used or not.
      Returns:
      true if cookie management should be used

    • sslContext

      SSLContext sslContext()
      The used for the connection, if applicable.
      Returns:
      the SSLContext or null if one was not configured

    • readTimeout

      long readTimeout(TimeUnit unit)
      Returns the read timeout converted in the time unit provided.
      Parameters:
      unit - the time unit used to convert the read timeout
      Returns:
      the read timeout or -1 if no read timeout configured

    • connectionTimeout

      long connectionTimeout(TimeUnit unit)
      Returns the connection timeout converted in the time unit provided.
      Parameters:
      unit - the time unit used to convert the connection timeout
      Returns:
      the connection timeout or -1 if no connection timeout configured

    • isFollowRedirects

      boolean isFollowRedirects()
      Indicates if redirects should be followed.
      Returns:
      true if redirects should be followed, otherwise false

    • executorService

      Optional<ExecutorService> executorService()
      Returns the ExecutorService associated with the ClientBuilder.executorService(ExecutorService).
      Returns:
      the executor service or null if one was not configured

    • scheduledExecutorService

      Optional<ScheduledExecutorService> scheduledExecutorService()
      Returns the ScheduledExecutorService associated with the ClientBuilder.scheduledExecutorService(ScheduledExecutorService).
      Returns:
      the scheduled executor service or null if one was not configured

    • configuration

      jakarta.ws.rs.core.Configuration configuration()
      Returns the Configuration for the Configurable.getConfiguration().
      Returns:
      the configuration