Replication topic

Classes

AsyncReplicator

A Replicator with a primarily asynchronous API.

Authenticator

The authentication credentials for a remote server.

BasicAuthenticator

An authenticator for HTTP Basic (username/password) auth.

Certificate

A X.509 certificate.

CertificateAttributes

The issuer and Subject Alternative Name (SAN) attributes of a Certificate.

Conflict

A conflict between changes in a local and remote Document.

ConflictResolver

An object which is able to resolve a Conflict between the local and remote versions of a replicated Document.

ConnectionStatus

The connection status of an UrlEndpointListener.

CryptoData

Encoded cryptographic data, such as certificates and keys.

DatabaseEndpoint

An endpoint representing a local Database as the replication target.

DerData

DER-encoded cryptographic data.

DocumentReplication

Event which is emitted when Documents have been replicated.

Endpoint

The location of a database to replicate with.

ExternalKeyPairDelegate

KeyPair delegate that implements cryptographic operations without having to expose the underlying private key.

KeyPair

A RSA public-key cryptography key pair.

ListenerAuthenticator

Authenticates peer Replicators connecting to a UrlEndpointListener.

ListenerCertificateAuthenticator

A certificate-based ListenerAuthenticator for a UrlEndpointListener.

ListenerPasswordAuthenticator

A password-based ListenerAuthenticator for a UrlEndpointListener.

OID

An object identifier (OID) for use in X.509 Certificates.

PemData

PEM-encoded cryptographic data.

ReplicatedDocument

Information about a Document that has been replicated.

Replicator

A replicator for replicating Documents between a local database and a target database.

ReplicatorChange

Event which is emitted when the status of a Replicator changes.

ReplicatorConfiguration

Configuration for a Replicator.

ReplicatorProgress

Progress of a Replicator.

ReplicatorStatus

Combined ReplicatorActivityLevel, ReplicatorProgress and possibly error of a Replicator.

SessionAuthenticator

An authenticator using a Couchbase Sync Gateway login session identifier, and optionally a cookie name (pass null for the default.)

SyncReplicator

A Replicator with a primarily synchronous API.

TlsIdentity

TLS identity including a KeyPair and X.509 Certificate chain used for configuring TLS communication for replication.

TypedConflict

A conflict between changes in a local and remote Document, providing typed representations of the documents.

TypedConflictResolver

An object which is able to resolve a TypedConflict between the local and remote versions of a replicated document.

UrlEndpoint

An endpoint representing a server-based database at the given url.

UrlEndpointListener

A listener to provide a Web-Socket based endpoint for peer-to-peer replication.

UrlEndpointListenerConfiguration

The configuration for an UrlEndpointListener.

Enums

DocumentFlag

Flags describing a replicated Document.

KeyUsage

Purpose for which a certified public key may be used.

ReplicatorActivityLevel

The states a Replicator can be in during its lifecycle.

ReplicatorType

Direction of replication: push, pull, or both.

SignatureDigestAlgorithm

Digest algorithm of a RSA signature.

Typedefs

ConflictResolverFunction = FutureOr<Document?> Function(Conflict conflict)

Functional version of ConflictResolver.

ListenerCertificateAuthenticatorFunction = FutureOr<bool> Function(Certificate certificate)

A function that is called to authenticate a client connecting to a UrlEndpointListener using a certificate.

ListenerPasswordAuthenticatorFunction = FutureOr<bool> Function(String username, String password)

Function that is called to authenticate a client connecting to a UrlEndpointListener using an username and password.

ReplicationFilter = FutureOr<bool> Function(Document document, Set<DocumentFlag> flags)

A function that decides whether a particular Document should be pushed/pulled.

TypedConflictResolverFunction = FutureOr<TypedDocumentObject<Object>?> Function(TypedConflict conflict)

Functional version of TypedConflictResolver.

TypedReplicationFilter = FutureOr<bool> Function(TypedDocumentObject<Object> document, Set<DocumentFlag> flags)

A function that decides whether a particular typed document should be pushed/pulled.