public class ClusterEnvironment extends CoreEnvironment
If not created explicitly by the user, the SDK will create its own one internally that can also be accessed
by the user. If this is the case it does not need to be shut down manually. If the environment is passed in
to the ClusterOptions though the user is responsible for shutting it down after
the cluster is disconnected!
Since the ClusterEnvironment extends the CoreEnvironment, most options can be found on the parent
class for documentation purposes.
| Modifier and Type | Class and Description |
|---|---|
static class |
ClusterEnvironment.Builder |
DEFAULT_MAX_NUM_REQUESTS_IN_RETRY| Modifier and Type | Method and Description |
|---|---|
static ClusterEnvironment.Builder |
builder()
Creates a
ClusterEnvironment.Builder to customize the properties of the environment. |
static ClusterEnvironment |
create()
Creates a new
ClusterEnvironment with default settings. |
Optional<CryptoManager> |
cryptoManager()
Returns the low-level cryptography manager for Field-Level Encryption if one has been configured.
|
protected String |
defaultAgentTitle() |
JsonSerializer |
jsonSerializer()
Returns the default serializer used to serialize and deserialize JSON values.
|
Transcoder |
transcoder()
Returns the default transcoder used for all operations if not overridden on a per-operation basis.
|
clientHash, clientVersion, compressionConfig, coreHash, coreVersion, eventBus, exportAsString, ioConfig, ioEnvironment, loggerConfig, orphanReporter, requestTracer, retryStrategy, scheduler, securityConfig, shutdown, shutdown, shutdownAsync, shutdownAsync, shutdownReactive, shutdownReactive, timeoutConfig, timer, toString, userAgentprotected String defaultAgentTitle()
defaultAgentTitle in class CoreEnvironmentpublic static ClusterEnvironment create()
ClusterEnvironment with default settings.public static ClusterEnvironment.Builder builder()
ClusterEnvironment.Builder to customize the properties of the environment.ClusterEnvironment.Builder to customize.public Transcoder transcoder()
public JsonSerializer jsonSerializer()
public Optional<CryptoManager> cryptoManager()
Useful for implementing encryption with external JSON libraries.
See JsonObjectCrypto for a high level alternative that's compatible
with Couchbase JsonObjects.
Note: Use of the Field-Level Encryption functionality is subject to the Couchbase Inc. Enterprise Subscription License Agreement v7
Copyright © 2020 Couchbase, Inc.. All rights reserved.