org.ektorp
Interface ReplicationTask

All Superinterfaces:

ActiveTask

All Known Implementing Classes:

StdReplicationTask

public interface ReplicationTask
extends ActiveTask

Interface for retrieving data about a replication task

Author:

ed wagstaff

Method Summary

long	getCheckpointedSourceSequenceId()
Long	getCheckpointInterval() Defines replication checkpoint interval in milliseconds.
String	getReplicationDocumentId()
String	getReplicationId()
String	getSourceDatabaseName()
long	getSourceSequenceId()
String	getTargetDatabaseName()
long	getTotalMissingRevisions()
long	getTotalReads()
long	getTotalRevisionsChecked()
long	getTotalWrites()
long	getWriteFailures()
boolean	isContinuous()

Methods inherited from interface org.ektorp.ActiveTask

getPid, getProgress, getStartedOn, getUpdatedOn

Method Detail

getReplicationId

String getReplicationId()

Returns:

a unique ID for this replication task which can be used e.g. to cancel an ongoing replication (see http://wiki.apache.org/couchdb/Replication#from_1.2.0_onward)

getReplicationDocumentId

String getReplicationDocumentId()

Returns:

the ID of the document which defines the replication rule being processed by this task

isContinuous

boolean isContinuous()

Returns:

a boolean indicating whether or not the replication rule being processed is continuous

getWriteFailures

long getWriteFailures()

Returns:

the total number of document writes which have failed so far in this task

getTotalReads

long getTotalReads()

Returns:

the total number of document reads so far for this task

getTotalWrites

long getTotalWrites()

Returns:

the total number of successful document writes so far for this task

getTotalMissingRevisions

long getTotalMissingRevisions()

Returns:

the number of documents in the target DB which have been found to be either missing or out of date. This number can be incremented more than once for the same document: for example if a document is updated while a continuous replication rule is active. It won't however be increased by more than 1 if a document is out of date by more than one revision: for example if document X is at revision 3 in Source and revision 1 in Target, this number only increases by 1 when document X is checked.

getTotalRevisionsChecked

long getTotalRevisionsChecked()

Returns:

the number of documents from the source DB whose presence and revision number in the target DB have been checked. This number can be incremented more than once for the same document: for example if a document is updated while a continuous replication rule is active, it will be checked again. It won't however count multiple revisions of the same document each time it's checked: for example if a document is at revision 3 the first time it's checked, this count will still only increase by 1.

getSourceDatabaseName

String getSourceDatabaseName()

Returns:

the name of the source database for this task

getTargetDatabaseName

String getTargetDatabaseName()

Returns:

the name of the target database for this task

getSourceSequenceId

long getSourceSequenceId()

Returns:

the sequence number of the source database

getCheckpointedSourceSequenceId

long getCheckpointedSourceSequenceId()

Returns:

the latest sequence number of the source database which has been processed by this task

getCheckpointInterval

Long getCheckpointInterval()

Defines replication checkpoint interval in milliseconds. Replicator will requests from the Source database at the specified interval