com.adobe.platform.operation

Class ClientConfig.Builder

java.lang.Object

com.adobe.platform.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 and socket timeout using the JSON client config file path.
ClientConfig.Builder	withConnectTimeout(Integer connectTimeout) Sets the connect timeout.
ClientConfig.Builder	withSocketTimeout(Integer socketTimeout) Sets the socket timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

fromFile

public ClientConfig.Builder fromFile(String clientConfigFilePath)

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

JSON structure:

{
   "connectTimeout": "4000",
   "socketTimeout": "20000"
 }

Parameters:

clientConfigFilePath - the file path for client config

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