Package com.auth0.client

Class HttpOptions

java.lang.Object
com.auth0.client.HttpOptions
@Deprecated public class HttpOptions extends Object
Deprecated.
use the DefaultHttpClient to configure HTTP client behavior
Used to configure additional configuration options when customizing the API client instance.

  • Constructor Details

    • HttpOptions

      public HttpOptions()
      Deprecated.

  • Method Details

    • getProxyOptions

      public ProxyOptions getProxyOptions()
      Deprecated.
      Getter for the Proxy configuration options
      Returns:
      the Proxy configuration options if set, null otherwise.

    • setProxyOptions

      public void setProxyOptions(ProxyOptions proxyOptions)
      Deprecated.
      Setter for the Proxy configuration options
      Parameters:
      proxyOptions - the Proxy configuration options

    • getConnectTimeout

      public int getConnectTimeout()
      Deprecated.
      Returns:
      the connect timeout, in seconds

    • setConnectTimeout

      public void setConnectTimeout(int connectTimeout)
      Deprecated.
      Sets the value of the connect timeout, in seconds. Defaults to ten seconds. A value of zero results in no connect timeout. Negative numbers will be treated as zero.
      Parameters:
      connectTimeout - the value of the connect timeout to use.

    • getReadTimeout

      public int getReadTimeout()
      Deprecated.
      Returns:
      the read timeout, in seconds

    • setReadTimeout

      public void setReadTimeout(int readTimeout)
      Deprecated.
      Sets the value of the read timeout, in seconds. Defaults to ten seconds. A value of zero results in no read timeout. Negative numbers will be treated as zero.
      Parameters:
      readTimeout - the value of the read timeout to use.

    • setLoggingOptions

      public void setLoggingOptions(LoggingOptions loggingOptions)
      Deprecated.
      Set the HTTP logging configuration options. If not set, no logs will be captured.
      Parameters:
      loggingOptions - the Logging configuration options

    • getLoggingOptions

      public LoggingOptions getLoggingOptions()
      Deprecated.
      Returns:
      the Logging configurration options if set, null otherwise.

    • getManagementAPIMaxRetries

      public int getManagementAPIMaxRetries()
      Deprecated.
      Returns:
      the configured number of maximum retries to attempt when a rate-limit error is encountered by the Management API client.

    • setManagementAPIMaxRetries

      public void setManagementAPIMaxRetries(int maxRetries)
      Deprecated.
      Sets the maximum number of consecutive retries for Management API requests that fail due to rate-limits being reached. By default, rate-limited requests will be retries a maximum of three times. To disable retries on rate-limit errors, set this value to zero.

      Note: Rate-limiting retries is only applicable to the Management API client.

      Parameters:
      maxRetries - the maximum number of consecutive retries to attempt upon a rate-limit error. Defaults to three. Must be a number between zero (do not retry) and ten.

    • setMaxRequestsPerHost

      public void setMaxRequestsPerHost(int maxRequestsPerHost)
      Deprecated.
      Sets the maximum number of requests for each host to execute concurrently.
      Parameters:
      maxRequestsPerHost - the maximum number of requests for each host to execute concurrently. Must be equal to or greater than one.

    • getMaxRequestsPerHost

      public int getMaxRequestsPerHost()
      Deprecated.
      Returns:
      the maximum number of requests for each host to execute concurrently.

    • setMaxRequests

      public void setMaxRequests(int maxRequests)
      Deprecated.
      Sets the maximum number of requests to execute concurrently.
      Parameters:
      maxRequests - the number of requests to execute concurrently. Must be equal to or greater than one.

    • getMaxRequests

      public int getMaxRequests()
      Deprecated.
      Returns:
      the number of requests to execute concurrently