com.couchbase.lite

Class AbstractReplicator

java.lang.Object

com.couchbase.lite.internal.core.InternalReplicator

com.couchbase.lite.AbstractReplicator

Direct Known Subclasses:

Replicator

public abstract class AbstractReplicator
extends InternalReplicator

A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-shot or continuous. The replicator runs asynchronously, so observe the status to be notified of progress.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractReplicator.ActivityLevel Activity level of a replicator.
static class	AbstractReplicator.Progress Progress of a replicator.
static class	AbstractReplicator.Status Combined activity level and progress of a replicator.

Method Summary

Modifier and Type	Method and Description
ListenerToken	addChangeListener(Executor executor, ReplicatorChangeListener listener) Adds a change listener for the changes in the replication status and progress with an executor on which the changes will be posted to the listener.
ListenerToken	addChangeListener(ReplicatorChangeListener listener) Adds a change listener for the changes in the replication status and progress.
ListenerToken	addDocumentReplicationListener(DocumentReplicationListener listener) Adds a listener for receiving the replication status of the specified document.
ListenerToken	addDocumentReplicationListener(Executor executor, DocumentReplicationListener listener) Adds a listener for receiving the replication status of the specified document with an executor on which the status will be posted to the listener.
ReplicatorConfiguration	getConfig() The replicator's configuration.
Set<String>	getPendingDocumentIds() Get a best effort list of documents still pending replication.
List<Certificate>	getServerCertificates() The server certificates received from the server during the TLS handshake.
AbstractReplicator.Status	getStatus() The replicator's current status: its activity level and progress.
boolean	isDocumentPending(String docId) Best effort check to see if the document whose ID is passed is still pending replication.
void	removeChangeListener(ListenerToken token) Remove the given ReplicatorChangeListener or DocumentReplicationListener from the this replicator.
void	resetCheckpoint() Deprecated. Use start(boolean resetCheckpoint) instead.
void	start() Start the replicator.
void	start(boolean resetCheckpoint) Start the replicator.
void	stop() Stop a running replicator.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

start

public void start()

Start the replicator. This method honors the flag set by the deprecated method resetCheckpoint().

start

public void start(boolean resetCheckpoint)

Start the replicator. This method does not wait for the replicator to start. The replicator runs asynchronously and reports its progress through replicator change notifications.

stop

public void stop()

Stop a running replicator. This method does not wait for the replicator to stop. When it does actually stop it will a new state, STOPPED, to change listeners.

getConfig

@NonNull
public ReplicatorConfiguration getConfig()

The replicator's configuration.

Returns:

this replicator's configuration

getStatus

@NonNull
public AbstractReplicator.Status getStatus()

The replicator's current status: its activity level and progress. Observable.

Returns:

this replicator's status

getServerCertificates

@Nullable
public List<Certificate> getServerCertificates()

The server certificates received from the server during the TLS handshake.

Returns:

this replicator's server certificates.

getPendingDocumentIds

@NonNull
public Set<String> getPendingDocumentIds()
                                           throws CouchbaseLiteException

Get a best effort list of documents still pending replication.

Returns:

a set of ids for documents still awaiting replication.

Throws:

CouchbaseLiteException

isDocumentPending

public boolean isDocumentPending(@NonNull
                                 String docId)
                          throws CouchbaseLiteException

Best effort check to see if the document whose ID is passed is still pending replication.

Parameters:

docId - Document id

Returns:

true if the document is pending

Throws:

CouchbaseLiteException

addChangeListener

@NonNull
public ListenerToken addChangeListener(@NonNull
                                                ReplicatorChangeListener listener)

Adds a change listener for the changes in the replication status and progress.

The changes will be delivered on the UI thread for the Android platform On other Java platforms, the callback will occur on an arbitrary thread.

When developing a Java Desktop application using Swing or JavaFX that needs to update the UI after receiving the changes, make sure to schedule the UI update on the UI thread by using SwingUtilities.invokeLater(Runnable) or Platform.runLater(Runnable) respectively.

Parameters:

listener - callback

addChangeListener

@NonNull
public ListenerToken addChangeListener(Executor executor,
                                                @NonNull
                                                ReplicatorChangeListener listener)

Adds a change listener for the changes in the replication status and progress with an executor on which the changes will be posted to the listener. If the executor is not specified, the changes will be delivered on the UI thread on Android platform and on an arbitrary thread on other Java platform.

Parameters:

executor - executor on which events will be delivered

listener - callback

removeChangeListener

public void removeChangeListener(@NonNull
                                 ListenerToken token)

Remove the given ReplicatorChangeListener or DocumentReplicationListener from the this replicator.

Parameters:

token - returned by a previous call to addChangeListener or addDocumentListener.

addDocumentReplicationListener

@NonNull
public ListenerToken addDocumentReplicationListener(@NonNull
                                                             DocumentReplicationListener listener)

Adds a listener for receiving the replication status of the specified document. The status will be delivered on the UI thread for the Android platform and on an arbitrary thread for the Java platform. When developing a Java Desktop application using Swing or JavaFX that needs to update the UI after receiving the status, make sure to schedule the UI update on the UI thread by using SwingUtilities.invokeLater(Runnable) or Platform.runLater(Runnable) respectively.

Parameters:

listener - callback

Returns:

A ListenerToken that can be used to remove the handler in the future.

addDocumentReplicationListener

@NonNull
public ListenerToken addDocumentReplicationListener(@Nullable
                                                             Executor executor,
                                                             @NonNull
                                                             DocumentReplicationListener listener)

Adds a listener for receiving the replication status of the specified document with an executor on which the status will be posted to the listener. If the executor is not specified, the status will be delivered on the UI thread for the Android platform and on an arbitrary thread for the Java platform.

Parameters:

executor - executor on which events will be delivered

listener - callback

resetCheckpoint

@Deprecated
public void resetCheckpoint()

Deprecated. Use start(boolean resetCheckpoint) instead.

This method, exactly, sets a flag that will be used on the next call to the deprecated method start()

Throws:

IllegalStateException - unless the Replicator is STOPPED.

toString

@NonNull
public String toString()

Overrides:

toString in class Object