Top Description Inners Fields Constructors Methods
com.oracle.bmc

public Class ClientConfiguration

extends Object
Class Inheritance
Imports
com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration, .OciCircuitBreaker, com.oracle.bmc.retrier.RetryConfiguration
This class provides configuration options for client requests.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ClientConfiguration.ClientConfigurationBuilder

Field Summary

Modifier and TypeField and Description
private final OciCircuitBreaker
circuitBreaker

The circuit-breaker to use.

private final CircuitBreakerConfiguration
circuitBreakerConfiguration

The circuit-breaker configuration to use.

private static final int
CONNECTION_TIMEOUT_MILLIS

private final int
connectionTimeoutMillis

The max time to wait for a connection, in millis.

private static final int
MAX_ASYNC_THREADS

private final int
maxAsyncThreads

The max number of async threads to use.

private static final int
READ_TIMEOUT_MILLIS

private final int
readTimeoutMillis

The max time to wait for data, in millis.

private final RetryConfiguration
retryConfiguration

The retry configuration to use.

Constructor Summary

AccessConstructor and Description
private
ClientConfiguration(Integer connectionTimeoutMillis, Integer readTimeoutMillis, Integer maxAsyncThreads, Boolean disableDataBufferingOnUpload, RetryConfiguration retryConfiguration, CircuitBreakerConfiguration circuitBreakerConfiguration, OciCircuitBreaker circuitBreaker)

Method Summary

Modifier and TypeMethod and Description
public static ClientConfiguration.ClientConfigurationBuilder
builder()

public OciCircuitBreaker
getCircuitBreaker()

public CircuitBreakerConfiguration
getCircuitBreakerConfiguration()

public int
getConnectionTimeoutMillis()

public int
getMaxAsyncThreads()

private static <T> T
getOrDefault(T value, T defaultValue)

public int
getReadTimeoutMillis()

public RetryConfiguration
getRetryConfiguration()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

circuitBreakerback to summary
private final OciCircuitBreaker circuitBreaker

The circuit-breaker to use. Default is no circuit-breaker.

circuitBreakerConfigurationback to summary
private final CircuitBreakerConfiguration circuitBreakerConfiguration

The circuit-breaker configuration to use. Default is no circuit-breaker.

CONNECTION_TIMEOUT_MILLISback to summary
private static final int CONNECTION_TIMEOUT_MILLIS
connectionTimeoutMillisback to summary
private final int connectionTimeoutMillis

The max time to wait for a connection, in millis. Default is 10000.

MAX_ASYNC_THREADSback to summary
private static final int MAX_ASYNC_THREADS
maxAsyncThreadsback to summary
private final int maxAsyncThreads

The max number of async threads to use. Default is 50; Note: This property is only supported for Jersey default HttpUrlConnector To configure connection pool for Apache client, use ApacheConnectorProperties

READ_TIMEOUT_MILLISback to summary
private static final int READ_TIMEOUT_MILLIS
readTimeoutMillisback to summary
private final int readTimeoutMillis

The max time to wait for data, in millis. Default is 60000;

retryConfigurationback to summary
private final RetryConfiguration retryConfiguration

The retry configuration to use. Default is no retry.

Constructor Detail

ClientConfigurationback to summary
private ClientConfiguration(Integer connectionTimeoutMillis, Integer readTimeoutMillis, Integer maxAsyncThreads, Boolean disableDataBufferingOnUpload, RetryConfiguration retryConfiguration, CircuitBreakerConfiguration circuitBreakerConfiguration, OciCircuitBreaker circuitBreaker)

Method Detail

builderback to summary
public static ClientConfiguration.ClientConfigurationBuilder builder()
getCircuitBreakerback to summary
public OciCircuitBreaker getCircuitBreaker()
getCircuitBreakerConfigurationback to summary
public CircuitBreakerConfiguration getCircuitBreakerConfiguration()
getConnectionTimeoutMillisback to summary
public int getConnectionTimeoutMillis()
getMaxAsyncThreadsback to summary
public int getMaxAsyncThreads()
getOrDefaultback to summary
private static <T> T getOrDefault(T value, T defaultValue)
getReadTimeoutMillisback to summary
public int getReadTimeoutMillis()
getRetryConfigurationback to summary
public RetryConfiguration getRetryConfiguration()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

com.oracle.bmc back to summary

public Class ClientConfiguration.ClientConfigurationBuilder

extends Object
Class Inheritance
  • java.lang.Object
  • com.oracle.bmc.ClientConfiguration.ClientConfigurationBuilder

Field Summary

Modifier and TypeField and Description
private OciCircuitBreaker
circuitBreaker

private CircuitBreakerConfiguration
circuitBreakerConfiguration

private Integer
connectionTimeoutMillis

private Boolean
disableDataBufferingOnUpload

private Integer
maxAsyncThreads

private Integer
readTimeoutMillis

private RetryConfiguration
retryConfiguration

Constructor Summary

AccessConstructor and Description
pack-priv
ClientConfigurationBuilder()

Method Summary

Modifier and TypeMethod and Description
public ClientConfiguration
build()

public ClientConfiguration.ClientConfigurationBuilder
circuitBreaker(OciCircuitBreaker circuitBreaker)

public ClientConfiguration.ClientConfigurationBuilder
circuitBreakerConfiguration(CircuitBreakerConfiguration circuitBreakerConfiguration)

public ClientConfiguration.ClientConfigurationBuilder
connectionTimeoutMillis(Integer connectionTimeoutMillis)

public ClientConfiguration.ClientConfigurationBuilder
disableDataBufferingOnUpload(Boolean disableDataBufferingOnUpload)

public ClientConfiguration.ClientConfigurationBuilder
maxAsyncThreads(Integer maxAsyncThreads)

public ClientConfiguration.ClientConfigurationBuilder
readTimeoutMillis(Integer readTimeoutMillis)

public ClientConfiguration.ClientConfigurationBuilder
retryConfiguration(RetryConfiguration retryConfiguration)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

circuitBreakerback to summary
private OciCircuitBreaker circuitBreaker
circuitBreakerConfigurationback to summary
private CircuitBreakerConfiguration circuitBreakerConfiguration
connectionTimeoutMillisback to summary
private Integer connectionTimeoutMillis
disableDataBufferingOnUploadback to summary
private Boolean disableDataBufferingOnUpload
maxAsyncThreadsback to summary
private Integer maxAsyncThreads
readTimeoutMillisback to summary
private Integer readTimeoutMillis
retryConfigurationback to summary
private RetryConfiguration retryConfiguration

Constructor Detail

ClientConfigurationBuilderback to summary
pack-priv ClientConfigurationBuilder()

Method Detail

buildback to summary
public ClientConfiguration build()
circuitBreakerback to summary
public ClientConfiguration.ClientConfigurationBuilder circuitBreaker(OciCircuitBreaker circuitBreaker)
circuitBreakerConfigurationback to summary
public ClientConfiguration.ClientConfigurationBuilder circuitBreakerConfiguration(CircuitBreakerConfiguration circuitBreakerConfiguration)
connectionTimeoutMillisback to summary
public ClientConfiguration.ClientConfigurationBuilder connectionTimeoutMillis(Integer connectionTimeoutMillis)
disableDataBufferingOnUploadback to summary
public ClientConfiguration.ClientConfigurationBuilder disableDataBufferingOnUpload(Boolean disableDataBufferingOnUpload)
maxAsyncThreadsback to summary
public ClientConfiguration.ClientConfigurationBuilder maxAsyncThreads(Integer maxAsyncThreads)
readTimeoutMillisback to summary
public ClientConfiguration.ClientConfigurationBuilder readTimeoutMillis(Integer readTimeoutMillis)
retryConfigurationback to summary
public ClientConfiguration.ClientConfigurationBuilder retryConfiguration(RetryConfiguration retryConfiguration)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object