Package org.attribyte.api.http

Class ClientOptions.Builder

java.lang.Object
org.attribyte.api.http.ClientOptions.Builder
Enclosing class:
ClientOptions
public static class ClientOptions.Builder extends Object
Builds immutable instances of client options.

  • Constructor Details

    • Builder

      public Builder()
      Create an empty builder.

    • Builder

      public Builder(ClientOptions options)
      Create a builder with defaults from options.
      Parameters:
      options - The options.

  • Method Details

    • getUserAgent

      public String getUserAgent()
      Gets the user agent.
      Returns:
      The user agent.

    • setUserAgent

      public ClientOptions.Builder setUserAgent(String userAgent)
      Sets the user agent.
      Parameters:
      userAgent - The user agent.
      Returns:
      A self-reference.

    • getConnectionTimeoutMillis

      public int getConnectionTimeoutMillis()
      Gets the connection timeout in milliseconds.
      Returns:
      The timeout in milliseconds.

    • setConnectionTimeoutMillis

      public ClientOptions.Builder setConnectionTimeoutMillis(int connectionTimeoutMillis)
      Sets the connection timeout in milliseconds.
      Parameters:
      connectionTimeoutMillis - The connection timeout in milliseconds.
      Returns:
      A self-reference.

    • getRequestTimeoutMillis

      public int getRequestTimeoutMillis()
      Gets the request timeout in milliseconds.
      Returns:
      The request timeout in milliseconds.

    • setRequestTimeoutMillis

      public ClientOptions.Builder setRequestTimeoutMillis(int requestTimeoutMillis)
      Sets the request timeout in milliseconds.
      Parameters:
      requestTimeoutMillis - The request timeout in milliseconds.
      Returns:
      A self-reference.

    • getSocketTimeoutMillis

      public int getSocketTimeoutMillis()
      Gets the socket timeout in milliseconds.
      Returns:
      The socket timeout in milliseconds.

    • setSocketTimeoutMillis

      public ClientOptions.Builder setSocketTimeoutMillis(int socketTimeoutMillis)
      Sets the socket timeout in milliseconds.
      Parameters:
      socketTimeoutMillis - The socket timeout in milliseconds.
      Returns:
      A self-reference.

    • getProxyHost

      public String getProxyHost()
      Gets the proxy host.
      Returns:
      The proxy host.

    • setProxyHost

      public ClientOptions.Builder setProxyHost(String proxyHost)
      Sets the proxy host.
      Parameters:
      proxyHost - The proxy host.
      Returns:
      A self-reference.

    • getProxyPort

      public int getProxyPort()
      Gets the proxy port.
      Returns:
      The proxy port.

    • setProxyPort

      public ClientOptions.Builder setProxyPort(int proxyPort)
      Sets the proxy port.
      Parameters:
      proxyPort - The proxy port.
      Returns:
      A self-reference.

    • getFollowRedirects

      public boolean getFollowRedirects()
      Gets the follow redirects setting.
      Returns:
      Are redirects followed?

    • setFollowRedirects

      public ClientOptions.Builder setFollowRedirects(boolean followRedirects)
      Sets if redirects are followed.
      Parameters:
      followRedirects - Are redirects followed?
      Returns:
      A self-reference.

    • getMaxConnectionsPerDestination

      public int getMaxConnectionsPerDestination()
      Gets the maximum number of connections per destination.
      Returns:
      The number of connections.

    • setMaxConnectionsPerDestination

      public ClientOptions.Builder setMaxConnectionsPerDestination(int maxConnectionsPerDestination)
      Sets the maximum number of connections per destination.
      Parameters:
      maxConnectionsPerDestination - The number of connections.
      Returns:
      A self-reference.

    • getMaxConnectionsTotal

      public int getMaxConnectionsTotal()
      Gets the maximum total number of connections.
      Returns:
      The number of connections.

    • setMaxConnectionsTotal

      public ClientOptions.Builder setMaxConnectionsTotal(int maxConnectionsTotal)
      Sets the maximum total number of connections.
      Parameters:
      maxConnectionsTotal - The number of connections.
      Returns:
      A self-reference.

    • getRequestBufferSize

      public int getRequestBufferSize()
      Gets the request buffer size.
      Returns:
      The request buffer size.

    • setRequestBufferSize

      public ClientOptions.Builder setRequestBufferSize(int requestBufferSize)
      Sets the request buffer size.
      Parameters:
      requestBufferSize - The request buffer size.
      Returns:
      A self-reference.

    • getResponseBufferSize

      public int getResponseBufferSize()
      Gets the response buffer size.
      Returns:
      The response buffer size.

    • setResponseBufferSize

      public ClientOptions.Builder setResponseBufferSize(int responseBufferSize)
      Sets the response buffer size.
      Parameters:
      responseBufferSize - The response buffer size.
      Returns:
      A self-reference.

    • getProps

      public Properties getProps()
      Gets the extra properties.
      Returns:
      The properties.

    • setProps

      public ClientOptions.Builder setProps(Properties props)
      Sets the extra properties.
      Parameters:
      props - The properties.
      Returns:
      A self-reference.

    • getTrustAllCertificates

      public boolean getTrustAllCertificates()
      Are all (even invalid) certificates trusted?
      Returns:
      Are all certificates trusted.

    • setTrustAllCertificates

      public ClientOptions.Builder setTrustAllCertificates(boolean trustAllCertificates)
      Sets if all (even invalid) certificates are trusted.
      Parameters:
      trustAllCertificates - Are all certificates trusted?
      Returns:
      A self-reference.

    • getCookieStore

      public CookieStore getCookieStore()
      Gets the cookie store.
      Returns:
      The cookie store.

    • setCookieStore

      public ClientOptions.Builder setCookieStore(CookieStore cookieStore)
      Sets the cookie store.
      Parameters:
      cookieStore - The cookie store.
      Returns:
      A self-reference.

    • create

      public ClientOptions create()
      Creates the options.
      Returns:
      The options.