com.couchbase.client.java.env

Class DefaultCouchbaseEnvironment

java.lang.Object

com.couchbase.client.core.env.DefaultCoreEnvironment

com.couchbase.client.java.env.DefaultCouchbaseEnvironment

All Implemented Interfaces:

com.couchbase.client.core.env.CoreEnvironment, CouchbaseEnvironment

public class DefaultCouchbaseEnvironment
extends com.couchbase.client.core.env.DefaultCoreEnvironment
implements CouchbaseEnvironment

The default implementation of a CouchbaseEnvironment.

This environment is intended to be reused and passed in across AsyncCluster instances. It is stateful and needs to be shut down manually if it was passed in by the user. Some threads it manages are non-daemon threads.

Default settings can be customized through the DefaultCouchbaseEnvironment.Builder or through the setting of system properties. Latter ones take always precedence and can be used to override builder settings at runtime too.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultCouchbaseEnvironment.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	SDK_PACKAGE_NAME_AND_VERSION

Fields inherited from class com.couchbase.client.core.env.DefaultCoreEnvironment

AUTORELEASE_AFTER, BOOTSTRAP_CARRIER_DIRECT_PORT, BOOTSTRAP_CARRIER_ENABLED, BOOTSTRAP_CARRIER_SSL_PORT, BOOTSTRAP_HTTP_DIRECT_PORT, BOOTSTRAP_HTTP_ENABLED, BOOTSTRAP_HTTP_SSL_PORT, BUFFER_POOLING_ENABLED, COMPUTATION_POOL_SIZE, DCP_ENABLED, IO_POOL_SIZE, KEEPALIVEINTERVAL, KEYVALUE_ENDPOINTS, MAX_REQUEST_LIFETIME, MUTATION_TOKENS_ENABLED, OBSERVE_INTERVAL_DELAY, PACKAGE_NAME_AND_VERSION, QUERY_ENABLED, QUERY_ENDPOINTS, QUERY_PORT, RECONNECT_DELAY, REQUEST_BUFFER_SIZE, RESPONSE_BUFFER_SIZE, RETRY_DELAY, RETRY_STRATEGY, SSL_ENABLED, SSL_KEYSTORE_FILE, SSL_KEYSTORE_PASSWORD, TCP_NODELAY_ENALED, USER_AGENT, VIEW_ENDPOINTS

Method Summary

Modifier and Type	Method and Description
static DefaultCouchbaseEnvironment.Builder	builder() Returns the DefaultCouchbaseEnvironment.Builder to customize environment settings.
long	connectTimeout() The default timeout for connect operations, set to CONNECT_TIMEOUT.
static DefaultCouchbaseEnvironment	create() Creates a CouchbaseEnvironment with default settings applied.
long	disconnectTimeout() The default timeout for disconnect operations, set to DISCONNECT_TIMEOUT.
boolean	dnsSrvEnabled() Returns whether DNS SRV lookup for the bootstrap nodes is enabled or not.
protected StringBuilder	dumpParameters(StringBuilder sb)
long	kvTimeout() The default timeout for binary (key/value) operations, set to KV_TIMEOUT.
long	managementTimeout() The default timeout for management operations, set to MANAGEMENT_TIMEOUT.
long	queryTimeout() The default timeout for query operations, set to QUERY_TIMEOUT.
String	toString()
long	viewTimeout() The default timeout for view operations, set to VIEW_TIMEOUT.

Methods inherited from class com.couchbase.client.core.env.DefaultCoreEnvironment

autoreleaseAfter, booleanPropertyOr, bootstrapCarrierDirectPort, bootstrapCarrierEnabled, bootstrapCarrierSslPort, bootstrapHttpDirectPort, bootstrapHttpEnabled, bootstrapHttpSslPort, bufferPoolingEnabled, computationPoolSize, dcpEnabled, eventBus, intPropertyOr, ioPool, ioPoolSize, keepAliveInterval, kvEndpoints, longPropertyOr, maxRequestLifetime, mutationTokensEnabled, networkLatencyMetricsCollector, observeIntervalDelay, packageNameAndVersion, queryEnabled, queryEndpoints, queryPort, reconnectDelay, requestBufferSize, responseBufferSize, retryDelay, retryStrategy, runtimeMetricsCollector, scheduler, shutdown, sslEnabled, sslKeystoreFile, sslKeystorePassword, stringPropertyOr, tcpNodelayEnabled, userAgent, viewEndpoints

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.client.core.env.CoreEnvironment

autoreleaseAfter, bootstrapCarrierDirectPort, bootstrapCarrierEnabled, bootstrapCarrierSslPort, bootstrapHttpDirectPort, bootstrapHttpEnabled, bootstrapHttpSslPort, bufferPoolingEnabled, computationPoolSize, dcpEnabled, eventBus, ioPool, ioPoolSize, keepAliveInterval, kvEndpoints, maxRequestLifetime, mutationTokensEnabled, networkLatencyMetricsCollector, observeIntervalDelay, packageNameAndVersion, queryEnabled, queryEndpoints, queryPort, reconnectDelay, requestBufferSize, responseBufferSize, retryDelay, retryStrategy, runtimeMetricsCollector, scheduler, shutdown, sslEnabled, sslKeystoreFile, sslKeystorePassword, tcpNodelayEnabled, userAgent, viewEndpoints

Field Detail

SDK_PACKAGE_NAME_AND_VERSION

public static String SDK_PACKAGE_NAME_AND_VERSION

Method Detail

create

public static DefaultCouchbaseEnvironment create()

Creates a CouchbaseEnvironment with default settings applied.

Returns:

a DefaultCouchbaseEnvironment with default settings.

builder

public static DefaultCouchbaseEnvironment.Builder builder()

Returns the DefaultCouchbaseEnvironment.Builder to customize environment settings.

Returns:

the DefaultCouchbaseEnvironment.Builder.

managementTimeout

public long managementTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for management operations, set to MANAGEMENT_TIMEOUT.

Specified by:

managementTimeout in interface CouchbaseEnvironment

Returns:

the default management timeout.

queryTimeout

public long queryTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for query operations, set to QUERY_TIMEOUT.

Specified by:

queryTimeout in interface CouchbaseEnvironment

Returns:

the default query timeout.

viewTimeout

public long viewTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for view operations, set to VIEW_TIMEOUT.

Specified by:

viewTimeout in interface CouchbaseEnvironment

Returns:

the default view timeout.

kvTimeout

public long kvTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for binary (key/value) operations, set to KV_TIMEOUT.

Specified by:

kvTimeout in interface CouchbaseEnvironment

Returns:

the default binary timeout.

connectTimeout

public long connectTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for connect operations, set to CONNECT_TIMEOUT.

Specified by:

connectTimeout in interface CouchbaseEnvironment

Returns:

the default connect timeout.

disconnectTimeout

public long disconnectTimeout()

Description copied from interface: CouchbaseEnvironment

The default timeout for disconnect operations, set to DISCONNECT_TIMEOUT.

Specified by:

disconnectTimeout in interface CouchbaseEnvironment

Returns:

the default disconnect timeout.

dnsSrvEnabled

public boolean dnsSrvEnabled()

Description copied from interface: CouchbaseEnvironment

Returns whether DNS SRV lookup for the bootstrap nodes is enabled or not.

Specified by:

dnsSrvEnabled in interface CouchbaseEnvironment

Returns:

true if enabled, false otherwise.

dumpParameters

protected StringBuilder dumpParameters(StringBuilder sb)

Overrides:

dumpParameters in class com.couchbase.client.core.env.DefaultCoreEnvironment

toString

public String toString()

Overrides:

toString in class com.couchbase.client.core.env.DefaultCoreEnvironment