com.adobe.pdfservices.operation

Class ClientConfig.Builder

java.lang.Object

com.adobe.pdfservices.operation.ClientConfig.Builder

Enclosing class:

ClientConfig

public static class ClientConfig.Builder
extends Object

Builds a ClientConfig instance.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a Builder instance.

Method Summary

Modifier and Type	Method and Description
ClientConfig	build() Returns a new ClientConfig instance built from the current state of this builder.
ClientConfig.Builder	fromFile(String clientConfigFilePath) Sets the connect timeout, socket timeout and proxy config using the JSON client config file path.
ClientConfig.Builder	withConnectTimeout(Integer connectTimeout) Sets the connect timeout.
ClientConfig.Builder	withProxyHost(String proxyHost) Sets the Host name of proxy server (IP or DNS name)
ClientConfig.Builder	withProxyPort(Integer proxyPort) Sets the Port Number of Proxy server.
ClientConfig.Builder	withProxyScheme(ClientConfig.ProxyScheme proxyScheme) Sets the scheme of Proxy Server (http or https).
ClientConfig.Builder	withSocketTimeout(Integer socketTimeout) Sets the socket timeout.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructs a Builder instance.

Method Detail

withConnectTimeout

public ClientConfig.Builder withConnectTimeout(Integer connectTimeout)

Sets the connect timeout. It should be greater than zero.

Parameters:

connectTimeout - determines the timeout in milliseconds until a connection is established in the API calls. Default value is 10000 milliseconds

Returns:

this Builder instance to add any additional parameters

withSocketTimeout

public ClientConfig.Builder withSocketTimeout(Integer socketTimeout)

Sets the socket timeout. It should be greater than zero.

Parameters:

socketTimeout - Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). Default value is 2000 milliseconds

Returns:

this Builder instance to add any additional parameters

withProxyHost

public ClientConfig.Builder withProxyHost(String proxyHost)

Sets the Host name of proxy server (IP or DNS name)

Parameters:

proxyHost - Host Name of Proxy Server

Returns:

this Builder instance to add any additional parameters

withProxyPort

public ClientConfig.Builder withProxyPort(Integer proxyPort)

Sets the Port Number of Proxy server. It must be greater than 0. Ignored if proxy host is not set.

Parameters:

proxyPort - Port Number of Proxy server. Proxy Scheme's default port is set if not provided.

Returns:

this Builder instance to add any additional parameters

withProxyScheme

public ClientConfig.Builder withProxyScheme(ClientConfig.ProxyScheme proxyScheme)

Sets the scheme of Proxy Server (http or https). Ignored if proxy host is not set.

Parameters:

proxyScheme - Scheme of Proxy Server (http or https). Default value is http.

Returns:

this Builder instance to add any additional parameters

fromFile

public ClientConfig.Builder fromFile(String clientConfigFilePath)

Sets the connect timeout, socket timeout and proxy config using the JSON client config file path. All the keys in the JSON structure are optional.

JSON structure:

{
   "connectTimeout": "4000",
   "socketTimeout": "20000",
   "proxyHost": "127.0.0.1",
   "proxyPort": "8080",
   "proxyScheme": "https"
 }

Returns:

this Builder instance to add any additional parameters

build

public ClientConfig build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns:

a new ClientConfig instance