DefaultCoreEnvironment (Couchbase JVM Core IO 1.5.1 API)

java.lang.Object
- com.couchbase.client.core.env.DefaultCoreEnvironment

All Implemented Interfaces:

ConfigParserEnvironment, CoreEnvironment, SecureEnvironment
```
public class DefaultCoreEnvironment
extends Object
implements CoreEnvironment
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultCoreEnvironment.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultCoreEnvironment.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`AUTORELEASE_AFTER`
`static int`	`BOOTSTRAP_CARRIER_DIRECT_PORT`
`static boolean`	`BOOTSTRAP_CARRIER_ENABLED`
`static int`	`BOOTSTRAP_CARRIER_SSL_PORT`
`static int`	`BOOTSTRAP_HTTP_DIRECT_PORT`
`static boolean`	`BOOTSTRAP_HTTP_ENABLED`
`static int`	`BOOTSTRAP_HTTP_SSL_PORT`
`static boolean`	`BUFFER_POOLING_ENABLED`
`static boolean`	`CALLBACKS_ON_IO_POOL`
`static boolean`	`CERT_AUTH_ENABLED`
`static int`	`COMPUTATION_POOL_SIZE`
`static long`	`CONFIG_POLL_INTERVAL`
`static boolean`	`CONTINUOUS_KEEPALIVE_ENABLED`
`static String`	`CORE_GIT_VERSION`
`static String`	`CORE_VERSION`
`static long`	`DISCONNECT_TIMEOUT`
`static int`	`IO_POOL_SIZE`
`static long`	`KEEPALIVE_ERROR_THRESHOLD`
`static long`	`KEEPALIVE_TIMEOUT`
`static long`	`KEEPALIVEINTERVAL`
`static int`	`KEYVALUE_ENDPOINTS`
`static long`	`MAX_REQUEST_LIFETIME`
`static MemcachedHashingStrategy`	`MEMCACHED_HASHING_STRATEGY`
`static boolean`	`MUTATION_TOKENS_ENABLED`
`static Delay`	`OBSERVE_INTERVAL_DELAY`
`static String`	`PACKAGE_NAME_AND_VERSION`
`static int`	`QUERY_ENDPOINTS`
`static Delay`	`RECONNECT_DELAY`
`static int`	`REQUEST_BUFFER_SIZE`
`static int`	`RESPONSE_BUFFER_SIZE`
`static Delay`	`RETRY_DELAY`
`static RetryStrategy`	`RETRY_STRATEGY`
`static int`	`SEARCH_ENDPOINTS`
`static int`	`SOCKET_CONNECT_TIMEOUT`
`static boolean`	`SSL_ENABLED`
`static KeyStore`	`SSL_KEYSTORE`
`static String`	`SSL_KEYSTORE_FILE`
`static String`	`SSL_KEYSTORE_PASSWORD`
`static boolean`	`TCP_NODELAY_ENALED`
`static String`	`USER_AGENT`
`static int`	`VIEW_ENDPOINTS`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DefaultCoreEnvironment(DefaultCoreEnvironment.Builder builder)

Constructors
Modifier	Constructor and Description
`protected`	`DefaultCoreEnvironment(DefaultCoreEnvironment.Builder builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`autoreleaseAfter()` The time in milliseconds after which a non-subscribed observable is going to be automatically released.
`protected boolean`	`booleanPropertyOr(String path, boolean def)`
`int`	`bootstrapCarrierDirectPort()` The port to use when bootstrapping through carrier publication without SSL.
`boolean`	`bootstrapCarrierEnabled()` If bootstrapping through the advanced carrier publication is enabled.
`int`	`bootstrapCarrierSslPort()` The port to use when bootstrapping through carrier publication with SSL.
`int`	`bootstrapHttpDirectPort()` The port to use when bootstrapping through HTTP without SSL.
`boolean`	`bootstrapHttpEnabled()` If bootstrapping through HTTP is enabled.
`int`	`bootstrapHttpSslPort()` The port to use when bootstrapping through HTTP with SSL.
`boolean`	`bufferPoolingEnabled()` Returns if buffer pooling is enabled for greater GC efficiency.
`static DefaultCoreEnvironment.Builder`	`builder()`
`boolean`	`callbacksOnIoPool()` Returns true if the `Observable` callbacks are completed on the IO event loops.
`boolean`	`certAuthEnabled()` True if X.509 client certificate authentication is enabled.
`int`	`computationPoolSize()` Returns the pool size (number of threads) for all computation tasks.
`long`	`configPollInterval()` Returns the proactive polling interval for cluster configurations.
`boolean`	`continuousKeepAliveEnabled()` If set to true, KeepAlives will be sent on a regular basis in the interval also if there is traffic on the socket, not only if its idle.
`String`	`coreBuild()` Returns build information on the Couchbase Java SDK core.
`String`	`coreVersion()` Returns version information on the core.
`CouchbaseCoreSendHook`	`couchbaseCoreSendHook()` Returns the `CouchbaseCoreSendHook` if set, null otherwise.
`static DefaultCoreEnvironment`	`create()`
`long`	`disconnectTimeout()` The default timeout for disconnect operations, set to `DISCONNECT_TIMEOUT`.
`protected static double`	`doublePropertyOr(String path, double def)`
`protected StringBuilder`	`dumpParameters(StringBuilder sb)` Dumps the environment parameters known to this implementation into a `StringBuilder`, which is returned for method chaining.
`EventBus`	`eventBus()` Returns the event bus where events are broadcasted on and can be published to.
`static int`	`instanceCounter()`
`protected int`	`intPropertyOr(String path, int def)`
`EventLoopGroup`	`ioPool()` Returns the IO pool for the underlying IO framework, used as the default pool if not overridden for the individual services.
`int`	`ioPoolSize()` Returns the configured IO pool size.
`long`	`keepAliveErrorThreshold()` Specifies the number of times a KeepAlive message on a socket can fail before the connection is recycled.
`long`	`keepAliveInterval()` The time in milliseconds after which some service will issue a form of keep-alive request.
`long`	`keepAliveTimeout()` Specifies the timeout of a keepalive operation on the socket in milliseconds.
`int`	`kvEndpoints()` The number of key/value service endpoints.
`EventLoopGroup`	`kvIoPool()` If set returns the IO Pool for the KV service, if not returns null.
`KeyValueServiceConfig`	`kvServiceConfig()` Returns the current `KeyValueService` configuration.
`protected static long`	`longPropertyOr(String path, long def)`
`long`	`maxRequestLifetime()` Returns the maximum time in milliseconds a request is allowed to life.
`MemcachedHashingStrategy`	`memcachedHashingStrategy()` Allows to specify a custom strategy to hash memcached bucket documents.
`boolean`	`mutationTokensEnabled()` Returns true if extended mutation tokens are enabled.
`NetworkLatencyMetricsCollector`	`networkLatencyMetricsCollector()` Returns the collector responsible for aggregating and publishing network latency information.
`Delay`	`observeIntervalDelay()` Returns the `Delay` for `Observe` poll operations.
`String`	`packageNameAndVersion()` Returns name and the version of the package.
`int`	`queryEndpoints()` The number of query service endpoints.
`EventLoopGroup`	`queryIoPool()` If set returns the IO Pool for the query service, if not returns null.
`QueryServiceConfig`	`queryServiceConfig()` Returns the current `QueryService` configuration.
`Delay`	`reconnectDelay()` Returns the `Delay` for node reconnects.
`int`	`requestBufferSize()` Returns the size of the request ringbuffer.
`WaitStrategyFactory`	`requestBufferWaitStrategy()` Waiting strategy used by request `EventProcessor`s to wait for data from `RingBuffer`
`int`	`responseBufferSize()` Returns the size of the response ringbuffer.
`Delay`	`retryDelay()` Returns the `Delay` for request retries.
`RetryStrategy`	`retryStrategy()` The retry strategy on how to dispatch requests in the failure case.
`MetricsCollector`	`runtimeMetricsCollector()` Returns the collector responsible for aggregating and publishing runtime information like gc and memory.
`rx.Scheduler`	`scheduler()` Returns the scheduler which should be used for all core actions that need to happen asynchronously.
`int`	`searchEndpoints()` The number of search service endpoints.
`EventLoopGroup`	`searchIoPool()` If set returns the IO Pool for the search service, if not returns null.
`SearchServiceConfig`	`searchServiceConfig()` Returns the current `SearchService` configuration.
`boolean`	`shutdown()` Shutdown the `CoreEnvironment` with the default timeout.
`boolean`	`shutdown(long timeout, TimeUnit timeUnit)` Shutdown the `CoreEnvironment` with a custom timeout.
`rx.Observable<Boolean>`	`shutdownAsync()` Shutdown the `CoreEnvironment` in an asynchronous fashion.
`int`	`socketConnectTimeout()` Returns the amount of time the SDK will wait on the socket connect until an error is raised and handled.
`boolean`	`sslEnabled()` Identifies if SSL should be enabled.
`KeyStore`	`sslKeystore()` Allows to directly configure a `KeyStore`.
`String`	`sslKeystoreFile()` Identifies the filepath to the ssl keystore.
`String`	`sslKeystorePassword()` The password which is used to protect the keystore.
`protected String`	`stringPropertyOr(String path, String def)`
`boolean`	`tcpNodelayEnabled()` Returns true if TCP_NODELAY is enabled (therefore Nagle’ing is disabled).
`String`	`toString()`
`String`	`userAgent()` Library identification string, which can be used as User-Agent header in HTTP requests.
`int`	`viewEndpoints()` The number of view service endpoints.
`EventLoopGroup`	`viewIoPool()` If set returns the IO Pool for the View service, if not returns null.
`ViewServiceConfig`	`viewServiceConfig()` Returns the current `ViewService` configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SSL_ENABLED
```
public static final boolean SSL_ENABLED
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_FILE
```
public static final String SSL_KEYSTORE_FILE
```
  - SSL_KEYSTORE_PASSWORD
```
public static final String SSL_KEYSTORE_PASSWORD
```
  - SSL_KEYSTORE
```
public static final KeyStore SSL_KEYSTORE
```
  - BOOTSTRAP_HTTP_ENABLED
```
public static final boolean BOOTSTRAP_HTTP_ENABLED
```
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_CARRIER_ENABLED
```
public static final boolean BOOTSTRAP_CARRIER_ENABLED
```
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_HTTP_DIRECT_PORT
```
public static final int BOOTSTRAP_HTTP_DIRECT_PORT
```
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_HTTP_SSL_PORT
```
public static final int BOOTSTRAP_HTTP_SSL_PORT
```
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_CARRIER_DIRECT_PORT
```
public static final int BOOTSTRAP_CARRIER_DIRECT_PORT
```
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_CARRIER_SSL_PORT
```
public static final int BOOTSTRAP_CARRIER_SSL_PORT
```
    See Also:
    
    Constant Field Values
  - REQUEST_BUFFER_SIZE
```
public static final int REQUEST_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - RESPONSE_BUFFER_SIZE
```
public static final int RESPONSE_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - IO_POOL_SIZE
```
public static final int IO_POOL_SIZE
```
  - COMPUTATION_POOL_SIZE
```
public static final int COMPUTATION_POOL_SIZE
```
  - KEYVALUE_ENDPOINTS
```
public static final int KEYVALUE_ENDPOINTS
```
    See Also:
    
    Constant Field Values
  - VIEW_ENDPOINTS
```
public static final int VIEW_ENDPOINTS
```
    See Also:
    
    Constant Field Values
  - QUERY_ENDPOINTS
```
public static final int QUERY_ENDPOINTS
```
    See Also:
    
    Constant Field Values
  - SEARCH_ENDPOINTS
```
public static final int SEARCH_ENDPOINTS
```
    See Also:
    
    Constant Field Values
  - OBSERVE_INTERVAL_DELAY
```
public static final Delay OBSERVE_INTERVAL_DELAY
```
  - RECONNECT_DELAY
```
public static final Delay RECONNECT_DELAY
```
  - RETRY_DELAY
```
public static final Delay RETRY_DELAY
```
  - RETRY_STRATEGY
```
public static final RetryStrategy RETRY_STRATEGY
```
  - MAX_REQUEST_LIFETIME
```
public static final long MAX_REQUEST_LIFETIME
```
  - KEEPALIVEINTERVAL
```
public static final long KEEPALIVEINTERVAL
```
  - CONTINUOUS_KEEPALIVE_ENABLED
```
public static final boolean CONTINUOUS_KEEPALIVE_ENABLED
```
    See Also:
    
    Constant Field Values
  - KEEPALIVE_ERROR_THRESHOLD
```
public static final long KEEPALIVE_ERROR_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - KEEPALIVE_TIMEOUT
```
public static final long KEEPALIVE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - AUTORELEASE_AFTER
```
public static final long AUTORELEASE_AFTER
```
  - BUFFER_POOLING_ENABLED
```
public static final boolean BUFFER_POOLING_ENABLED
```
    See Also:
    
    Constant Field Values
  - TCP_NODELAY_ENALED
```
public static final boolean TCP_NODELAY_ENALED
```
    See Also:
    
    Constant Field Values
  - MUTATION_TOKENS_ENABLED
```
public static final boolean MUTATION_TOKENS_ENABLED
```
    See Also:
    
    Constant Field Values
  - SOCKET_CONNECT_TIMEOUT
```
public static final int SOCKET_CONNECT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - CALLBACKS_ON_IO_POOL
```
public static final boolean CALLBACKS_ON_IO_POOL
```
    See Also:
    
    Constant Field Values
  - DISCONNECT_TIMEOUT
```
public static final long DISCONNECT_TIMEOUT
```
  - MEMCACHED_HASHING_STRATEGY
```
public static final MemcachedHashingStrategy MEMCACHED_HASHING_STRATEGY
```
  - CONFIG_POLL_INTERVAL
```
public static final long CONFIG_POLL_INTERVAL
```
    See Also:
    
    Constant Field Values
  - CERT_AUTH_ENABLED
```
public static final boolean CERT_AUTH_ENABLED
```
    See Also:
    
    Constant Field Values
  - CORE_VERSION
```
public static String CORE_VERSION
```
  - CORE_GIT_VERSION
```
public static String CORE_GIT_VERSION
```
  - PACKAGE_NAME_AND_VERSION
```
public static String PACKAGE_NAME_AND_VERSION
```
  - USER_AGENT
```
public static String USER_AGENT
```
- Constructor Detail
  - DefaultCoreEnvironment
```
protected DefaultCoreEnvironment(DefaultCoreEnvironment.Builder builder)
```
- Method Detail
  - create
```
public static DefaultCoreEnvironment create()
```
  - builder
```
public static DefaultCoreEnvironment.Builder builder()
```
  - booleanPropertyOr
```
protected boolean booleanPropertyOr(String path,
                                    boolean def)
```
  - stringPropertyOr
```
protected String stringPropertyOr(String path,
                                  String def)
```
  - intPropertyOr
```
protected int intPropertyOr(String path,
                            int def)
```
  - longPropertyOr
```
protected static long longPropertyOr(String path,
                                     long def)
```
  - doublePropertyOr
```
protected static double doublePropertyOr(String path,
                                         double def)
```
  - ioPool
```
public EventLoopGroup ioPool()
```
    Description copied from interface: CoreEnvironment
    
    Returns the IO pool for the underlying IO framework, used as the default pool if not overridden for the individual services.
    
    Specified by:
    
    ioPool in interface CoreEnvironment
    
    Returns:
    
    the default IO pool, shared across resources.
  - shutdown
```
public boolean shutdown()
```
    Description copied from interface: CoreEnvironment
    
    Shutdown the CoreEnvironment with the default timeout.
    This method has been converted (after a deprecation phase) from an async method into a synchronous one. The async version can still be found at CoreEnvironment.shutdownAsync().
    
    Specified by:
    
    shutdown in interface CoreEnvironment
    
    Returns:
    
    returning a boolean, indicating the success of the shutdown.
  - shutdown
```
public boolean shutdown(long timeout,
                        TimeUnit timeUnit)
```
    Description copied from interface: CoreEnvironment
    
    Shutdown the CoreEnvironment with a custom timeout.
    This method has been converted (after a deprecation phase) from an async method into a synchronous one. The async version can still be found at CoreEnvironment.shutdownAsync().
    
    Specified by:
    
    shutdown in interface CoreEnvironment
    
    Returns:
    
    returning a boolean, indicating the success of the shutdown.
  - shutdownAsync
```
public rx.Observable<Boolean> shutdownAsync()
```
    Description copied from interface: CoreEnvironment
    
    Shutdown the CoreEnvironment in an asynchronous fashion.
    Since this method is asynchronous and cold, it is important to subscribe to the observable to actually initiate the shutdown process.
    
    Specified by:
    
    shutdownAsync in interface CoreEnvironment
    
    Returns:
    
    an Observable eventually returning a boolean, indicating the success of the shutdown.
  - scheduler
```
public rx.Scheduler scheduler()
```
    Description copied from interface: CoreEnvironment
    
    Returns the scheduler which should be used for all core actions that need to happen asynchronously.
    
    Specified by:
    
    scheduler in interface CoreEnvironment
    
    Returns:
    
    the scheduler used for internal operations.
  - sslEnabled
```
public boolean sslEnabled()
```
    Description copied from interface: SecureEnvironment
    
    Identifies if SSL should be enabled.
    
    Specified by:
    
    sslEnabled in interface SecureEnvironment
    
    Returns:
    
    true if SSL is enabled, false otherwise.
  - sslKeystoreFile
```
public String sslKeystoreFile()
```
    Description copied from interface: SecureEnvironment
    
    Identifies the filepath to the ssl keystore.
    
    Specified by:
    
    sslKeystoreFile in interface SecureEnvironment
    
    Returns:
    
    the path to the keystore file.
  - sslKeystorePassword
```
public String sslKeystorePassword()
```
    Description copied from interface: SecureEnvironment
    
    The password which is used to protect the keystore.
    
    Specified by:
    
    sslKeystorePassword in interface SecureEnvironment
    
    Returns:
    
    the keystore password.
  - sslKeystore
```
public KeyStore sslKeystore()
```
    Description copied from interface: SecureEnvironment
    
    Allows to directly configure a KeyStore.
    
    Specified by:
    
    sslKeystore in interface SecureEnvironment
    
    Returns:
    
    the keystore to use.
  - bootstrapHttpEnabled
```
public boolean bootstrapHttpEnabled()
```
    Description copied from interface: CoreEnvironment
    
    If bootstrapping through HTTP is enabled.
    
    Specified by:
    
    bootstrapHttpEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled.
  - bootstrapCarrierEnabled
```
public boolean bootstrapCarrierEnabled()
```
    Description copied from interface: CoreEnvironment
    
    If bootstrapping through the advanced carrier publication is enabled.
    
    Specified by:
    
    bootstrapCarrierEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled.
  - bootstrapHttpDirectPort
```
public int bootstrapHttpDirectPort()
```
    Description copied from interface: CoreEnvironment
    
    The port to use when bootstrapping through HTTP without SSL.
    
    Specified by:
    
    bootstrapHttpDirectPort in interface CoreEnvironment
    
    Returns:
    
    the direct http port.
  - bootstrapHttpSslPort
```
public int bootstrapHttpSslPort()
```
    Description copied from interface: CoreEnvironment
    
    The port to use when bootstrapping through HTTP with SSL.
    
    Specified by:
    
    bootstrapHttpSslPort in interface CoreEnvironment
    
    Returns:
    
    the https port.
  - bootstrapCarrierDirectPort
```
public int bootstrapCarrierDirectPort()
```
    Description copied from interface: CoreEnvironment
    
    The port to use when bootstrapping through carrier publication without SSL.
    
    Specified by:
    
    bootstrapCarrierDirectPort in interface CoreEnvironment
    
    Returns:
    
    the direct carrier publication port.
  - bootstrapCarrierSslPort
```
public int bootstrapCarrierSslPort()
```
    Description copied from interface: CoreEnvironment
    
    The port to use when bootstrapping through carrier publication with SSL.
    
    Specified by:
    
    bootstrapCarrierSslPort in interface CoreEnvironment
    
    Returns:
    
    the ssl carrier publication port.
  - ioPoolSize
```
public int ioPoolSize()
```
    Description copied from interface: CoreEnvironment
    
    Returns the configured IO pool size.
    
    Specified by:
    
    ioPoolSize in interface CoreEnvironment
    
    Returns:
    
    the pool size (number of threads to use).
  - computationPoolSize
```
public int computationPoolSize()
```
    Description copied from interface: CoreEnvironment
    
    Returns the pool size (number of threads) for all computation tasks.
    
    Specified by:
    
    computationPoolSize in interface CoreEnvironment
    
    Returns:
    
    the pool size (number of threads to use).
  - requestBufferSize
```
public int requestBufferSize()
```
    Description copied from interface: CoreEnvironment
    
    Returns the size of the request ringbuffer.
    
    Specified by:
    
    requestBufferSize in interface CoreEnvironment
    
    Returns:
    
    the size of the ringbuffer.
  - responseBufferSize
```
public int responseBufferSize()
```
    Description copied from interface: CoreEnvironment
    
    Returns the size of the response ringbuffer.
    
    Specified by:
    
    responseBufferSize in interface CoreEnvironment
    
    Returns:
    
    the size of the ringbuffer.
  - kvEndpoints
```
public int kvEndpoints()
```
    Description copied from interface: CoreEnvironment
    
    The number of key/value service endpoints.
    
    Specified by:
    
    kvEndpoints in interface CoreEnvironment
    
    Returns:
    
    amount of endpoints per service.
  - viewEndpoints
```
public int viewEndpoints()
```
    Description copied from interface: CoreEnvironment
    
    The number of view service endpoints.
    
    Specified by:
    
    viewEndpoints in interface CoreEnvironment
    
    Returns:
    
    amount of endpoints per service.
  - queryEndpoints
```
public int queryEndpoints()
```
    Description copied from interface: CoreEnvironment
    
    The number of query service endpoints.
    
    Specified by:
    
    queryEndpoints in interface CoreEnvironment
    
    Returns:
    
    amount of endpoints per service.
  - searchEndpoints
```
public int searchEndpoints()
```
    Description copied from interface: CoreEnvironment
    
    The number of search service endpoints.
    
    Specified by:
    
    searchEndpoints in interface CoreEnvironment
    
    Returns:
    
    amount of endpoints per service.
  - coreVersion
```
public String coreVersion()
```
    Description copied from interface: CoreEnvironment
    
    Returns version information on the core. Version number is in the form MAJOR.MINOR.PATCH, and is the one for the core-io layer.
    
    Specified by:
    
    coreVersion in interface CoreEnvironment
    
    Returns:
    
    the version string for the core.
    
    See Also:
    
    for a more specific build information (relevant for tracking the exact version of the code the core was built from)
  - coreBuild
```
public String coreBuild()
```
    Description copied from interface: CoreEnvironment
    
    Returns build information on the Couchbase Java SDK core. This has a better granularity than CoreEnvironment.coreVersion() and thus is more relevant to track the exact version of the code the core was built from.
    Build information can contain VCS information like commit numbers, tags, etc…
    
    Specified by:
    
    coreBuild in interface CoreEnvironment
    
    Returns:
    
    the build string for the core.
    
    See Also:
    
    for more generic version information.
  - userAgent
```
public String userAgent()
```
    Description copied from interface: CoreEnvironment
    
    Library identification string, which can be used as User-Agent header in HTTP requests.
    
    Specified by:
    
    userAgent in interface CoreEnvironment
    
    Returns:
    
    identification string
  - packageNameAndVersion
```
public String packageNameAndVersion()
```
    Description copied from interface: CoreEnvironment
    
    Returns name and the version of the package. This method used to by @{link userAgent()}.
    
    Specified by:
    
    packageNameAndVersion in interface CoreEnvironment
    
    Returns:
    
    string containing package name and version
  - observeIntervalDelay
```
public Delay observeIntervalDelay()
```
    Description copied from interface: CoreEnvironment
    
    Returns the Delay for Observe poll operations.
    
    Specified by:
    
    observeIntervalDelay in interface CoreEnvironment
    
    Returns:
    
    the observe interval delay.
  - reconnectDelay
```
public Delay reconnectDelay()
```
    Description copied from interface: CoreEnvironment
    
    Returns the Delay for node reconnects.
    
    Specified by:
    
    reconnectDelay in interface CoreEnvironment
    
    Returns:
    
    the node reconnect delay.
  - retryDelay
```
public Delay retryDelay()
```
    Description copied from interface: CoreEnvironment
    
    Returns the Delay for request retries.
    
    Specified by:
    
    retryDelay in interface CoreEnvironment
    
    Returns:
    
    the request retry delay.
  - retryStrategy
```
public RetryStrategy retryStrategy()
```
    Description copied from interface: CoreEnvironment
    
    The retry strategy on how to dispatch requests in the failure case.
    
    Specified by:
    
    retryStrategy in interface CoreEnvironment
    
    Returns:
    
    the retry strategy.
  - maxRequestLifetime
```
public long maxRequestLifetime()
```
    Description copied from interface: CoreEnvironment
    
    Returns the maximum time in milliseconds a request is allowed to life.
    If the best effort retry strategy is used, the request will still be cancelled after this period to make sure that requests are not sticking around forever. Make sure it is longer than any timeout you potentially have configured.
    
    Specified by:
    
    maxRequestLifetime in interface CoreEnvironment
    
    Returns:
    
    the maximum request lifetime.
  - keepAliveInterval
```
public long keepAliveInterval()
```
    Description copied from interface: CoreEnvironment
    
    The time in milliseconds after which some service will issue a form of keep-alive request.
    
    Specified by:
    
    keepAliveInterval in interface CoreEnvironment
    
    Returns:
    
    the interval of idle time in milliseconds after which a keep-alive is triggered.
  - eventBus
```
public EventBus eventBus()
```
    Description copied from interface: CoreEnvironment
    
    Returns the event bus where events are broadcasted on and can be published to.
    
    Specified by:
    
    eventBus in interface CoreEnvironment
    
    Returns:
    
    the configured event bus.
  - autoreleaseAfter
```
public long autoreleaseAfter()
```
    Description copied from interface: CoreEnvironment
    
    The time in milliseconds after which a non-subscribed observable is going to be automatically released.
    This prevents accidentally leaking buffers when requested but not consumed by the user.
    
    Specified by:
    
    autoreleaseAfter in interface CoreEnvironment
    
    Returns:
    
    the time after which the buffers are released if not subscribed.
  - bufferPoolingEnabled
```
public boolean bufferPoolingEnabled()
```
    Description copied from interface: CoreEnvironment
    
    Returns if buffer pooling is enabled for greater GC efficiency.
    In general this is always set to true and should only be set to false if there are leaks reported that are not fixable by correcting user level code.
    
    Specified by:
    
    bufferPoolingEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled, false otherwise.
  - tcpNodelayEnabled
```
public boolean tcpNodelayEnabled()
```
    Description copied from interface: CoreEnvironment
    
    Returns true if TCP_NODELAY is enabled (therefore Nagle’ing is disabled).
    
    Specified by:
    
    tcpNodelayEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled.
  - mutationTokensEnabled
```
public boolean mutationTokensEnabled()
```
    Description copied from interface: CoreEnvironment
    
    Returns true if extended mutation tokens are enabled.
    Note that while this may return true, the server also needs to support it (Couchbase Server 4.0 and above). It will be negotiated during connection setup, but needs to be explicitly enabled on the environment as well to take effect (since it has a 16 bytes overhead on every mutation performed).
    
    Specified by:
    
    mutationTokensEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled on the client side.
  - runtimeMetricsCollector
```
public MetricsCollector runtimeMetricsCollector()
```
    Description copied from interface: CoreEnvironment
    
    Returns the collector responsible for aggregating and publishing runtime information like gc and memory.
    
    Specified by:
    
    runtimeMetricsCollector in interface CoreEnvironment
    
    Returns:
    
    the collector.
  - networkLatencyMetricsCollector
```
public NetworkLatencyMetricsCollector networkLatencyMetricsCollector()
```
    Description copied from interface: CoreEnvironment
    
    Returns the collector responsible for aggregating and publishing network latency information.
    
    Specified by:
    
    networkLatencyMetricsCollector in interface CoreEnvironment
    
    Returns:
    
    the collector.
  - socketConnectTimeout
```
public int socketConnectTimeout()
```
    Description copied from interface: CoreEnvironment
    
    Returns the amount of time the SDK will wait on the socket connect until an error is raised and handled.
    
    Specified by:
    
    socketConnectTimeout in interface CoreEnvironment
    
    Returns:
    
    the socket connect timeout in milliseconds.
  - callbacksOnIoPool
```
public boolean callbacksOnIoPool()
```
    Description copied from interface: CoreEnvironment
    
    Returns true if the Observable callbacks are completed on the IO event loops.
    Note: this is an advanced option and must be used with care. It can be used to improve performance since it removes additional scheduling overhead on the response path, but any blocking calls in the callbacks will lead to more work on the event loops itself and eventually stall them.
    
    Specified by:
    
    callbacksOnIoPool in interface CoreEnvironment
    
    Returns:
    
    true if callbacks are scheduled on the IO event loops.
  - disconnectTimeout
```
public long disconnectTimeout()
```
    Description copied from interface: CoreEnvironment
    
    The default timeout for disconnect operations, set to DISCONNECT_TIMEOUT.
    
    Specified by:
    
    disconnectTimeout in interface CoreEnvironment
    
    Returns:
    
    the default disconnect timeout.
  - requestBufferWaitStrategy
```
public WaitStrategyFactory requestBufferWaitStrategy()
```
    Description copied from interface: CoreEnvironment
    
    Waiting strategy used by request EventProcessors to wait for data from RingBuffer
    
    Specified by:
    
    requestBufferWaitStrategy in interface CoreEnvironment
    
    Returns:
    
    waiting strategy
  - memcachedHashingStrategy
```
public MemcachedHashingStrategy memcachedHashingStrategy()
```
    Description copied from interface: ConfigParserEnvironment
    
    Allows to specify a custom strategy to hash memcached bucket documents.
    If you want to use this SDK side by side with 1.x SDKs on memcached buckets, configure the environment to use the LegacyMemcachedHashingStrategy instead.
    
    Specified by:
    
    memcachedHashingStrategy in interface ConfigParserEnvironment
    
    Returns:
    
    the memcached hashing strategy.
  - kvIoPool
```
public EventLoopGroup kvIoPool()
```
    Description copied from interface: CoreEnvironment
    
    If set returns the IO Pool for the KV service, if not returns null.
    
    Specified by:
    
    kvIoPool in interface CoreEnvironment
    
    Returns:
    
    the KV IO pool if set, null otherwise.
  - viewIoPool
```
public EventLoopGroup viewIoPool()
```
    Description copied from interface: CoreEnvironment
    
    If set returns the IO Pool for the View service, if not returns null.
    
    Specified by:
    
    viewIoPool in interface CoreEnvironment
    
    Returns:
    
    the view IO pool if set, null otherwise.
  - queryIoPool
```
public EventLoopGroup queryIoPool()
```
    Description copied from interface: CoreEnvironment
    
    If set returns the IO Pool for the query service, if not returns null.
    
    Specified by:
    
    queryIoPool in interface CoreEnvironment
    
    Returns:
    
    the query IO pool if set, null otherwise.
  - searchIoPool
```
public EventLoopGroup searchIoPool()
```
    Description copied from interface: CoreEnvironment
    
    If set returns the IO Pool for the search service, if not returns null.
    
    Specified by:
    
    searchIoPool in interface CoreEnvironment
    
    Returns:
    
    the search IO pool if set, null otherwise.
  - instanceCounter
```
public static int instanceCounter()
```
  - kvServiceConfig
```
public KeyValueServiceConfig kvServiceConfig()
```
    Description copied from interface: CoreEnvironment
    
    Returns the current KeyValueService configuration.
    
    Specified by:
    
    kvServiceConfig in interface CoreEnvironment
    
    Returns:
    
    the current config for the kv service.
  - queryServiceConfig
```
public QueryServiceConfig queryServiceConfig()
```
    Description copied from interface: CoreEnvironment
    
    Returns the current QueryService configuration.
    
    Specified by:
    
    queryServiceConfig in interface CoreEnvironment
    
    Returns:
    
    the current config for the query service.
  - viewServiceConfig
```
public ViewServiceConfig viewServiceConfig()
```
    Description copied from interface: CoreEnvironment
    
    Returns the current ViewService configuration.
    
    Specified by:
    
    viewServiceConfig in interface CoreEnvironment
    
    Returns:
    
    the current config for the view service.
  - searchServiceConfig
```
public SearchServiceConfig searchServiceConfig()
```
    Description copied from interface: CoreEnvironment
    
    Returns the current SearchService configuration.
    
    Specified by:
    
    searchServiceConfig in interface CoreEnvironment
    
    Returns:
    
    the current config for the search service.
  - configPollInterval
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public long configPollInterval()
```
    Description copied from interface: CoreEnvironment
    
    Returns the proactive polling interval for cluster configurations.
    
    Specified by:
    
    configPollInterval in interface CoreEnvironment
    
    Returns:
    
    the polling interval in milliseconds.
  - certAuthEnabled
```
public boolean certAuthEnabled()
```
    Description copied from interface: CoreEnvironment
    
    True if X.509 client certificate authentication is enabled.
    
    Specified by:
    
    certAuthEnabled in interface CoreEnvironment
  - continuousKeepAliveEnabled
```
public boolean continuousKeepAliveEnabled()
```
    Description copied from interface: CoreEnvironment
    
    If set to true, KeepAlives will be sent on a regular basis in the interval also if there is traffic on the socket, not only if its idle.
    
    Specified by:
    
    continuousKeepAliveEnabled in interface CoreEnvironment
    
    Returns:
    
    true if enabled, false otherwise.
  - keepAliveErrorThreshold
```
public long keepAliveErrorThreshold()
```
    Description copied from interface: CoreEnvironment
    
    Specifies the number of times a KeepAlive message on a socket can fail before the connection is recycled.
    
    Specified by:
    
    keepAliveErrorThreshold in interface CoreEnvironment
    
    Returns:
    
    the number of keepalive errors allowed to happen before the socket is reopened.
  - keepAliveTimeout
```
public long keepAliveTimeout()
```
    Description copied from interface: CoreEnvironment
    
    Specifies the timeout of a keepalive operation on the socket in milliseconds.
    
    Specified by:
    
    keepAliveTimeout in interface CoreEnvironment
    
    Returns:
  - couchbaseCoreSendHook
```
public CouchbaseCoreSendHook couchbaseCoreSendHook()
```
    Description copied from interface: CoreEnvironment
    
    Returns the CouchbaseCoreSendHook if set, null otherwise.
    
    Specified by:
    
    couchbaseCoreSendHook in interface CoreEnvironment
  - dumpParameters
```
protected StringBuilder dumpParameters(StringBuilder sb)
```
    Dumps the environment parameters known to this implementation into a StringBuilder, which is returned for method chaining.
    
    Parameters:
    
    sb - the StringBuilder in which to dump parameters.
    
    Returns:
    
    the same StringBuilder for method chaining.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultCoreEnvironment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSL_ENABLED

SSL_KEYSTORE_FILE

SSL_KEYSTORE_PASSWORD

SSL_KEYSTORE

BOOTSTRAP_HTTP_ENABLED

BOOTSTRAP_CARRIER_ENABLED

BOOTSTRAP_HTTP_DIRECT_PORT

BOOTSTRAP_HTTP_SSL_PORT

BOOTSTRAP_CARRIER_DIRECT_PORT

BOOTSTRAP_CARRIER_SSL_PORT

REQUEST_BUFFER_SIZE

RESPONSE_BUFFER_SIZE

IO_POOL_SIZE

COMPUTATION_POOL_SIZE

KEYVALUE_ENDPOINTS

VIEW_ENDPOINTS

QUERY_ENDPOINTS

SEARCH_ENDPOINTS

OBSERVE_INTERVAL_DELAY

RECONNECT_DELAY

RETRY_DELAY

RETRY_STRATEGY

MAX_REQUEST_LIFETIME

KEEPALIVEINTERVAL

CONTINUOUS_KEEPALIVE_ENABLED

KEEPALIVE_ERROR_THRESHOLD

KEEPALIVE_TIMEOUT

AUTORELEASE_AFTER

BUFFER_POOLING_ENABLED

TCP_NODELAY_ENALED

MUTATION_TOKENS_ENABLED

SOCKET_CONNECT_TIMEOUT

CALLBACKS_ON_IO_POOL

DISCONNECT_TIMEOUT

MEMCACHED_HASHING_STRATEGY

CONFIG_POLL_INTERVAL

CERT_AUTH_ENABLED

CORE_VERSION

CORE_GIT_VERSION

PACKAGE_NAME_AND_VERSION

USER_AGENT

Constructor Detail

DefaultCoreEnvironment

Method Detail

create

builder

booleanPropertyOr

stringPropertyOr

intPropertyOr

longPropertyOr

doublePropertyOr

ioPool

shutdown

shutdown

shutdownAsync

scheduler

sslEnabled

sslKeystoreFile

sslKeystorePassword

sslKeystore

bootstrapHttpEnabled

bootstrapCarrierEnabled

bootstrapHttpDirectPort

bootstrapHttpSslPort

bootstrapCarrierDirectPort

bootstrapCarrierSslPort

ioPoolSize

computationPoolSize

requestBufferSize

responseBufferSize

kvEndpoints

viewEndpoints

queryEndpoints