com.couchbase.lite

Class ReplicatorConfiguration

java.lang.Object

com.couchbase.lite.ReplicatorConfiguration

public final class ReplicatorConfiguration
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	com.couchbase.lite.AbstractReplicatorConfiguration.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() Return the conflict resolver.
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.
ReplicationFilter	getPullFilter() Gets a filter object for validating whether the documents can be pulled from the remote endpoint.
ReplicationFilter	getPushFilter() Gets a filter object for validating whether the documents can be pushed to the remote endpoint.
com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType	getReplicatorType() Return Replicator type indicating the direction of the replicator.
Endpoint	getTarget() Return the replication target to replicate with.
boolean	isAcceptOnlySelfSignedServerCertificate() Return whether the replicator will accept any and only self-signed server certificates.
boolean	isContinuous() Return the continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.
ReplicatorConfiguration	setAcceptOnlySelfSignedServerCertificate(boolean acceptOnlySelfSignedServerCertificate) Specify whether the replicator will accept any and only self-signed certificates.
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 the conflict resolver.
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[] pinnedCert) Sets the target server's SSL certificate.
ReplicatorConfiguration	setPullFilter(ReplicationFilter pullFilter) Sets a filter object for validating whether the documents can be pulled from the remote endpoint.
ReplicatorConfiguration	setPushFilter(ReplicationFilter pushFilter) Sets a filter object for validating whether the documents can be pushed to the remote endpoint.
ReplicatorConfiguration	setReplicatorType(com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType replicatorType) Sets the replicator type indicating the direction of the replicator.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicatorConfiguration

public ReplicatorConfiguration(@NonNull
                               ReplicatorConfiguration config)

ReplicatorConfiguration

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

Method Detail

setAcceptOnlySelfSignedServerCertificate

@NonNull
public ReplicatorConfiguration setAcceptOnlySelfSignedServerCertificate(boolean acceptOnlySelfSignedServerCertificate)

Specify whether the replicator will accept any and only self-signed certificates. Any non-self-signed certificates will be rejected to avoid accidentally using this mode with the non-self-signed certs in production. The default value is false.

Parameters:

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

Returns:

this.

isAcceptOnlySelfSignedServerCertificate

@NonNull
public boolean isAcceptOnlySelfSignedServerCertificate()

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

setAuthenticator

@NonNull
public final ReplicatorConfiguration setAuthenticator(@NonNull
                                                               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:

this.

setChannels

@NonNull
public final ReplicatorConfiguration setChannels(@Nullable
                                                          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:

this.

setConflictResolver

@Nullable
public final ReplicatorConfiguration setConflictResolver(@Nullable
                                                                   ConflictResolver conflictResolver)

Sets the the conflict resolver.

Parameters:

conflictResolver - The replicator type.

Returns:

this.

setContinuous

@NonNull
public final 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:

this.

setDocumentIDs

@NonNull
public final ReplicatorConfiguration setDocumentIDs(@Nullable
                                                             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:

this.

setHeaders

@NonNull
public final ReplicatorConfiguration setHeaders(@NonNull
                                                         Map<String,String> headers)

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

Parameters:

headers - The HTTP Headers.

Returns:

this.

setPinnedServerCertificate

@NonNull
public final ReplicatorConfiguration setPinnedServerCertificate(@Nullable
                                                                         byte[] pinnedCert)

Sets the target server's SSL certificate.

Parameters:

pinnedCert - the SSL certificate.

Returns:

this.

setPullFilter

@NonNull
public final ReplicatorConfiguration setPullFilter(@Nullable
                                                            ReplicationFilter pullFilter)

Sets a filter object for validating whether the documents can be pulled from the remote endpoint. Only documents for which the object returns true are replicated.

Parameters:

pullFilter - The filter to filter the document to be pulled.

Returns:

this.

setPushFilter

@NonNull
public final ReplicatorConfiguration setPushFilter(ReplicationFilter pushFilter)

Sets a filter object for validating whether the documents can be pushed to the remote endpoint.

Parameters:

pushFilter - The filter to filter the document to be pushed.

Returns:

this.

setReplicatorType

@NonNull
public final ReplicatorConfiguration setReplicatorType(@NonNull
                                                                com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType replicatorType)

Sets the replicator type indicating the direction of the replicator. The default value is .pushAndPull which is bi-directional.

Parameters:

replicatorType - The replicator type.

Returns:

this.

getAuthenticator

@Nullable
public final Authenticator getAuthenticator()

Return the Authenticator to authenticate with a remote target.

getChannels

@Nullable
public final 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.

getConflictResolver

@Nullable
public final ConflictResolver getConflictResolver()

Return the conflict resolver.

isContinuous

public final boolean isContinuous()

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

getDatabase

@NonNull
public final Database getDatabase()

Return the local database to replicate with the replication target.

getDocumentIDs

@Nullable
public final 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.

getHeaders

@Nullable
public final Map<String,String> getHeaders()

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

getPinnedServerCertificate

@Nullable
public final byte[] getPinnedServerCertificate()

Return the remote target's SSL certificate.

getPullFilter

@Nullable
public final ReplicationFilter getPullFilter()

Gets a filter object for validating whether the documents can be pulled from the remote endpoint.

getPushFilter

@Nullable
public final ReplicationFilter getPushFilter()

Gets a filter object for validating whether the documents can be pushed to the remote endpoint.

getReplicatorType

@NonNull
public final com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType getReplicatorType()

Return Replicator type indicating the direction of the replicator.

getTarget

@NonNull
public final Endpoint getTarget()

Return the replication target to replicate with.

toString

@NonNull
public String toString()

Overrides:

toString in class Object