ClientConfiguration (qtest-sdk-java 1.4.10 API)

java.lang.Object
- org.qas.api.internal.PropertyContainer
- - org.qas.api.ClientConfiguration

All Implemented Interfaces:: java.lang.Cloneable

public class ClientConfiguration
extends PropertyContainer
implements java.lang.Cloneable

ClientConfiguration

Since:: 1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_CONNECTIONS` the default max connection pool size.
`static int`	`DEFAULT_MAX_RETRIES` The default maximum number of retries for error responses.
`static int`	`DEFAULT_SOCKET_TIMEOUT` the default timeout for a connection socket.
`static java.lang.String`	`DEFAULT_USER_AGENT` The default HTTP user agent headers.

Fields inherited from class org.qas.api.internal.PropertyContainer
NL, properties, RESERVED_NAME

Constructor Summary

Constructors
Constructor and Description
`ClientConfiguration()` Create the client configuration.
`ClientConfiguration(ClientConfiguration other)` Creates the client configuration from the given another `client configuration`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientConfiguration`	`clone()`
`int`	`getConnectionTimeout()`
`int`	`getMaxConnections()`
`int`	`getMaxErrorRetry()`
`Protocol`	`getProtocol()`
`java.lang.String`	`getProxyDomain()`
`java.lang.String`	`getProxyHost()`
`java.lang.String`	`getProxyPassword()`
`int`	`getProxyPort()`
`java.lang.String`	`getProxyUsername()`
`java.lang.String`	`getProxyWorkstation()`
`int[]`	`getSocketBufferSizeHints()`
`int`	`getSocketTimeout()`
`java.lang.String`	`getUserAgent()`
`void`	`setConnectionTimeout(int connectionTimeout)` Sets the amount of to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
`void`	`setMaxConnections(int maxConnections)` Sets the maximum number of allowed open HTTP connections.
`void`	`setMaxErrorRetry(int maxErrorRetry)` Sets the maximum number of retry attempts for failed retryable requests.
`void`	`setProtocol(Protocol protocol)` Sets the protocol (i.e.
`void`	`setProxyDomain(java.lang.String proxyDomain)` Sets the optional Windows domain name for configuration an NTLM proxy.
`void`	`setProxyHost(java.lang.String proxyHost)` Sets the optional proxy host the client will connect through.
`void`	`setProxyPassword(java.lang.String password)` Sets the optional proxy password if connecting through a proxy.
`void`	`setProxyPort(int proxyPort)` Sets the optional proxy port the client will connect through.
`void`	`setProxyUsername(java.lang.String username)` Sets the proxy username to use if connecting through a proxy.
`void`	`setProxyWorkstation(java.lang.String proxyWorkstation)` Sets the optional Windows workstation name for configuring NTLM proxy support.
`void`	`setSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint)` Sets the optional size hints (in bytes) for the low level TCP send and receive buffers.
`void`	`setSocketTimeout(int socketTimeout)` Sets the amount of time wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed.
`void`	`setUserAgent(java.lang.String userAgent)` Sets the HTTP user agent header to send with all request.
`java.lang.String`	`toString()`
`ClientConfiguration`	`withConnectionTimeout(int connectionTimeout)` Sets the amount of to wait (in milliseconds) when initially establishing a connection before giving up and timing out and returns `ClientConfiguration` object.
`ClientConfiguration`	`withMaxConnections(int maxConnections)` Sets the maximum number of allowed open HTTP connections and return the updated `ClientConfiguration` object.
`ClientConfiguration`	`withMaxErrorRetry(int maxErrorRetry)` Sets the maximum number of retry attempts for failed retryable requests and returns the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProperty(java.lang.String name, java.lang.Object value)` Sets the property name and value.
`ClientConfiguration`	`withProtocol(Protocol protocol)` Sets the protocol (i.e.
`ClientConfiguration`	`withProxyDomain(java.lang.String proxyDomain)` Sets the optional Windows domain nam for configuration an NTLM proxy and return the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProxyHost(java.lang.String proxyHost)` Sets the optioanl proxy host the client will connect through and returns the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProxyPassword(java.lang.String password)` Sets the optional proxy password if connecting through a proxy and return the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProxyPort(int proxyPort)` Sets the optional proxy port the client will connect through and return the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProxyUsername(java.lang.String username)` Sets the optional proxy username if connecting through a proxy and return the updated `ClientConfiguration` object.
`ClientConfiguration`	`withProxyWorkstation(java.lang.String proxyWorkstation)` Sets the optional Windows workstation name for configuring NTLM proxy support and returns the updated `ClientConfiguration` object.
`ClientConfiguration`	`withSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint)` Sets the optional size hints (in bytes) for the low level TCP send and receive buffers.
`ClientConfiguration`	`withSocketTimeout(int socketTimeout)` Sets the amount of time wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed and returns the updated `ClientConfiguration` object.
`ClientConfiguration`	`withUserAgent(java.lang.String userAgent)` Sets the HTTP user agent header to send with all request and return the updated `ClientConfiguration` object.

Methods inherited from class org.qas.api.internal.PropertyContainer
appendPropertiesTo, appendPropertiesTo, asDate, asDate, asInteger, asInteger, asLong, asLong, asString, asString, elementName, getProperties, getProperty, getPropertyMap, hasProperties, hasProperty, isVisible, jsonElementName, removeProperty, setPropertiesFrom, setProperty, toJson

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SOCKET_TIMEOUT
```
public static final int DEFAULT_SOCKET_TIMEOUT
```
    the default timeout for a connection socket.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_CONNECTIONS
```
public static final int DEFAULT_MAX_CONNECTIONS
```
    the default max connection pool size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_USER_AGENT
```
public static final java.lang.String DEFAULT_USER_AGENT
```
    The default HTTP user agent headers.
  - DEFAULT_MAX_RETRIES
```
public static final int DEFAULT_MAX_RETRIES
```
    The default maximum number of retries for error responses.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientConfiguration
```
public ClientConfiguration()
```
    Create the client configuration.
  - ClientConfiguration
```
public ClientConfiguration(ClientConfiguration other)
```
    Creates the client configuration from the given another client configuration
    
    Parameters:
    
    other - the given client configuration to copy data.
- Method Detail
  - getProtocol
```
public Protocol getProtocol()
```
    Returns:
    
    the setting protocol (HTTP or HTTPS) to use when connecting to the target service.
  - setProtocol
```
public void setProtocol(Protocol protocol)
```
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting to the target service.
    The default configuration is to use HTTPS for all requests for increased security.
    
    Parameters:
    
    protocol - the protocol to use when connecting to the target service.
  - withProtocol
```
public ClientConfiguration withProtocol(Protocol protocol)
```
    Sets the protocol (i.e. HTTP or HTTPS) to use when connecting to the target service, and returns the update ClientConfiguration object so that additional calls may be chained together.
    
    Parameters:
    
    protocol - the protocol to use when connecting to the target service.
    
    Returns:
    
    the update ClientConfiguration object with the new protocol setting.
  - getMaxConnections
```
public int getMaxConnections()
```
    Returns:
    
    the maximum number of allowed open HTTP connections.
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    Sets the maximum number of allowed open HTTP connections.
    
    Parameters:
    
    maxConnections - the maximum number of allowed open HTTP connections.
  - withMaxConnections
```
public ClientConfiguration withMaxConnections(int maxConnections)
```
    Sets the maximum number of allowed open HTTP connections and return the updated ClientConfiguration object.
    
    Parameters:
    
    maxConnections - the maximum number of allowed open HTTP connection.
    
    Returns:
    
    The updated ClientConfiguration object with the new max HTTP connections setting.
  - getUserAgent
```
public java.lang.String getUserAgent()
```
    Returns:
    
    the HTTP user agent header to send with all request.
  - setUserAgent
```
public void setUserAgent(java.lang.String userAgent)
```
    Sets the HTTP user agent header to send with all request.
    
    Parameters:
    
    userAgent - The user agent string to use when sending request.
  - withUserAgent
```
public ClientConfiguration withUserAgent(java.lang.String userAgent)
```
    Sets the HTTP user agent header to send with all request and return the updated ClientConfiguration object.
    
    Parameters:
    
    userAgent - the given user agent string to use when sending request.
    
    Returns:
    
    the updated ClientConfiguration object with the new user agent setting.
  - getProxyHost
```
public java.lang.String getProxyHost()
```
    Returns:
    
    the proxy host the client will connect through.
  - setProxyHost
```
public void setProxyHost(java.lang.String proxyHost)
```
    Sets the optional proxy host the client will connect through.
    
    Parameters:
    
    proxyHost - the proxy host the client will connect through.
  - withProxyHost
```
public ClientConfiguration withProxyHost(java.lang.String proxyHost)
```
    Sets the optioanl proxy host the client will connect through and returns the updated ClientConfiguration object.
    
    Parameters:
    
    proxyHost - the proxy host the client will connect through.
    
    Returns:
    
    the updated ClientConfiguration object with the new proxy host setting.
  - getProxyPort
```
public int getProxyPort()
```
    Returns:
    
    the proxy port the client will connect through.
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Sets the optional proxy port the client will connect through.
    
    Parameters:
    
    proxyPort - the proxy port the client will connect through.
  - withProxyPort
```
public ClientConfiguration withProxyPort(int proxyPort)
```
    Sets the optional proxy port the client will connect through and return the updated ClientConfiguration object.
    
    Parameters:
    
    proxyPort - the proxy port the client will connect through.
    
    Returns:
    
    the updated ClientConfiguration object with the new proxy port setting.
  - getProxyUsername
```
public java.lang.String getProxyUsername()
```
    Returns:
    
    the proxy username the configured client will use if connecting through a proxy.
  - setProxyUsername
```
public void setProxyUsername(java.lang.String username)
```
    Sets the proxy username to use if connecting through a proxy.
    
    Parameters:
    
    username - the proxy username to use if connecting through a proxy.
  - withProxyUsername
```
public ClientConfiguration withProxyUsername(java.lang.String username)
```
    Sets the optional proxy username if connecting through a proxy and return the updated ClientConfiguration object.
    
    Parameters:
    
    username - the proxy username to use if connecting though a proxy.
    
    Returns:
    
    the updated ClientConfiguration object with a new proxy username setting.
  - getProxyPassword
```
public java.lang.String getProxyPassword()
```
    Returns:
    
    the proxy password the configure client will use if connecting through a proxy.
  - setProxyPassword
```
public void setProxyPassword(java.lang.String password)
```
    Sets the optional proxy password if connecting through a proxy.
    
    Parameters:
    
    password - the proxy password to use if connecting through a proxy.
  - withProxyPassword
```
public ClientConfiguration withProxyPassword(java.lang.String password)
```
    Sets the optional proxy password if connecting through a proxy and return the updated ClientConfiguration object.
    
    Parameters:
    
    password - the proxy password to use if connecting through a proxy.
    
    Returns:
    
    the updated ClientConfiguration object with a new proxy password setting.
  - getProxyDomain
```
public java.lang.String getProxyDomain()
```
    Returns:
    
    the proxy domain for configure an NTLM proxy.
  - setProxyDomain
```
public void setProxyDomain(java.lang.String proxyDomain)
```
    Sets the optional Windows domain name for configuration an NTLM proxy.
    
    Parameters:
    
    proxyDomain - the optional Windows domain name for configuring an NTLM proxy.
  - withProxyDomain
```
public ClientConfiguration withProxyDomain(java.lang.String proxyDomain)
```
    Sets the optional Windows domain nam for configuration an NTLM proxy and return the updated ClientConfiguration object.
    
    Parameters:
    
    proxyDomain - the optional Windows domain name for configuring an NTLM proxy.
    
    Returns:
    
    the updated ClientConfiguration object with a new proxy domain setting.
  - getProxyWorkstation
```
public java.lang.String getProxyWorkstation()
```
    Returns:
    
    the optional Windows workstation name for configuring NTLM proxy support.
  - setProxyWorkstation
```
public void setProxyWorkstation(java.lang.String proxyWorkstation)
```
    Sets the optional Windows workstation name for configuring NTLM proxy support.
    
    Parameters:
    
    proxyWorkstation - the optional Windows workstation name for configuring NTLM proxy support.
  - withProxyWorkstation
```
public ClientConfiguration withProxyWorkstation(java.lang.String proxyWorkstation)
```
    Sets the optional Windows workstation name for configuring NTLM proxy support and returns the updated ClientConfiguration object.
    
    Parameters:
    
    proxyWorkstation - the optional Windows workstation name for configuring NTLM proxy support.
    
    Returns:
    
    the updated ClientConfiguration object with a new proxy workstation setting.
  - getMaxErrorRetry
```
public int getMaxErrorRetry()
```
    Returns:
    
    the maximum number of retry attempts for failed retryable requests.
  - setMaxErrorRetry
```
public void setMaxErrorRetry(int maxErrorRetry)
```
    Sets the maximum number of retry attempts for failed retryable requests.
    
    Parameters:
    
    maxErrorRetry - the maximum number of retry attempts for failed retryable requests.
  - withMaxErrorRetry
```
public ClientConfiguration withMaxErrorRetry(int maxErrorRetry)
```
    Sets the maximum number of retry attempts for failed retryable requests and returns the updated ClientConfiguration object.
    
    Parameters:
    
    maxErrorRetry - the maximum number of retry attempts for failed retryable requests.
    
    Returns:
    
    the updated ClientConfiguration object with a new maximum number of retry attempts for failed retryable requests setting.
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Returns:
    
    the amount of time wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed.
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
```
    Sets the amount of time wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed.
    
    Parameters:
    
    socketTimeout - The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed.
  - withSocketTimeout
```
public ClientConfiguration withSocketTimeout(int socketTimeout)
```
    Sets the amount of time wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed and returns the updated ClientConfiguration object.
    
    Parameters:
    
    socketTimeout - The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection timeout and is closed.
    
    Returns:
    
    the updated ClientConfiguration object with a new socket timeout setting.
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns:
    
    the amount of to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
  - setConnectionTimeout
```
public void setConnectionTimeout(int connectionTimeout)
```
    Sets the amount of to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
    
    Parameters:
    
    connectionTimeout - The amount of time wait (in milliseconds) when initially establishing a connection before giving up and timing out.
  - withConnectionTimeout
```
public ClientConfiguration withConnectionTimeout(int connectionTimeout)
```
    Sets the amount of to wait (in milliseconds) when initially establishing a connection before giving up and timing out and returns ClientConfiguration object.
    
    Parameters:
    
    connectionTimeout - The amount of time wait (in milliseconds) when initially establishing a connection before giving up and timing out.
    
    Returns:
    
    the updated ClientConfiguration object with a new connection timeout setting.
  - getSocketBufferSizeHints
```
public int[] getSocketBufferSizeHints()
```
    Returns:
    
    the optional size hints (in bytes) for the low level TCP send and receive buffers. This is an advanced option for advanced users who want to tune low level TCP parameters to try squeeze out more performance.
  - setSocketBufferSizeHints
```
public void setSocketBufferSizeHints(int socketSendBufferSizeHint,
                                     int socketReceiveBufferSizeHint)
```
    Sets the optional size hints (in bytes) for the low level TCP send and receive buffers. This is an advanced option for advanced users who want to tune low level TCP parameters to try and squeeze out more performance.
    
    Parameters:
    
    socketSendBufferSizeHint - the size hint (in bytes) for the low level TCP send buffer.
    
    socketReceiveBufferSizeHint - the size hint (in bytes) for the low level TCP receive buffer.
  - withSocketBufferSizeHints
```
public ClientConfiguration withSocketBufferSizeHints(int socketSendBufferSizeHint,
                                                     int socketReceiveBufferSizeHint)
```
    Sets the optional size hints (in bytes) for the low level TCP send and receive buffers. This is an advanced option for advanced users who want to tune low level TCP parameters to try and squeeze out more performance and returns the updated ClientConfiguration object.
    
    Parameters:
    
    socketSendBufferSizeHint - the size hint (in bytes) for the low level TCP send buffer.
    
    socketReceiveBufferSizeHint - the size hint (in bytes) for the low level TCP receive buffer.
    
    Returns:
    
    the updated ClientConfiguration object with a new socket buffer size hints setting.
  - withProperty
```
public ClientConfiguration withProperty(java.lang.String name,
                                        java.lang.Object value)
```
    Sets the property name and value.
    
    Parameters:
    
    name - the property name.
    
    value - the property value.
    
    Returns:
    
    the current ClientConfiguration.
  - clone
```
public ClientConfiguration clone()
```
    Overrides:
    
    clone in class PropertyContainer
    
    Returns:
    
    a shallow copy of this ClientConfiguration instance.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class PropertyContainer

Class ClientConfiguration

Field Summary

Fields inherited from class org.qas.api.internal.PropertyContainer

Constructor Summary

Method Summary

Methods inherited from class org.qas.api.internal.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SOCKET_TIMEOUT

DEFAULT_MAX_CONNECTIONS

DEFAULT_USER_AGENT

DEFAULT_MAX_RETRIES

Constructor Detail

ClientConfiguration

ClientConfiguration

Method Detail

getProtocol

setProtocol

withProtocol

getMaxConnections

setMaxConnections

withMaxConnections

getUserAgent

setUserAgent

withUserAgent

getProxyHost

setProxyHost

withProxyHost

getProxyPort

setProxyPort

withProxyPort

getProxyUsername

setProxyUsername

withProxyUsername

getProxyPassword

setProxyPassword

withProxyPassword

getProxyDomain

setProxyDomain

withProxyDomain

getProxyWorkstation

setProxyWorkstation

withProxyWorkstation

getMaxErrorRetry

setMaxErrorRetry

withMaxErrorRetry

getSocketTimeout

setSocketTimeout

withSocketTimeout

getConnectionTimeout

setConnectionTimeout

withConnectionTimeout

getSocketBufferSizeHints

setSocketBufferSizeHints

withSocketBufferSizeHints

withProperty

clone

toString