All Classes and Interfaces
Class
Description
Decoder for both
BinaryMemcacheRequest and BinaryMemcacheResponse.A
MessageToByteEncoder that encodes binary memache messages into bytes.Default implementation of a
BinaryMemcacheMessage.A skeletal implementation of
CouchbaseLogger.Default implementation for a
CouchbaseRequest, should be extended by child messages.The default representation of a
CouchbaseResponse.Parent implementation of a dynamic
Service.The common parent implementation for all
Endpoints.Generic handler which acts as the common base type for all implementing handlers.
Default implementation of a
BinaryRequest.The default abstract implementation for a latency metrics collector.
This service lazily creates an Endpoint if needed and reuses it.
An
AbstractLoader which provides common basic processing for all implementing loaders.The default
MemcacheObject implementation.A
ChannelHandler that aggregates an MemcacheMessage
and its following MemcacheContents into a single MemcacheMessage with
no following MemcacheContents.Abstract super class for both ascii and binary decoders.
A general purpose
AbstractMemcacheObjectEncoder that encodes MemcacheMessages.A common base class for all metrics collectors which emit events.
Abstract implementation of a service which enables and disables endpoints on demand.
Abstract implementation of a (fixed size) pooling Service.
Common implementation for all refreshers.
Defines a general config for a
Service.Abstract
Stateful implementation which acts like a simple state machine.The default implementation of a
StateZipper.Base class for
ByteBufProcessor that need to take JSON string escaping
into account, through the AbstractStringAwareBufProcessor.isEscaped(byte) method.Base class for all
BinarySubdocMutationRequest.Base class for all
BinarySubdocRequest.This endpoint defines the pipeline for analytics requests and responses.
The
AnalyticsHandler is responsible for encoding AnalyticsRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.The
AnalyticsHandlerV2 is responsible for encoding AnalyticsRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.Round robin node locator for Analytics.
Deferred analytics query result request
Deferred analytics query status request
Marker interface for all requests against the Analytics Service
The
AnalyticsService is composed of and manages AnalyticsEndpoints.Allows to configure a Analytics Service on a per-node basis.
Identifies the need to back off on the supplier side when using a service, because the consumer is overloaded.
Utility class to perform base64 encoding/decoding.
A
RetryStrategy that will retry until the max request lifetime is reached.The client codec that combines the proper encoder and decoder.
An interface that defines a binary Memcache message, providing common properties for
BinaryMemcacheRequest and BinaryMemcacheResponse.An object aggregator for the memcache binary protocol.
Represents all Opcodes that can occur in a
BinaryMemcacheMessage.Represents a full
BinaryMemcacheRequest, which contains the header and optional key and extras.The decoder part which takes care of decoding the request-specific headers.
The encoder part which takes care of encoding the request headers.
Represents a full
BinaryMemcacheResponse, which contains the header and optional key and extras.The decoder which takes care of decoding the response headers.
The encoder which takes care of encoding the response headers.
Contains all possible status values a response can return.
Common marker interface for all
BinaryRequests.Marker interface which signals a binary response.
A
BinarySubdocRequest that describes multiple lookup operations on a single document.A
BinarySubdocRequest that describes multiple mutations on a single document.A
BinarySubdocRequest that describes a mutation operation.A type of
BinaryRequest that deals with getting or mutating parts of
a JSON document, aka a Sub-Document.Contains various utility methods related to blocking operations.
A wrapper for the IO
Bootstrap class.Marker interface for messages that should be allowed to go through the
RequestHandler, despite no bucket configuration available to check upon.
Describes the bucket capabilities in an abstract fashion as provided by
the server.
Event published when a bucket is closed.
A RuntimeException being thrown whenever an operation on a bucket that
has been closed is attempted.
Represents a Couchbase Bucket Configuration.
An abstraction over the bucket parser which takes a raw config as a string and turns it into a
BucketConfig.Represents the node locator used for the specific bucket type.
Event published when a bucket is opened.
Defines the relationship between a bucket and a service.
Represents the possible bucket types.
Collection of utilities around
ByteBuf.An helper class providing utility methods to deal with parsing of structured
data (like JSON) inside a
ByteBuf buffer.Loads a raw bucket configuration through the carrier mechanism (also commonly referred to as CCCP).
Keeps the bucket config fresh through carrier configuration management.
A
ByteBufProcessor to find a closing character position.Represents a Couchbase Cluster Configuration.
Represents a Couchbase Cluster.
Logger factory which creates an
Apache Commons Logging
logger.
The
ConfigHandler is responsible for encoding ConfigRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.Locates the proper CONFIG node for a given config request.
A
ConfigParserEnvironment interface defines all methods which environment implementation should have
to be injected into configuration parser.Common marker interface for all
ConfigRequests.Event published when a new bucket config is applied to the core.
Implements a
ConnectionString.The
CoreContext contains required assets which are shared on
a per-core basis.A
CoreEnvironment provides all the core building blocks like environment settings and thread pools so
that the application can work with it properly.The Core scheduler which is modeled after the Event Loops Scheduler (which is package private).
A configuration representing the couchbase bucket.
The general implementation of a
ClusterFacade.This hook allows to intercept and modify the
CouchbaseRequest in the
path of the CouchbaseCore.send(CouchbaseRequest) method.Defines the generic couchbase event pushed through the event bus.
Common parent exception to build a proper exception hierachy inside the driver.
Internal-use-only logger used by the SDK.
Creates an
CouchbaseLogger or changes the default factory
implementation.The log level that
CouchbaseLogger can log at.The general implementation of a
Node.Represents the partition information for a bucket.
High-Level marker interface for all
CouchbaseRequests.Request to handle increment/decrement of a counter.
Describes the states of the decoding process.
The default implementation of the
BinaryMemcacheRequest.The default implementation of the
BinaryMemcacheResponse.Default implementation of a
ClusterConfig.**The default implementation of a
ConfigurationProvider.**The default event bus implementation.
The default implementation of a
FullBinaryMemcacheRequest.The default implementation of a
FullBinaryMemcacheResponse.The default implementation for the
LastMemcacheContent.The default configuration for the latency metrics collectors.
The default
MemcacheContent implementation.The default memcache bucket hashing strategy, compatible with 2.x Java SDK.
The default implementation with a builder for the
MetricsCollectorConfig.Default implementation of
NodeInfo.Provides global access to the services of a Jackson
ObjectMapper
with default configuration.The
DefaultOrphanResponseReporter receives requests's of orphan responses
and stores them for aggregation and logging.The builder to configure the
DefaultOrphanResponseReporterThe default implementation of a
ServiceRegistry.Parent class of
Delays and provides factory methods to create them.Marker interface for extended information.
Provides access to various metrics helpful for system diagnosis.
Aggregates the health of all
Endpoints.Disconnects all open buckets.
A response to a
DisconnectRequest.Exception indicating that the document which is observed has been modified in the meantime.
The observed document was lost during a hard failover, because the document did not reach the replica in time.
Represents a stateful
Endpoint which abstracts the underlying channel.Aggregates the health of one specific
Endpoint.Calculates a merged state for all registered endpoints.
The
ErrorMap contains mappings from errors to their attributes, negotiated
between the client and the server.Defines the interface for a generic event bus.
Utility methods for event handling.
Different event types available.
Delay which increases exponentially on every attempt.
The failed channel can be used to create a channel promise when no channel
is available (because it failed).
A
RetryStrategy that will never retry and cancel right away.Represents a observe seqno response.
Delay which is fixed for every attempt.
Sends a flush command to the cluster.
A
BinaryMemcacheRequest that also includes the content.A
BinaryMemcacheResponse that also includes the content.Combines
MemcacheMessage and LastMemcacheContent into one
message.For the lack of a better name, a analytics request against a analytics server.
The base response for Analytics (SQL++) requests.
For the lack of a better name, a query request against a query server.
The base response for Query (N1QL) requests.
Get the current high sequence numbers one could initialize streams
for all partitions that are located on the server, or use in
ObserveViaMutationToken.Represents response to
GetAllMutationTokensRequest.Request which fetches a bucket configuration through carrier publication.
Represents a response with a bucket configuration.
Request to fetch the configuration provider from the core.
Response to fetch the configuration provider from the core.
Fetch a document from the cluster and return it if found.
Represents a response to a
GetRequest.Retrieves full text index definition.
Carries full text index definition as a payload.
Get a user or list of users.
The
HealthPinger allows to "ping" individual services with
real operations for their health.Loads a raw bucket configuration through the Couchbase Server HTTP config interface.
Keeps the bucket config fresh through a HTTP streaming connection.
Insert a document.
Response to an
InsertRequest.Defines the intended audience for each entity.
Intended to be only used within this library.
Intended to be used by any project or application that depends on this library.
Defines the stability annotations for each public or private class.
The annotated entity is considered committed and can only break compatibility at a major release.
The annotated entity is considered experimental and no guarantees can be given in terms of
compatibility and stability.
The annotated entity is considered stable, but compatibility can be broken at each minor release.
Marker interface for all internal
CouchbaseRequests that are potentially treated differently and with
priority.ShutdownHook hook for an EventLoopGroup.Logger factory which creates a
java.util.logging
logger.
Process JSON array
Processes byte order mark.
Processes JSON false value
Processes JSON true value
Processes JSON null value
Process JSON number
Processes JSON object value
Represents a pointer in the JSON tree structure.
Represents a tree structure of stored
JsonPointer.Processes JSON String value
Processes JSON ws
Marker interface to identify a request that handles a keepalive.
A SASL Client which communicates through the memcache binary protocol.
This endpoint defines the pipeline for binary requests and responses.
This handler is added dynamically by the
KeyValueFeatureHandler to load and store the extended
error map from the server.This handler negotiates the enabled features through the HELLO command.
The
KeyValueHandler is responsible for encoding BinaryRequests into lower level
BinaryMemcacheRequests as well as decoding FullBinaryMemcacheResponses into
CouchbaseResponses.A Select bucket handler required for Spock cluster
Allows to configure a KV Service on a per-node basis.
Enum describing all known response status codes that could be seen on the KeyValue protocol.
The
MemcacheContent which signals the end of the content batch.A latency metric value object which contains percentile and other related information.
A collector which collects and emits latency measurements.
Additional configuration for the latency metrics collector.
A common base class for latency metric events.
A class which uniquely identifies a latency metric.
The legacy memcache bucket hashing strategy, compatible with Java SDK 1.x.
**Represents common lifecycle states of components.**
Delay which increases linearly for every attempt.
.
Logger factory which creates an
Apache Log4J
logger.
Consumes
CouchbaseEvents and logs them.The target output format to log.
Enumeration of possible mutations inside a sub-document
LookupCommand.A single lookup description inside a TODO.
Builder for
LookupCommandVarious math utility methods, also backports from later JDK versions.
An Memcache content chunk.
A configuration representing a memcached bucket.
This interface defines different hashing strategies used for ketama hashing in memcached buckets.
Marker interface for both ascii and binary messages.
Defines a common interface for all
MemcacheObject implementations.A generic metrics collector.
A generic configuration for a metrics collector.
The response for a
BinarySubdocMultiLookupRequest.The response for a
BinarySubdocMultiMutationRequest.The result corresponding to an individual
LookupCommand or MutationCommand.Enumeration of possible mutations inside a sub-document
MutationCommand.A single mutation description inside a
BinarySubdocMultiMutationRequest.Builder for
MutationCommand.Value object to contain vbucket UUID and sequence number.
ShutdownHook hook that attempts to terminate Netty threads gracefully.A convenient wrapper class around network primitives in Java.
The collector for core network latencies.
This event represents network latencies captured in the core layer.
The unique identifier for a network latency metric.
Configuration options for
CoreEnvironment.networkResolution().Represents a Couchbase Node.
Event published when a node is connected.
Event published when a node is disconnected.
Represents a observe seqno response.
ShutdownHook hook that does nothing and returns true.Thrown if the stateful component is not connected.
Backport of some utility methods from Java 1.7+
Various utilities to help with
Observables.Utility class to handle observe calls and polling logic.
Defines the possible disk persistence constraints to observe.
Defines the possible replication constraints to observe.
.
Observe through sequence numbers instead of cas.
Utility class to handle observe calls and polling logic.
Document observe through mutation token information.
The
Service is composed of and manages AnalyticsEndpoints.The
QueryService is composed of and manages QueryEndpoints.The
ViewService is composed of and manages ViewEndpoints.Represents mutation metadata which can be inspected after
a mutation and during/after is respective observe poll
cycles.
Selects the
Endpoint based on the information enclosed in the CouchbaseRequest.Contains a report for all the internal service health states.
Represents health for a specific service on ping.
A generic implementation of a service pool.
A
CouchbaseRequest that can be targeted at a specific node through the corresponding
hostname, shortcutting the dispatch usually performed by a
Locator...
This context keeps together a bunch of related information needed to turn a raw
config into a parsed one.
This endpoint defines the pipeline for query requests and responses (N1QL).
The
QueryHandler is responsible for encoding QueryRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.The
QueryHandlerV2 is responsible for encoding QueryRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.The
QueryService is composed of and manages QueryEndpoints.Allows to configure a Query Service on a per-node basis.
A
AnalyticsRequest that can also be prelocated, but expects a
response with the uninterpreted JSON payload returned by the query service.The response to a
RawAnalyticsRequest, which only contains the raw JSON payload returned by
the Analytics service, as a ByteBuf.A
QueryRequest that can also be prelocated, but expects a
response with the uninterpreted JSON payload returned by the query service.The response to a
RawQueryRequest, which only contains the raw JSON payload returned by
the Query service, as a ByteBuf.Represents a logging argument which is subject to redaction.
The type of the redactable argument.
Allows to specify the level of log redaction.
A
Refresher keeps bucket configs up to date.Represents a response to a
RemoveRequest.Removes full text search index.
Result of full text search index removing.
Fetch a document from one or more and/or active nodes replicas.
This exception is thrown when the given operation targeting a specific replica is not fulfillable because the
replica is not available (the node has been failed over or is marked as down).
This exception is thrown when the given operation targeting a specific replica is not fulfillable because the
replica is not configured (for example replica 2 is asked for, but only 1 is configured).
This exception is thrown when there is a problem in the underlying network I/O.
A pre allocated event which carries a
CouchbaseRequest and associated information.A factory to preallocate
RequestEvents.The
RequestHandler is responsible for adding and removing Nodes as well as dispatching
Service management operations.A pre allocated event which carries a
CouchbaseResponse and associated information.A factory to preallocate
ResponseEvents.Typesafe status code returned by
CouchbaseResponses.Helper class to easily convert different handler status types to a common one.
Container for extended response status information.
A generic HTTP request to perform on the cluster REST API port (8091).
Response to a
RestApiRequest.A helper class which contains methods related to retrying operations.
Base interface for all
RetryStrategy implementations.Provides a granular breakdown of the queries in the ringbuffer
Stores diagnostics on the main ringbuffer to provide additional context to BackpressureExceptions.
A
MetricsCollector which collects and emits system information like gc, memory or thread usage.This event contains collected system stats, like GC, Thread and Memory usage.
A wrapper for
Sasl which first tries the mechanisms that are supported
out of the box and then tries our extended range (provided by ShaSaslClient.This endpoint defines the pipeline for search requests and responses (CBFT).
The
SearchHandler is responsible for encoding SearchRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.Round robin node locator for CBFT.
Runs query against search index.
Result of the full text search query.
Common marker interface for all
SearchRequests.Allows to configure a Search Service on a per-node basis.
A
SecureEnvironment interface defines all methods which environment implementation
should have to be accepted by SSLEngineFactory.**Set up the bootstrap nodes for a
ClusterFacade.**
For stability reasons, it is advised to always provide more than one seed node (but not necessarily all nodes from
the cluster) so that the cluster can correctly bootstrap the bucket, even if one of the hosts in the list is
currently not available.**Returns the status of a
SeedNodesRequest.**Interface which defines a generic selection strategy to select a
Endpoint.Features the client negotiates with the server on a per-connection basis.
An event sent by the
KeyValueFeatureHandler to list all the negotiated features.A helper factory which generates endpoints.
Exception which states that the service is not available for the bucket.
Handles the registration of services and their associated buckets.
Calculates a merged state for all registered services.
Represents the different
ServiceTypes and how they map onto buckets.Implementation of a SCRAM-SHA512, SCRAM-SHA256 and SCRAM-SHA1 enabled
SaslClient.The
SaslClientFactory supporting SCRAM-SHA512, SCRAM-SHA256 and SCRAM-SHA1
authentication methods.Interface to describe shutdown behavior for a resource that
can be asynchronously shut down.
A general-purpose response suitable for most "simple" sub-document operations (
BinarySubdocRequest and
BinarySubdocMutationRequest), as opposed to "multi-specification" sub-document operations.Logger factory which creates a SLF4J
logger.
A
ByteBufProcessor to find the position of a single character usable as a split pivot.Creates a
SSLEngine which will be passed into the handler if SSL is enabled.Generic
SSLException.A
MemcachedHashingStrategy which is compatible with libcouchbase and SDKs that
are built on top.Utility class to handle STAT calls logic.
A stateful component that changes its state and notifies subscribed parties.
Describes a generic
StateZipper.A
ByteBufProcessor to find the closing position of a JSON string.A request covering all sub-document array operations (see
SubArrayRequest.ArrayOperation).A sub-document counter operation.
A sub-document delete operation.
A sub-document dictionary add operation.
A sub-document dictionary upsert operation.
A sub-document exist operation.
A sub-document get count operation.
A sub-document get operation.
Document options for
SubMultiLookupRequestConcrete implementation of a
BinarySubdocMultiLookupRequest.Document options for
SubMultiMutationRequestConcrete implementation of a
BinarySubdocMultiMutationRequest.A sub-document replace operation.
Represents a reference from one span to another one.
The
ThresholdLogReporter retrieves spans from (usually) a Tracer
and stores them for threshold-based aggregation and logging.The builder used to configure the
ThresholdLogReporter.ThresholdLogScope is a simple Scope implementation that relies on Java's
thread-local storage primitive, very similar to the one shipped with "opentracing-util".A
ScopeManager implementation built on top of Java's thread-local storage primitive,
very similar to the one shipped with "opentracing-util".Allows to build a
Span in a builder fashion.Holds baggage items for the slow operation spans.
This
Tracer implementation logs operations over a certain threshold based
on the given configuration.Event published when more than one Environments are created.
.
Static factory class for various Tuples.
A container for two values.
A container for three values.
A container for four values.
A container for five values.
This Subject can be used to auto-release reference counted objects when not subscribed before.
Insert or update a document.
Response to an
UpsertRequest.Inserts or updates full text search index definition.
Contains result of the create/update action on full text search index.
This endpoint defines the pipeline for binary requests and responses.
The
ViewHandler is responsible for encoding ViewRequests into lower level
HttpRequests as well as decoding HttpObjects into
CouchbaseResponses.The
ViewService is composed of and manages ViewEndpoints.Allows to configure a View Service on a per-node basis.
Factory to create a new
WaitStrategy when called.This
ByteBufProcessor loops while it encounters whitespace
or new lines (' ', '\t', '\r' and '\n').Analytics query response parser, based on yasjl.
Analytics query response parser, based on yasjl.
A N1QL/Query response parser, based on yasjl.