com.couchbase.client.java.env

Interface CouchbaseEnvironment

All Superinterfaces:

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
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.
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.
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

autoreleaseAfter, bootstrapCarrierDirectPort, bootstrapCarrierEnabled, bootstrapCarrierSslPort, bootstrapHttpDirectPort, bootstrapHttpEnabled, bootstrapHttpSslPort, bufferPoolingEnabled, callbacksOnIoPool, computationPoolSize, coreBuild, coreVersion, dcpConnectionBufferAckThreshold, dcpConnectionBufferSize, dcpConnectionName, dcpEnabled, disconnectTimeout, eventBus, ioPool, ioPoolSize, keepAliveInterval, kvEndpoints, maxRequestLifetime, memcachedHashingStrategy, mutationTokensEnabled, networkLatencyMetricsCollector, observeIntervalDelay, packageNameAndVersion, queryEndpoints, reconnectDelay, requestBufferSize, requestBufferWaitStrategy, responseBufferSize, retryDelay, retryStrategy, runtimeMetricsCollector, scheduler, searchEndpoints, shutdown, shutdown, shutdownAsync, socketConnectTimeout, tcpNodelayEnabled, userAgent, viewEndpoints

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

sslEnabled, sslKeystore, sslKeystoreFile, sslKeystorePassword

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.

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.