ClientConfig.ClientConfigBuilder (target-java-sdk 2.5.0 API)

java.lang.Object
- com.adobe.target.edge.client.ClientConfig.ClientConfigBuilder

Enclosing class:: ClientConfig

public static final class ClientConfig.ClientConfigBuilder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientConfig`	`build()`
`ClientConfig.ClientConfigBuilder`	`client(java.lang.String client)` Client Code
`ClientConfig.ClientConfigBuilder`	`connectionTtlMs(int connectionTtlMs)` Total time to live (TTL) defines maximum life span of persistent connections regardless of their expiration setting.
`ClientConfig.ClientConfigBuilder`	`connectTimeout(int connectTimeout)` Connect Timeout Default value is 10000
`ClientConfig.ClientConfigBuilder`	`defaultDecisioningMethod(DecisioningMethod decisioningMethod)` Default Decisioning Method Default value is server-side
`ClientConfig.ClientConfigBuilder`	`defaultPropertyToken(java.lang.String defaultPropertyToken)` Default Property Token
`ClientConfig.ClientConfigBuilder`	`enableRetries(boolean enableRetries)` Enable retries Default value is true
`ClientConfig.ClientConfigBuilder`	`evictIdleConnectionsAfterSecs(int evictIdleConnectionsAfterSecs)` The time in seconds to evict idle connections from the connection pool.
`ClientConfig.ClientConfigBuilder`	`exceptionHandler(TargetExceptionHandler handler)` Exception Handler
`ClientConfig.ClientConfigBuilder`	`httpClient(HttpClient httpClient)` HTTP Client
`ClientConfig.ClientConfigBuilder`	`idleConnectionValidationMs(int idleConnectionValidationMs)` Idle connection validation interval defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer.
`ClientConfig.ClientConfigBuilder`	`logRequests(boolean logRequests)` Log requests Default value is false
`ClientConfig.ClientConfigBuilder`	`logRequestStatus(boolean logRequestStatus)` Log request status Default value is false
`ClientConfig.ClientConfigBuilder`	`maxConnectionsPerHost(int maxConnectionsPerHost)` Max Connections Per Host Default value is 100
`ClientConfig.ClientConfigBuilder`	`maxConnectionsTotal(int maxConnectionsTotal)` Max Connections Total Default value is 200
`ClientConfig.ClientConfigBuilder`	`onDeviceAllMatchingRulesMboxes(java.util.List<java.lang.String> mboxes)` On Device All Matching Rules Mboxes
`ClientConfig.ClientConfigBuilder`	`onDeviceArtifactPayload(byte[] payload)` On Device Artifact Payload
`ClientConfig.ClientConfigBuilder`	`onDeviceConfigHostname(java.lang.String hostname)` On Device Config Hostname Default value is assets.adobetarget.com
`ClientConfig.ClientConfigBuilder`	`onDeviceDecisioningHandler(OnDeviceDecisioningHandler handler)` On Device Decisioning Handler
`ClientConfig.ClientConfigBuilder`	`onDeviceDecisioningPollingIntSecs(int pollingInterval)` On Device Decisioning Polling Interval in seconds Default value is 300
`ClientConfig.ClientConfigBuilder`	`onDeviceEnvironment(java.lang.String environment)` On Device Environment Default value is production
`ClientConfig.ClientConfigBuilder`	`organizationId(java.lang.String organizationId)` Organization ID
`ClientConfig.ClientConfigBuilder`	`proxyConfig(ClientProxyConfig proxyConfig)` Proxy Configuration
`ClientConfig.ClientConfigBuilder`	`requestInterceptor(HttpRequestInterceptor requestInterceptor)` Request Interceptor
`ClientConfig.ClientConfigBuilder`	`secure(boolean secure)` Secure (HTTPS) or not Default value is true
`ClientConfig.ClientConfigBuilder`	`serverDomain(java.lang.String serverDomain)` Server Domain
`ClientConfig.ClientConfigBuilder`	`socketTimeout(int socketTimeout)` Socket Timeout Default value is 10000
`ClientConfig.ClientConfigBuilder`	`telemetryEnabled(boolean telemetryEnabled)` Telemetry Enabled Default value is true

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

- Method Detail
  - client
```
public ClientConfig.ClientConfigBuilder client(java.lang.String client)
```
    Client Code
    
    Parameters:
    
    client -
    
    Returns:
    
    ClientConfigBuilder
  - organizationId
```
public ClientConfig.ClientConfigBuilder organizationId(java.lang.String organizationId)
```
    Organization ID
    
    Parameters:
    
    organizationId -
    
    Returns:
    
    ClientConfigBuilder
  - serverDomain
```
public ClientConfig.ClientConfigBuilder serverDomain(java.lang.String serverDomain)
```
    Server Domain
    
    Parameters:
    
    serverDomain -
    
    Returns:
    
    ClientConfigBuilder
  - defaultPropertyToken
```
public ClientConfig.ClientConfigBuilder defaultPropertyToken(java.lang.String defaultPropertyToken)
```
    Default Property Token
    
    Parameters:
    
    defaultPropertyToken -
    
    Returns:
    
    ClientConfigBuilder
  - secure
```
public ClientConfig.ClientConfigBuilder secure(boolean secure)
```
    Secure (HTTPS) or not Default value is true
    
    Parameters:
    
    secure -
    
    Returns:
    
    ClientConfigBuilder
  - socketTimeout
```
public ClientConfig.ClientConfigBuilder socketTimeout(int socketTimeout)
```
    Socket Timeout Default value is 10000
    
    Parameters:
    
    socketTimeout -
    
    Returns:
    
    ClientConfigBuilder
  - connectTimeout
```
public ClientConfig.ClientConfigBuilder connectTimeout(int connectTimeout)
```
    Connect Timeout Default value is 10000
    
    Parameters:
    
    connectTimeout -
    
    Returns:
    
    ClientConfigBuilder
  - maxConnectionsPerHost
```
public ClientConfig.ClientConfigBuilder maxConnectionsPerHost(int maxConnectionsPerHost)
```
    Max Connections Per Host Default value is 100
    
    Parameters:
    
    maxConnectionsPerHost -
    
    Returns:
    
    ClientConfigBuilder
  - maxConnectionsTotal
```
public ClientConfig.ClientConfigBuilder maxConnectionsTotal(int maxConnectionsTotal)
```
    Max Connections Total Default value is 200
    
    Parameters:
    
    maxConnectionsTotal -
    
    Returns:
    
    ClientConfigBuilder
  - connectionTtlMs
```
public ClientConfig.ClientConfigBuilder connectionTtlMs(int connectionTtlMs)
```
    Total time to live (TTL) defines maximum life span of persistent connections regardless of their expiration setting. No persistent connection will be re-used past its TTL value. Default value is -1 which means that connections will be kept alive indefinitely.
    
    Parameters:
    
    connectionTtlMs -
    
    Returns:
    
    ClientConfigBuilder
  - idleConnectionValidationMs
```
public ClientConfig.ClientConfigBuilder idleConnectionValidationMs(int idleConnectionValidationMs)
```
    Idle connection validation interval defines period of inactivity in milliseconds after which persistent connections must be re-validated prior to being leased to the consumer. Non-positive value effectively disables idle connection validation. Note: Only available for the Apache sync client Default value is 1000
    
    Parameters:
    
    idleConnectionValidationMs -
    
    Returns:
    
    ClientConfigBuilder
  - evictIdleConnectionsAfterSecs
```
public ClientConfig.ClientConfigBuilder evictIdleConnectionsAfterSecs(int evictIdleConnectionsAfterSecs)
```
    The time in seconds to evict idle connections from the connection pool. Default value is 20
    
    Parameters:
    
    evictIdleConnectionsAfterSecs -
    
    Returns:
    
    ClientConfigBuilder
  - enableRetries
```
public ClientConfig.ClientConfigBuilder enableRetries(boolean enableRetries)
```
    Enable retries Default value is true
    
    Parameters:
    
    enableRetries -
    
    Returns:
    
    ClientConfigBuilder
  - logRequests
```
public ClientConfig.ClientConfigBuilder logRequests(boolean logRequests)
```
    Log requests Default value is false
    
    Parameters:
    
    logRequests -
    
    Returns:
    
    ClientConfigBuilder
  - telemetryEnabled
```
public ClientConfig.ClientConfigBuilder telemetryEnabled(boolean telemetryEnabled)
```
    Telemetry Enabled Default value is true
    
    Parameters:
    
    telemetryEnabled -
    
    Returns:
    
    ClientConfigBuilder
  - logRequestStatus
```
public ClientConfig.ClientConfigBuilder logRequestStatus(boolean logRequestStatus)
```
    Log request status Default value is false
    
    Parameters:
    
    logRequestStatus -
    
    Returns:
    
    ClientConfigBuilder
  - requestInterceptor
```
public ClientConfig.ClientConfigBuilder requestInterceptor(HttpRequestInterceptor requestInterceptor)
```
    Request Interceptor
    
    Parameters:
    
    requestInterceptor -
    
    Returns:
    
    ClientConfigBuilder
  - proxyConfig
```
public ClientConfig.ClientConfigBuilder proxyConfig(ClientProxyConfig proxyConfig)
```
    Proxy Configuration
    
    Parameters:
    
    proxyConfig -
    
    Returns:
    
    ClientConfigBuilder
  - exceptionHandler
```
public ClientConfig.ClientConfigBuilder exceptionHandler(TargetExceptionHandler handler)
```
    Exception Handler
    
    Parameters:
    
    handler -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceDecisioningHandler
```
public ClientConfig.ClientConfigBuilder onDeviceDecisioningHandler(OnDeviceDecisioningHandler handler)
```
    On Device Decisioning Handler
    
    Parameters:
    
    handler -
    
    Returns:
    
    ClientConfigBuilder
  - defaultDecisioningMethod
```
public ClientConfig.ClientConfigBuilder defaultDecisioningMethod(DecisioningMethod decisioningMethod)
```
    Default Decisioning Method Default value is server-side
    
    Parameters:
    
    decisioningMethod -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceEnvironment
```
public ClientConfig.ClientConfigBuilder onDeviceEnvironment(java.lang.String environment)
```
    On Device Environment Default value is production
    
    Parameters:
    
    environment -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceConfigHostname
```
public ClientConfig.ClientConfigBuilder onDeviceConfigHostname(java.lang.String hostname)
```
    On Device Config Hostname Default value is assets.adobetarget.com
    
    Parameters:
    
    hostname -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceDecisioningPollingIntSecs
```
public ClientConfig.ClientConfigBuilder onDeviceDecisioningPollingIntSecs(int pollingInterval)
```
    On Device Decisioning Polling Interval in seconds Default value is 300
    
    Parameters:
    
    pollingInterval -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceArtifactPayload
```
public ClientConfig.ClientConfigBuilder onDeviceArtifactPayload(byte[] payload)
```
    On Device Artifact Payload
    
    Parameters:
    
    payload -
    
    Returns:
    
    ClientConfigBuilder
  - onDeviceAllMatchingRulesMboxes
```
public ClientConfig.ClientConfigBuilder onDeviceAllMatchingRulesMboxes(java.util.List<java.lang.String> mboxes)
```
    On Device All Matching Rules Mboxes
    
    Parameters:
    
    mboxes -
    
    Returns:
    
    ClientConfigBuilder
  - httpClient
```
public ClientConfig.ClientConfigBuilder httpClient(HttpClient httpClient)
```
    HTTP Client
    
    Parameters:
    
    httpClient -
    
    Returns:
    
    ClientConfigBuilder
  - build
```
public ClientConfig build()
```

Class ClientConfig.ClientConfigBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

client

organizationId

serverDomain

defaultPropertyToken

secure

socketTimeout

connectTimeout

maxConnectionsPerHost

maxConnectionsTotal

connectionTtlMs

idleConnectionValidationMs

evictIdleConnectionsAfterSecs

enableRetries

logRequests

telemetryEnabled

logRequestStatus

requestInterceptor

proxyConfig

exceptionHandler

onDeviceDecisioningHandler

defaultDecisioningMethod

onDeviceEnvironment

onDeviceConfigHostname

onDeviceDecisioningPollingIntSecs

onDeviceArtifactPayload

onDeviceAllMatchingRulesMboxes

httpClient

build