Package com.couchbase.lite

Class ReplicatorConfiguration

java.lang.Object

com.couchbase.lite.internal.BaseReplicatorConfiguration

com.couchbase.lite.AbstractReplicatorConfiguration

com.couchbase.lite.ReplicatorConfiguration

public final class ReplicatorConfiguration
extends AbstractReplicatorConfiguration

Configuration for a Replicator

Nested Class Summary

Nested classes/interfaces inherited from class com.couchbase.lite.AbstractReplicatorConfiguration

AbstractReplicatorConfiguration.ReplicatorType

Field Summary

Fields inherited from class com.couchbase.lite.AbstractReplicatorConfiguration

DISABLE_HEARTBEAT

Fields inherited from class com.couchbase.lite.internal.BaseReplicatorConfiguration

collectionConfigurations

Constructor Summary

Constructors

Constructor	Description
ReplicatorConfiguration(Database database, Endpoint target)	Deprecated. Use ReplicatorConfiguration(java.util.Collection<CollectionConfiguration>, Endpoint) instead.
ReplicatorConfiguration(Endpoint target)	Deprecated. Use ReplicatorConfiguration(java.util.Collection<CollectionConfiguration>, Endpoint) instead.
ReplicatorConfiguration(ReplicatorConfiguration config)	Copy a Replicator Configuration
ReplicatorConfiguration(Collection<CollectionConfiguration> collections, Endpoint target)	Creates a Replicator Configuration with a set of collection configurations and the target endpoint.

Method Summary

Modifier and Type	Method	Description
boolean	isAcceptOnlySelfSignedServerCertificate()	ENTERPRISE EDITION API
ReplicatorConfiguration	setAcceptOnlySelfSignedServerCertificate(boolean selfSignedOnly)	ENTERPRISE EDITION API

Methods inherited from class com.couchbase.lite.AbstractReplicatorConfiguration

addCollection, addCollections, configureDefaultCollection, createCollectionConfigMap, getAuthenticator, getChannels, getCollectionConfigs, getCollectionConfiguration, getCollections, getConflictResolver, getDatabase, getDocumentIDs, getHeaders, getHeartbeat, getMaxAttempts, getMaxAttemptWaitTime, getPinnedServerCertificate, getPinnedServerX509Certificate, getProxyAuthenticator, getPullFilter, getPushFilter, getReplicatorType, getTarget, getType, isAcceptParentDomainCookies, isAutoPurgeEnabled, isContinuous, removeCollection, setAcceptParentDomainCookies, setAuthenticator, setAutoPurgeEnabled, setChannels, setConflictResolver, setContinuous, setDocumentIDs, setHeaders, setHeartbeat, setMaxAttempts, setMaxAttemptWaitTime, setPinnedServerCertificate, setPinnedServerX509Certificate, setProxyAuthenticator, setPullFilter, setPushFilter, setReplicatorType, setType, toString

Methods inherited from class com.couchbase.lite.internal.BaseReplicatorConfiguration

addCollectionInternal, getCollectionConfigurations, removeCollectionInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ReplicatorConfiguration

@Deprecated
public ReplicatorConfiguration(@NonNull
 Database database,
 @NonNull
 Endpoint target)

Deprecated.

Use ReplicatorConfiguration(java.util.Collection<CollectionConfiguration>, Endpoint) instead.

Create a Replicator Configuration for the given database and target endpoint.

When using this constructor, the default collection of the provided database will be automatically included in the configuration.

If you do not intend to replicate the default collection, use ReplicatorConfiguration(java.util.Collection<CollectionConfiguration>, Endpoint) instead.

Parameters:

database - the database to be synchronized

target - the endpoint with which to synchronize it

ReplicatorConfiguration

@Deprecated
public ReplicatorConfiguration(@NonNull
 Endpoint target)

Deprecated.

Use ReplicatorConfiguration(java.util.Collection<CollectionConfiguration>, Endpoint) instead.

Create a Replicator Configuration for the given target endpoint

This constructor does not configure any collections by default. Use AbstractReplicatorConfiguration.addCollection(Collection, CollectionConfiguration) or AbstractReplicatorConfiguration.addCollections(java.util.Collection, CollectionConfiguration) to configure collections to replicate.

Parameters:

target - the target endpoint

ReplicatorConfiguration

public ReplicatorConfiguration(@NonNull
 Collection<CollectionConfiguration> collections,
 @NonNull
 Endpoint target)

Creates a Replicator Configuration with a set of collection configurations and the target endpoint.

Each collection configuration in the specified collections must be created with a collection by using CollectionConfiguration(Collection).

Parameters:

collections - the collections with configurations to replicate

target - the target endpoint

ReplicatorConfiguration

public ReplicatorConfiguration(@NonNull
 ReplicatorConfiguration config)

Copy a Replicator Configuration

Parameters:

config - the config to copy

Method Details

setAcceptOnlySelfSignedServerCertificate

@NonNull
public ReplicatorConfiguration setAcceptOnlySelfSignedServerCertificate(boolean selfSignedOnly)

ENTERPRISE EDITION API

Specify whether the replicator will accept only self-signed certificates. If set true, the replicator will accept any self-signed but NO not self-signed certificates This guards against using this mode accidentally, in production. The default value is false.

Parameters:

selfSignedOnly - Whether the replicator will accept any and only self-signed certificates.

Returns:

this.

isAcceptOnlySelfSignedServerCertificate

public boolean isAcceptOnlySelfSignedServerCertificate()

ENTERPRISE EDITION API

Return whether the replicator will accept any and only self-signed server certificates.