oracle.pgx.config

Class ClientConfigBuilder

java.lang.Object

oracle.pgx.config.ClientConfigBuilder

public class ClientConfigBuilder
extends java.lang.Object

A builder for ClientConfig objects

Constructor Summary

Constructors

Constructor and Description
ClientConfigBuilder()

Method Summary

Modifier and Type	Method and Description
ClientConfigBuilder	addRealmConfigValue(java.lang.String key, java.lang.Object value) Add an entry to the implementation dependent configuration options for the realm client
ClientConfig	build() Creates a ClientConfig object with the specified values
static ClientConfigBuilder	forBaseUrl(java.lang.String baseUrl) Creates a new ClientConfigBuilder for a specific PGX base URL.
ClientConfigBuilder	setAccessToken(java.lang.String token) Sets the authentication token (if server requires authentication)
ClientConfigBuilder	setBaseUrl(java.lang.String baseUrl) Sets the base URL
ClientConfigBuilder	setClientServerInteractionMode(InteractionMode interactionMode) Sets the client/server interaction mode (InteractionMode.BLOCKING, InteractionMode.ASYNC_POLLING)
ClientConfigBuilder	setEnableCctrace(boolean enableCctrace) Sets whether CC tracing is enabled
ClientConfigBuilder	setMaxClientHttpConnections(int maxClientHttpConnections) Sets the maximum amount of client HTTP connections
ClientConfigBuilder	setPrefetchSize(int prefetchSize) Sets the prefetch size
ClientConfigBuilder	setRealmClientConfig(java.util.Map<java.lang.String,java.lang.Object> realmClientConfig) Set implementation dependent configuration options for the realm client
ClientConfigBuilder	setRemoteFuturePendingRetryInterval(int remoteFuturePendingRetryInterval) Sets the remote future pending retry interval
ClientConfigBuilder	setRemoteFutureTimeout(int remoteFutureTimeout) Sets the remote future timeout
ClientConfigBuilder	setUploadBatchSize(int uploadBatchSize) Sets the upload batch size

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConfigBuilder

public ClientConfigBuilder()

Method Detail

addRealmConfigValue

public ClientConfigBuilder addRealmConfigValue(java.lang.String key,
                                               java.lang.Object value)

Add an entry to the implementation dependent configuration options for the realm client

Parameters:

key - the key for the configuration value

value - the configuration value

Returns:

this builder

Since:

21.1

build

public ClientConfig build()

Creates a ClientConfig object with the specified values

Returns:

a ClientConfig object

forBaseUrl

public static ClientConfigBuilder forBaseUrl(java.lang.String baseUrl)

Creates a new ClientConfigBuilder for a specific PGX base URL.

Parameters:

baseUrl - the base URL of the PGX server or Pgx.EMBEDDED_URL to indicate to start an embedded engine

Returns:

a new ClientConfigBuilder object

setAccessToken

public ClientConfigBuilder setAccessToken(java.lang.String token)

Sets the authentication token (if server requires authentication)

Parameters:

token - the authentication token

Returns:

this builder

setBaseUrl

public ClientConfigBuilder setBaseUrl(java.lang.String baseUrl)

Sets the base URL

Parameters:

baseUrl - the base URL

Returns:

this builder

setClientServerInteractionMode

public ClientConfigBuilder setClientServerInteractionMode(InteractionMode interactionMode)

Sets the client/server interaction mode (InteractionMode.BLOCKING, InteractionMode.ASYNC_POLLING)

Parameters:

interactionMode - client/server interaction mode

Returns:

this builder

setEnableCctrace

public ClientConfigBuilder setEnableCctrace(boolean enableCctrace)

Sets whether CC tracing is enabled

Parameters:

enableCctrace - whether CC tracing is enabled

Returns:

this builder

setMaxClientHttpConnections

public ClientConfigBuilder setMaxClientHttpConnections(int maxClientHttpConnections)

Sets the maximum amount of client HTTP connections

Parameters:

maxClientHttpConnections - the maximum amount of client HTTP connections

Returns:

this builder

setPrefetchSize

public ClientConfigBuilder setPrefetchSize(int prefetchSize)

Sets the prefetch size

Parameters:

prefetchSize - the prefetch size

Returns:

this builder

setRealmClientConfig

public ClientConfigBuilder setRealmClientConfig(java.util.Map<java.lang.String,java.lang.Object> realmClientConfig)

Set implementation dependent configuration options for the realm client

Parameters:

realmClientConfig - the configuration options

Returns:

this builder

Since:

21.1

setRemoteFuturePendingRetryInterval

public ClientConfigBuilder setRemoteFuturePendingRetryInterval(int remoteFuturePendingRetryInterval)

Sets the remote future pending retry interval

Parameters:

remoteFuturePendingRetryInterval - the remote future pending retry interval

Returns:

this builder

setRemoteFutureTimeout

public ClientConfigBuilder setRemoteFutureTimeout(int remoteFutureTimeout)

Sets the remote future timeout

Parameters:

remoteFutureTimeout - the remote future timeout

Returns:

this builder

setUploadBatchSize

public ClientConfigBuilder setUploadBatchSize(int uploadBatchSize)

Sets the upload batch size

Parameters:

uploadBatchSize - the upload batch size

Returns:

this builder