Package com.couchbase.client.core.env

Class CoreEnvironment.Builder<SELF extends CoreEnvironment.Builder<SELF>>

java.lang.Object

com.couchbase.client.core.env.CoreEnvironment.Builder<SELF>

Enclosing class:

CoreEnvironment

public static class CoreEnvironment.Builder<SELF extends CoreEnvironment.Builder<SELF>>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreTransactionsConfig	transactionsConfig

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
SELF	addRequestCallback(RequestCallback requestCallback)	Allows to configure callbacks across the lifetime of a request.
SELF	applyProfile(String profileName)	Applies custom properties based on a profile name.
CoreEnvironment	build()	Turns this builder into a real CoreEnvironment.
CompressionConfig.Builder	compressionConfig()	Returns the currently stored config builder.
SELF	compressionConfig(CompressionConfig.Builder compressionConfig)	Deprecated. Please use compressionConfig(Consumer) instead.
SELF	compressionConfig(Consumer<CompressionConfig.Builder> builderConsumer)	Allows to configure the CompressionConfig through a provided builder.
SELF	eventBus(EventBus eventBus)	Customizes the event bus for the SDK.
IoConfig.Builder	ioConfig()	Returns the currently stored config builder.
SELF	ioConfig(IoConfig.Builder ioConfig)	Deprecated. Please use ioConfig(Consumer) instead.
SELF	ioConfig(Consumer<IoConfig.Builder> builderConsumer)	Allows to configure the IoConfig through a provided builder.
IoEnvironment.Builder	ioEnvironment()	Deprecated. Please use ioEnvironmentConfig() instead.
SELF	ioEnvironment(IoEnvironment.Builder ioEnvironment)	Deprecated. Please use ioEnvironment(Consumer) instead.
SELF	ioEnvironment(Consumer<IoEnvironment.Builder> builderConsumer)	Allows to configure the IoEnvironment through a provided builder.
IoEnvironment.Builder	ioEnvironmentConfig()	Returns the currently stored IoEnvironment builder.
SELF	load(PropertyLoader<CoreEnvironment.Builder> loader)	Immediately loads the properties from the given loader into the environment.
LoggerConfig.Builder	loggerConfig()	Returns the currently stored config builder.
SELF	loggerConfig(LoggerConfig.Builder loggerConfig)	Deprecated. Please use loggerConfig(Consumer) instead.
SELF	loggerConfig(Consumer<LoggerConfig.Builder> builderConsumer)	Allows to configure the LoggerConfig through a provided builder.
LoggingMeterConfig.Builder	loggingMeterConfig()
SELF	loggingMeterConfig(LoggingMeterConfig.Builder loggingMeterConfig)	Deprecated. Please use loggingMeterConfig(Consumer) instead.
SELF	loggingMeterConfig(Consumer<LoggingMeterConfig.Builder> builderConsumer)	Allows to configure the LoggingMeterConfig through a provided builder.
SELF	maxNumRequestsInRetry(long maxNumRequestsInRetry)	Allows to customize the maximum number of requests allowed in the retry timer.
SELF	meter(Meter meter)	Allows to configure a custom metrics implementation.
OrphanReporterConfig.Builder	orphanReporterConfig()	Returns the currently stored config builder.
SELF	orphanReporterConfig(OrphanReporterConfig.Builder orphanReporterConfig)	Deprecated. Please use orphanReporterConfig(Consumer) instead.
SELF	orphanReporterConfig(Consumer<OrphanReporterConfig.Builder> builderConsumer)	Allows to configure the OrphanReporterConfig through a provided builder.
SELF	requestTracer(RequestTracer requestTracer)	Allows to configure a custom tracer implementation.
SELF	retryStrategy(RetryStrategy retryStrategy)	Allows to customize the default retry strategy.
SELF	scheduler(Scheduler scheduler)	Customizes the default Reactor scheduler used for parallel operations.
SELF	schedulerThreadCount(int schedulerThreadCount)	Customizes the thread count for the CoreEnvironment.scheduler() if not customized by scheduler(Scheduler).
SecurityConfig.Builder	securityConfig()	Returns the currently stored config builder.
SELF	securityConfig(SecurityConfig.Builder securityConfig)	Deprecated. Please use securityConfig(Consumer) instead.
SELF	securityConfig(Consumer<SecurityConfig.Builder> builderConsumer)	Allows to configure the SecurityConfig through a provided builder.
protected SELF	self()
ThresholdLoggingTracerConfig.Builder	thresholdLoggingTracerConfig()
SELF	thresholdLoggingTracerConfig(ThresholdLoggingTracerConfig.Builder thresholdLoggingTracerConfig)	Deprecated. Please use thresholdLoggingTracerConfig(Consumer) instead.
SELF	thresholdLoggingTracerConfig(Consumer<ThresholdLoggingTracerConfig.Builder> builderConsumer)	Allows to configure the ThresholdLoggingTracerConfig through a provided builder.
ThresholdRequestTracerConfig.Builder	thresholdRequestTracerConfig()	Deprecated.
SELF	thresholdRequestTracerConfig(ThresholdRequestTracerConfig.Builder thresholdRequestTracerConfig)	Deprecated. Please use thresholdLoggingTracerConfig(Consumer) instead.
TimeoutConfig.Builder	timeoutConfig()	Returns the currently stored config builder.
SELF	timeoutConfig(TimeoutConfig.Builder timeoutConfig)	Deprecated. Please use timeoutConfig(Consumer) instead.
SELF	timeoutConfig(Consumer<TimeoutConfig.Builder> builderConsumer)	Allows to configure the TimeoutConfig through a provided builder.

Methods inherited from class java.lang.Object

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

Field Details

transactionsConfig

protected CoreTransactionsConfig transactionsConfig

Constructor Details

Builder

protected Builder()

Method Details

ioEnvironment

public SELF ioEnvironment(Consumer<IoEnvironment.Builder> builderConsumer)

Allows to configure the IoEnvironment through a provided builder.

This method is preferred over ioEnvironment(IoEnvironment.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the IoEnvironment to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

ioConfig

public SELF ioConfig(Consumer<IoConfig.Builder> builderConsumer)

Allows to configure the IoConfig through a provided builder.

This method is preferred over ioConfig(IoConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the IoConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

compressionConfig

public SELF compressionConfig(Consumer<CompressionConfig.Builder> builderConsumer)

Allows to configure the CompressionConfig through a provided builder.

This method is preferred over compressionConfig(CompressionConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the CompressionConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

securityConfig

public SELF securityConfig(Consumer<SecurityConfig.Builder> builderConsumer)

Allows to configure the SecurityConfig through a provided builder.

This method is preferred over securityConfig(SecurityConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the SecurityConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

timeoutConfig

public SELF timeoutConfig(Consumer<TimeoutConfig.Builder> builderConsumer)

Allows to configure the TimeoutConfig through a provided builder.

This method is preferred over timeoutConfig(TimeoutConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the TimeoutConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

loggerConfig

public SELF loggerConfig(Consumer<LoggerConfig.Builder> builderConsumer)

Allows to configure the LoggerConfig through a provided builder.

This method is preferred over loggerConfig(LoggerConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the LoggerConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

orphanReporterConfig

public SELF orphanReporterConfig(Consumer<OrphanReporterConfig.Builder> builderConsumer)

Allows to configure the OrphanReporterConfig through a provided builder.

This method is preferred over orphanReporterConfig(OrphanReporterConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the OrphanReporterConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

thresholdLoggingTracerConfig

public SELF thresholdLoggingTracerConfig(Consumer<ThresholdLoggingTracerConfig.Builder> builderConsumer)

Allows to configure the ThresholdLoggingTracerConfig through a provided builder.

This method is preferred over thresholdLoggingTracerConfig(ThresholdLoggingTracerConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the ThresholdLoggingTracerConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

loggingMeterConfig

public SELF loggingMeterConfig(Consumer<LoggingMeterConfig.Builder> builderConsumer)

Allows to configure the LoggingMeterConfig through a provided builder.

This method is preferred over loggingMeterConfig(LoggingMeterConfig.Builder) since then properties on an already existing configuration are not overridden.

Parameters:

builderConsumer - the builder for the LoggingMeterConfig to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

self

protected SELF self()

maxNumRequestsInRetry

public SELF maxNumRequestsInRetry(long maxNumRequestsInRetry)

Allows to customize the maximum number of requests allowed in the retry timer.

If the CoreEnvironment.DEFAULT_MAX_NUM_REQUESTS_IN_RETRY is reached, each request that would be queued for retry is instead cancelled with a CancellationReason.TOO_MANY_REQUESTS_IN_RETRY. This acts as a form of safety net and backpressure.

Parameters:

maxNumRequestsInRetry - the maximum number of requests outstanding for retry.

Returns:

this CoreEnvironment.Builder for chaining purposes.

load

public SELF load(PropertyLoader<CoreEnvironment.Builder> loader)

Immediately loads the properties from the given loader into the environment.

Parameters:

loader - the loader to load the properties from.

Returns:

this CoreEnvironment.Builder for chaining purposes.

ioEnvironment

@Deprecated
public SELF ioEnvironment(IoEnvironment.Builder ioEnvironment)

Deprecated.

Please use ioEnvironment(Consumer) instead.

Allows to customize I/O thread pools.

Note that the IoEnvironment holds thread pools and other resources. If you do not want to customize thread pool sizes, you likely want to look at the IoConfig instead.

Parameters:

ioEnvironment - the IO environment to customize.

Returns:

this CoreEnvironment.Builder for chaining purposes.

ioEnvironment

@Deprecated
public IoEnvironment.Builder ioEnvironment()

Deprecated.

Please use ioEnvironmentConfig() instead.

Returns the currently stored IoEnvironment builder.

Returns:

the current builder.

ioEnvironmentConfig

public IoEnvironment.Builder ioEnvironmentConfig()

Returns the currently stored IoEnvironment builder.

Returns:

the current builder.

ioConfig

@Deprecated
public SELF ioConfig(IoConfig.Builder ioConfig)

Deprecated.

Please use ioConfig(Consumer) instead.

Allows to customize various I/O-related configuration properties.

The I/O config is the main way to control how the SDK behaves at the lower levels. It allows to customize properties such as tcp keepalive, number of connections, circuit breakers, etc.

Parameters:

ioConfig - the custom I/O config to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

ioConfig

public IoConfig.Builder ioConfig()

Returns the currently stored config builder.

Returns:

the current builder.

orphanReporterConfig

@Deprecated
public SELF orphanReporterConfig(OrphanReporterConfig.Builder orphanReporterConfig)

Deprecated.

Please use orphanReporterConfig(Consumer) instead.

Allows to customize the behavior of the orphan response reporter.

The orphan reporter logs all responses that arrived when the requesting side is not listening anymore (usually because of a timeout). The config can be modified to tune certain properties like the sample size or the emit interval.

Parameters:

orphanReporterConfig - the custom orphan reporter config.

Returns:

this CoreEnvironment.Builder for chaining purposes.

orphanReporterConfig

public OrphanReporterConfig.Builder orphanReporterConfig()

Returns the currently stored config builder.

Returns:

the current builder.

loggingMeterConfig

@Deprecated
public SELF loggingMeterConfig(LoggingMeterConfig.Builder loggingMeterConfig)

Deprecated.

Please use loggingMeterConfig(Consumer) instead.

loggingMeterConfig

public LoggingMeterConfig.Builder loggingMeterConfig()

thresholdRequestTracerConfig

@Deprecated
public SELF thresholdRequestTracerConfig(ThresholdRequestTracerConfig.Builder thresholdRequestTracerConfig)

Deprecated.

Please use thresholdLoggingTracerConfig(Consumer) instead.

Allows to customize the threshold request tracer configuration.

Parameters:

thresholdRequestTracerConfig - the configuration which should be used.

Returns:

this CoreEnvironment.Builder for chaining purposes.

thresholdRequestTracerConfig

@Deprecated
public ThresholdRequestTracerConfig.Builder thresholdRequestTracerConfig()

Deprecated.

thresholdLoggingTracerConfig

@Deprecated
public SELF thresholdLoggingTracerConfig(ThresholdLoggingTracerConfig.Builder thresholdLoggingTracerConfig)

Deprecated.

Please use thresholdLoggingTracerConfig(Consumer) instead.

Allows to customize the threshold request tracer configuration.

Parameters:

thresholdLoggingTracerConfig - the configuration which should be used.

Returns:

this CoreEnvironment.Builder for chaining purposes.

thresholdLoggingTracerConfig

public ThresholdLoggingTracerConfig.Builder thresholdLoggingTracerConfig()

compressionConfig

@Deprecated
public SELF compressionConfig(CompressionConfig.Builder compressionConfig)

Deprecated.

Please use compressionConfig(Consumer) instead.

Allows to customize document value compression settings.

Usually this does not need to be tuned, but thresholds can be modified or compression can be disabled completely if needed.

Parameters:

compressionConfig - the custom compression config.

Returns:

this CoreEnvironment.Builder for chaining purposes.

compressionConfig

public CompressionConfig.Builder compressionConfig()

Returns the currently stored config builder.

Returns:

the current builder.

securityConfig

@Deprecated
public SELF securityConfig(SecurityConfig.Builder securityConfig)

Deprecated.

Please use securityConfig(Consumer) instead.

Allows to configure everything related to TLS/encrypted connections.

Note that if you are looking to use client certificate authentication, please refer to the CertificateAuthenticator instead.

Parameters:

securityConfig - the custom security config to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

securityConfig

public SecurityConfig.Builder securityConfig()

Returns the currently stored config builder.

Returns:

the current builder.

timeoutConfig

@Deprecated
public SELF timeoutConfig(TimeoutConfig.Builder timeoutConfig)

Deprecated.

Please use timeoutConfig(Consumer) instead.

Allows to customize the default timeouts for all operations.

Each timeout can also be modified on a per-request basis in their respective options blocks.

Parameters:

timeoutConfig - the custom timeout config to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

timeoutConfig

public TimeoutConfig.Builder timeoutConfig()

Returns the currently stored config builder.

Returns:

the current builder.

loggerConfig

@Deprecated
public SELF loggerConfig(LoggerConfig.Builder loggerConfig)

Deprecated.

Please use loggerConfig(Consumer) instead.

Allows to provide a custom configuration for the default logger used.

The default logger attaches itself to the EventBus on the environment and logs consumed events. This configuration allows to customize its behavior, diagnostic context etc.

Parameters:

loggerConfig - the custom logger config to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

loggerConfig

public LoggerConfig.Builder loggerConfig()

Returns the currently stored config builder.

Returns:

the current builder.

eventBus

@Uncommitted
public SELF eventBus(EventBus eventBus)

Customizes the event bus for the SDK.

The SDK ships with a high-performance implementation of a event bus. Only swap out if you have special needs, usually what you want instead is to register your own consumer on the event bus instead (EventBus.subscribe(Consumer))!

Parameters:

eventBus - the event bus to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

scheduler

@Uncommitted
public SELF scheduler(Scheduler scheduler)

Customizes the default Reactor scheduler used for parallel operations.

Usually you do not need to modify the scheduler, use with care.

Parameters:

scheduler - a custom scheduler to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

schedulerThreadCount

@Uncommitted
public SELF schedulerThreadCount(int schedulerThreadCount)

Customizes the thread count for the CoreEnvironment.scheduler() if not customized by scheduler(Scheduler).

By default, Schedulers.DEFAULT_POOL_SIZE is used. Note that if the scheduler itself is customized, this value is ignored.

Parameters:

schedulerThreadCount - the number of threads to use for the scheduler.

Returns:

this CoreEnvironment.Builder for chaining purposes.

retryStrategy

public SELF retryStrategy(RetryStrategy retryStrategy)

Allows to customize the default retry strategy.

Note that this setting modifies the SDK-wide retry strategy. It can still be overridden on a per-request basis in the respective options block.

Parameters:

retryStrategy - the default retry strategy to use for all operations.

Returns:

this CoreEnvironment.Builder for chaining purposes.

requestTracer

@Volatile
public SELF requestTracer(RequestTracer requestTracer)

Allows to configure a custom tracer implementation.

IMPORTANT: this is a volatile, likely to change API!

Parameters:

requestTracer - the custom request tracer to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

meter

@Volatile
public SELF meter(Meter meter)

Allows to configure a custom metrics implementation.

IMPORTANT: this is a volatile, likely to change API!

Parameters:

meter - the custom metrics implementation to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

addRequestCallback

@Internal
public SELF addRequestCallback(RequestCallback requestCallback)

Allows to configure callbacks across the lifetime of a request.

IMPORTANT: this is internal API and might change at any point in time.

Parameters:

requestCallback - the callback to use.

Returns:

this CoreEnvironment.Builder for chaining purposes.

build

public CoreEnvironment build()

Turns this builder into a real CoreEnvironment.

Returns:

the created core environment.

applyProfile

@Volatile
public SELF applyProfile(String profileName)

Applies custom properties based on a profile name.

At the moment only the "wan-development" profile is supported, but its actual values are not determined yet. Since this is volatile API, the actual profile names and their properties are subject to change.

New profiles can be registered by utilizing the ServiceRegistry mechanism. Create a file with the name of "com.couchbase.client.core.env.ConfigurationProfile" in your META-INF/services folder and the content contains each line of classes that implement the "EnvironmentProfile" interface. See the WanDevelopmentProfile for examples and usage.

Returns:

this CoreEnvironment.Builder for chaining purposes.