com.couchbase.lite

Class ReplicatorConfiguration

java.lang.Object

com.couchbase.lite.ReplicatorConfiguration

public final class ReplicatorConfiguration
extends Object

Replicator configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplicatorConfiguration.ReplicatorType Replicator type PUSH_AND_PULL: Bidirectional; both push and pull PUSH: Pushing changes to the target PULL: Pulling changes from the target

Constructor Summary

Constructors

Constructor and Description
ReplicatorConfiguration(Database database, Endpoint target)
ReplicatorConfiguration(ReplicatorConfiguration config)

Method Summary

Modifier and Type	Method and Description
Authenticator	getAuthenticator() Return the Authenticator to authenticate with a remote target.
List<String>	getChannels() A set of Sync Gateway channel names to pull from.
ConflictResolver	getConflictResolver() The conflict resolver for this replicator.
Database	getDatabase() Return the local database to replicate with the replication target.
List<String>	getDocumentIDs() A set of document IDs to filter by: if not nil, only documents with these IDs will be pushed and/or pulled.
Map<String,String>	getHeaders() Return Extra HTTP headers to send in all requests to the remote target.
byte[]	getPinnedServerCertificate() Return the remote target's SSL certificate.
ReplicatorConfiguration.ReplicatorType	getReplicatorType() Return Replicator type indicating the direction of the replicator.
Endpoint	getTarget() Return the replication target to replicate with.
boolean	isContinuous() Return the continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.
ReplicatorConfiguration	setAuthenticator(Authenticator authenticator) Sets the authenticator to authenticate with a remote target server.
ReplicatorConfiguration	setChannels(List<String> channels) Sets a set of Sync Gateway channel names to pull from.
ReplicatorConfiguration	setConflictResolver(ConflictResolver conflictResolver) Sets the custom conflict resolver for this replicator.
ReplicatorConfiguration	setContinuous(boolean continuous) Sets whether the replicator stays active indefinitely to replicate changed documents.
ReplicatorConfiguration	setDocumentIDs(List<String> documentIDs) Sets a set of document IDs to filter by: if given, only documents with these IDs will be pushed and/or pulled.
ReplicatorConfiguration	setHeaders(Map<String,String> headers) Sets the extra HTTP headers to send in all requests to the remote target.
ReplicatorConfiguration	setPinnedServerCertificate(byte[] pinnedServerCertificate) Sets the target server's SSL certificate.
ReplicatorConfiguration	setReplicatorType(ReplicatorConfiguration.ReplicatorType replicatorType) Sets the replicator type indicating the direction of the replicator.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplicatorConfiguration

public ReplicatorConfiguration(ReplicatorConfiguration config)

ReplicatorConfiguration

public ReplicatorConfiguration(Database database,
                               Endpoint target)

Method Detail

setReplicatorType

public ReplicatorConfiguration setReplicatorType(ReplicatorConfiguration.ReplicatorType replicatorType)

Sets the replicator type indicating the direction of the replicator. The default value is .pushAndPull which is bidrectional.

Parameters:

replicatorType - The replicator type.

Returns:

The self object.

setContinuous

public ReplicatorConfiguration setContinuous(boolean continuous)

Sets whether the replicator stays active indefinitely to replicate changed documents. The default value is false, which means that the replicator will stop after it finishes replicating the changed documents.

Parameters:

continuous - The continuous flag.

Returns:

The self object.

setConflictResolver

public ReplicatorConfiguration setConflictResolver(ConflictResolver conflictResolver)

Sets the custom conflict resolver for this replicator. Without setting the conflict resolver, CouchbaseLite will use the default conflict resolver.

Parameters:

conflictResolver - The conflict resolver.

Returns:

The self object.

setAuthenticator

public ReplicatorConfiguration setAuthenticator(Authenticator authenticator)

Sets the authenticator to authenticate with a remote target server. Currently there are two types of the authenticators, BasicAuthenticator and SessionAuthenticator, supported.

Parameters:

authenticator - The authenticator.

Returns:

The self object.

setPinnedServerCertificate

public ReplicatorConfiguration setPinnedServerCertificate(byte[] pinnedServerCertificate)

Sets the target server's SSL certificate.

Parameters:

pinnedServerCertificate - the SSL certificate.

Returns:

The self object.

setHeaders

public ReplicatorConfiguration setHeaders(Map<String,String> headers)

Sets the extra HTTP headers to send in all requests to the remote target.

Parameters:

headers - The HTTP Headers.

Returns:

The self object.

setChannels

public ReplicatorConfiguration setChannels(List<String> channels)

Sets a set of Sync Gateway channel names to pull from. Ignored for push replication. If unset, all accessible channels will be pulled. Note: channels that are not accessible to the user will be ignored by Sync Gateway.

Parameters:

channels - The Sync Gateway channel names.

Returns:

The self object.

setDocumentIDs

public ReplicatorConfiguration setDocumentIDs(List<String> documentIDs)

Sets a set of document IDs to filter by: if given, only documents with these IDs will be pushed and/or pulled.

Parameters:

documentIDs - The document IDs.

Returns:

The self object.

getDatabase

public Database getDatabase()

Return the local database to replicate with the replication target.

getTarget

public Endpoint getTarget()

Return the replication target to replicate with.

getReplicatorType

public ReplicatorConfiguration.ReplicatorType getReplicatorType()

Return Replicator type indicating the direction of the replicator.

isContinuous

public boolean isContinuous()

Return the continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.

getConflictResolver

public ConflictResolver getConflictResolver()

The conflict resolver for this replicator.

getAuthenticator

public Authenticator getAuthenticator()

Return the Authenticator to authenticate with a remote target.

getPinnedServerCertificate

public byte[] getPinnedServerCertificate()

Return the remote target's SSL certificate.

getHeaders

public Map<String,String> getHeaders()

Return Extra HTTP headers to send in all requests to the remote target.

getChannels

public List<String> getChannels()

A set of Sync Gateway channel names to pull from. Ignored for push replication. The default value is null, meaning that all accessible channels will be pulled. Note: channels that are not accessible to the user will be ignored by Sync Gateway.

getDocumentIDs

public List<String> getDocumentIDs()

A set of document IDs to filter by: if not nil, only documents with these IDs will be pushed and/or pulled.