com.couchbase.client.java.env

Interface CouchbaseEnvironment

All Superinterfaces:

ConfigParserEnvironment, CoreEnvironment, SecureEnvironment

All Known Implementing Classes:

DefaultCouchbaseEnvironment

@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface CouchbaseEnvironment
extends CoreEnvironment

The CouchbaseEnvironment which shares state across Clusters.

Since:

2.0

Author:

Michael Nitschinger

Method Summary

Modifier and Type	Method and Description
long	analyticsTimeout() The default timeout for analytics operations, set to DefaultCouchbaseEnvironment.ANALYTICS_TIMEOUT.
String	clientBuild() Returns build information on the Couchbase Java SDK client.
String	clientVersion() Returns version information on the Couchbase Java SDK client.
long	connectTimeout() The default timeout for connect operations, set to DefaultCouchbaseEnvironment.CONNECT_TIMEOUT.
com.couchbase.client.encryption.CryptoManager	cryptoManager() Returns the crypto manager set.
boolean	dnsSrvEnabled() Returns whether DNS SRV lookup for the bootstrap nodes is enabled or not.
long	kvTimeout() The default timeout for binary (key/value) operations, set to DefaultCouchbaseEnvironment.KV_TIMEOUT.
long	managementTimeout() The default timeout for management operations, set to DefaultCouchbaseEnvironment.MANAGEMENT_TIMEOUT.
boolean	propagateParentSpan() If set to true, the code will check if a parent span is available and if so use this implicitly as a parent.
long	queryTimeout() The default timeout for query operations, set to DefaultCouchbaseEnvironment.QUERY_TIMEOUT.
long	searchTimeout() The default timeout for search operations, set to DefaultCouchbaseEnvironment.SEARCH_TIMEOUT.
long	viewTimeout() The default timeout for view operations, set to DefaultCouchbaseEnvironment.VIEW_TIMEOUT.

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

analyticsIoPool, analyticsServiceConfig, autoreleaseAfter, bootstrapCarrierDirectPort, bootstrapCarrierEnabled, bootstrapCarrierSslPort, bootstrapHttpDirectPort, bootstrapHttpEnabled, bootstrapHttpSslPort, bufferPoolingEnabled, callbacksOnIoPool, certAuthEnabled, compressionEnabled, compressionMinRatio, compressionMinSize, computationPoolSize, configPollFloorInterval, configPollInterval, continuousKeepAliveEnabled, coreBuild, coreVersion, couchbaseCoreSendHook, disconnectTimeout, eventBus, forceSaslPlain, ioPool, ioPoolSize, keepAliveErrorThreshold, keepAliveInterval, keepAliveTimeout, kvEndpoints, kvIoPool, kvServiceConfig, maxRequestLifetime, mutationTokensEnabled, networkLatencyMetricsCollector, networkResolution, observeIntervalDelay, operationTracingEnabled, operationTracingServerDurationEnabled, orphanResponseReporter, orphanResponseReportingEnabled, packageNameAndVersion, queryEndpoints, queryIoPool, queryServiceConfig, reconnectDelay, requestBufferSize, requestBufferWaitStrategy, responseBufferSize, retryDelay, retryStrategy, runtimeMetricsCollector, scheduler, searchEndpoints, searchIoPool, searchServiceConfig, shutdown, shutdown, shutdownAsync, socketConnectTimeout, tcpNodelayEnabled, tracer, userAgent, viewEndpoints, viewIoPool, viewServiceConfig

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

sslEnabled, sslKeystore, sslKeystoreFile, sslKeystorePassword, sslTruststore, sslTruststoreFile, sslTruststorePassword

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

memcachedHashingStrategy

Method Detail

managementTimeout

long managementTimeout()

The default timeout for management operations, set to DefaultCouchbaseEnvironment.MANAGEMENT_TIMEOUT.

Returns:

the default management timeout.

queryTimeout

long queryTimeout()

The default timeout for query operations, set to DefaultCouchbaseEnvironment.QUERY_TIMEOUT.

Returns:

the default query timeout.

viewTimeout

long viewTimeout()

The default timeout for view operations, set to DefaultCouchbaseEnvironment.VIEW_TIMEOUT.

Returns:

the default view timeout.

searchTimeout

long searchTimeout()

The default timeout for search operations, set to DefaultCouchbaseEnvironment.SEARCH_TIMEOUT.

Returns:

the default search timeout.

analyticsTimeout

long analyticsTimeout()

The default timeout for analytics operations, set to DefaultCouchbaseEnvironment.ANALYTICS_TIMEOUT.

Returns:

the default analytics timeout.

kvTimeout

long kvTimeout()

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

Returns:

the default binary timeout.

connectTimeout

long connectTimeout()

The default timeout for connect operations, set to DefaultCouchbaseEnvironment.CONNECT_TIMEOUT.

Returns:

the default connect timeout.

dnsSrvEnabled

boolean dnsSrvEnabled()

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

Returns:

true if enabled, false otherwise.

clientVersion

String clientVersion()

Returns version information on the Couchbase Java SDK client. Version number is in the form MAJOR.MINOR.PATCH, and is the one for the java-client layer.

Returns:

the version string for the Java client.

See Also:

for a more specific build information (relevant for tracking the exact version of the code the client was built from), for the same information but relative to the core layer.

clientBuild

String clientBuild()

Returns build information on the Couchbase Java SDK client. This has a better granularity than clientVersion() and thus is more relevant to track the exact version of the code the client was built from. Build information can contain VCS information like commit numbers, tags, etc...

Returns:

the build string for the Java client.

See Also:

for more generic version information., for the same information but relative to the core layer.

cryptoManager

@InterfaceStability.Committed
 @InterfaceAudience.Public
com.couchbase.client.encryption.CryptoManager cryptoManager()

Returns the crypto manager set. Note: Use of the Field Level Encryption functionality provided in the com.couchbase.client.encryption namespace provided by Couchbase is subject to the Couchbase Inc. Enterprise Subscription License Agreement at https://www.couchbase.com/ESLA-11132015.

propagateParentSpan

boolean propagateParentSpan()

If set to true, the code will check if a parent span is available and if so use this implicitly as a parent. This is enabled by default for ease of use but can be disabled in case it causes weird effects to parent spans in trace output.

Returns:

if a parent span should be propagated automatically.