com.couchbase.lite.replicator

Class PullerInternal

java.lang.Object

com.couchbase.lite.replicator.PullerInternal

All Implemented Interfaces:

ChangeTrackerClient, BlockingQueueListener

public class PullerInternal
extends java.lang.Object
implements ChangeTrackerClient

Pull Replication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	com.couchbase.lite.replicator.ReplicationInternal.ChangeListener A delegate that can be used to listen for Replication changes.
protected static class	com.couchbase.lite.replicator.ReplicationInternal.ChangeListenerNotifyStyle

Nested classes/interfaces inherited from interface com.couchbase.lite.support.BlockingQueueListener

BlockingQueueListener.EventType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	authenticating
protected Authenticator	authenticator
protected Batcher<RevisionInternal>	batcher
protected java.util.List<RevisionInternal>	bulkRevsToPull
static java.lang.String	BY_CHANNEL_FILTER_NAME
protected java.lang.Boolean	canBulkGet
protected java.util.Map<java.util.concurrent.Future,CancellableRunnable>	cancellables
static int	CHANGE_TRACKER_RESTART_DELAY_MS
protected com.couchbase.lite.replicator.ReplicationInternal.ChangeListenerNotifyStyle	changeListenerNotifyStyle
protected java.util.concurrent.atomic.AtomicInteger	changesCount
static java.lang.String	CHANNELS_QUERY_PARAM
protected HttpClientFactory	clientFactory
protected java.util.concurrent.atomic.AtomicInteger	completedChangesCount
protected Database	db
protected java.util.List<RevisionInternal>	deletedRevsToPull
protected java.util.List<java.lang.String>	documentIDs
protected Batcher<RevisionInternal>	downloadsToInsert
protected java.util.concurrent.ScheduledExecutorService	executor
static int	EXECUTOR_THREAD_POOL_SIZE
protected java.lang.String	filterName
protected java.util.Map<java.lang.String,java.lang.Object>	filterParams
protected int	httpConnectionCount
protected static int	INBOX_CAPACITY
protected java.lang.String	lastSequence
protected Replication.Lifecycle	lifecycle
protected java.lang.Object	lockWaitForPendingFutures
static int	MAX_NUMBER_OF_ATTS_SINCE
static int	MAX_PENDING_DOCS
static int	MAX_REVS_TO_GET_IN_BULK
static int	MIN_EXECUTOR_THREAD_POOL_SIZE
protected Replication	parentReplication
protected java.util.concurrent.BlockingQueue<java.util.concurrent.Future>	pendingFutures
protected SequenceMap	pendingSequences
protected static int	PROCESSOR_DELAY
protected java.util.concurrent.atomic.AtomicLong	queuedMemorySize
protected java.net.URL	remote
protected java.util.Map<java.lang.String,java.lang.Object>	remoteCheckpoint
protected java.util.concurrent.ScheduledExecutorService	remoteRequestExecutor
protected java.util.Map<java.lang.String,java.lang.Object>	requestHeaders
static int	RETRY_DELAY_SECONDS
protected CollectionUtils.Functor<RevisionInternal,RevisionInternal>	revisionBodyTransformationBlock
protected java.util.List<RevisionInternal>	revsToPull
protected java.lang.String	sessionID
protected <any>	stateMachine
static java.lang.String	SYNC_GATEWAY_PREFIX
protected boolean	waitingForPendingFutures

Constructor Summary

Constructors

Constructor and Description
PullerInternal(Database db, java.net.URL remote, HttpClientFactory clientFactory, Replication.Lifecycle lifecycle, Replication parentReplication)

Method Summary

Modifier and Type	Method and Description
protected void	addToChangesCount(int delta)
protected void	addToCompletedChangesCount(int delta)
void	addToInbox(RevisionInternal rev)
protected void	beginReplicating() Actual work of starting the replication process.
protected java.lang.String	buildRelativeURLString(java.lang.String relativePath)
boolean	canSendCompressedRequests() gzip in CBL_Replicator.m - (BOOL) canSendCompressedRequests
void	changed(BlockingQueueListener.EventType type, java.lang.Object o, java.util.concurrent.BlockingQueue queue) Implementation of BlockingQueueListener.changed(EventType, Object, BlockingQueue) for Pull Replication Note: Pull replication needs to send IDLE after PUT /{db}/_local.
void	changeTrackerCaughtUp()
void	changeTrackerFinished(ChangeTracker tracker)
void	changeTrackerReceivedChange(java.util.Map<java.lang.String,java.lang.Object> change)
void	changeTrackerStopped(ChangeTracker tracker)
protected void	checkSession()
protected void	checkSessionAtPath(java.lang.String sessionPath)
protected void	close() Close all resources associated with this replicator.
ReplicationFilter	compilePushReplicationFilter() Get replicator filter.
void	deleteCookie(java.lang.String name) For java docs, see Replication.deleteCookie()
protected static java.lang.String	encodeDocumentId(java.lang.String docId) Encodes the given document id for use in an URI.
void	fetchRemoteCheckpointDoc()
protected void	finalize()
protected void	fireTrigger(com.couchbase.lite.replicator.ReplicationTrigger trigger) Fire a trigger to the state machine
Authenticator	getAuthenticator()
java.util.concurrent.atomic.AtomicInteger	getChangesCount()
java.util.List<java.lang.String>	getChannels() For javadocs, see Replication object
protected HttpClientFactory	getClientFactory()
java.util.concurrent.atomic.AtomicInteger	getCompletedChangesCount()
java.util.List<java.lang.String>	getDocIds() Gets the documents to specify as part of the replication.
java.lang.String	getFilter() For javadocs, see Replication
java.util.Map<java.lang.String,java.lang.Object>	getFilterParams() For javadoc, see Replication
java.util.Map<java.lang.String,java.lang.Object>	getHeaders() Extra HTTP headers to send in all requests to the remote server.
java.lang.String	getLastSequence()
Replication.Lifecycle	getLifecycle()
protected Database	getLocalDatabase() Get the local database which is the source or target of this replication
OkHttpClient	getOkHttpClient()
java.lang.String	getRemoteUUID() Get the remoteUUID representing the remote server.
java.lang.String	getSessionID()
protected void	goOffline() Take the replication offline
protected void	goOnline() Put the replication back online after being offline
protected void	initAuthorizer()
protected void	initBatcher()
protected java.util.concurrent.ScheduledExecutorService	initializeReplicationExecutor()
protected void	initializeRequestWorkers()
protected void	initializeStateMachine() Initialize the state machine which defines the overall behavior of the replication object.
void	insertDownloads(java.util.List<RevisionInternal> downloads) This will be called when _revsToInsert fills up:
boolean	isContinuous() Should the replication operate continuously, copying changes as soon as the source database is modified? (Defaults to NO).
protected boolean	isNetworkReachable()
boolean	isPull() Is this a pull replication? (Eg, it pulls data from Sync Gateway -> Device running CBL?)
protected boolean	isRunning()
static java.lang.String	joinQuotedEscaped(java.util.List<java.lang.String> strings)
protected void	login()
protected void	maybeCreateRemoteDB()
protected void	onBeforeScheduleRetry() If sub-class of ReplicationInternal needs to do additional steps before scheduling retry, you need to implement in onBeforeScheduleRetry(); https://github.com/couchbase/couchbase-lite-java-core/issues/1149
protected void	pauseOrResume()
protected void	processChangeTrackerChange(java.util.Map<java.lang.String,java.lang.Object> change) in CBL_Puller.m - (void) changeTrackerReceivedSequence: (id)remoteSequenceID docID: (NSString*)docID revIDs: (NSArray*)revIDs deleted: (BOOL)deleted
protected void	processInbox(RevisionList inbox) Process a bunch of remote revisions from the _changes feed at once
protected void	pullBulkRevisions(java.util.List<RevisionInternal> bulkRevs)
protected void	pullBulkWithAllDocs(java.util.List<RevisionInternal> bulkRevs)
void	pullRemoteRevision(RevisionInternal rev) Fetches the contents of a revision from the remote db, including its parent revision ID.
void	pullRemoteRevisions() Start up some HTTP GETs, within our limit on the maximum simultaneous number The entire method is not synchronized, only the portion pulling work off the list Important to not hold the synchronized block while we do network access
protected void	queueRemoteRevision(RevisionInternal rev) Add a revision to the appropriate queue of revs to individually GET
java.lang.String	remoteCheckpointDocID() This is the _local document ID stored on the remote server to keep track of state.
java.lang.String	remoteCheckpointDocID(java.lang.String localUUID)
protected void	retry() Called after a continuous replication has gone idle, but it failed to transfer some revisions and so wants to try again in a minute.
protected void	retryIfReady() in CBL_Replicator.m - (void) retryIfReady
protected void	retryReplicationIfError() Retry replication if previous attempt ends with error
void	saveLastSequence() in CBL_Replicator.m - (void) saveLastSequence
CustomFuture	sendAsyncMultipartDownloaderRequest(java.lang.String method, java.lang.String relativePath, java.util.Map<java.lang.String,java.lang.Object> body, Database db, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncMultipartRequest(java.lang.String method, java.lang.String relativePath, java.util.Map<java.lang.String,java.lang.Object> body, java.util.Map<java.lang.String,java.lang.Object> attachments, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncRequest(java.lang.String method, java.lang.String relativePath, boolean cancelable, java.util.Map<java.lang.String,?> body, boolean dontLog404, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncRequest(java.lang.String method, java.lang.String relativePath, boolean cancelable, java.util.Map<java.lang.String,?> body, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncRequest(java.lang.String method, java.lang.String relativePath, java.util.Map<java.lang.String,?> body, boolean dontLog404, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncRequest(java.lang.String method, java.lang.String relativePath, java.util.Map<java.lang.String,?> body, RemoteRequestCompletion onCompletion)
CustomFuture	sendAsyncRequest(java.lang.String method, java.net.URL url, boolean cancelable, java.util.Map<java.lang.String,?> body, boolean dontLog404, RemoteRequestCompletion onCompletion)
protected boolean	serverIsSyncGateway()
protected boolean	serverIsSyncGatewayVersion(java.lang.String minVersion)
protected static boolean	serverIsSyncGatewayVersion(java.lang.String serverName, java.lang.String minVersion)
void	setAuthenticator(Authenticator authenticator)
void	setChannels(java.util.List<java.lang.String> channels) For javadocs, see Replication object
void	setCookie(Cookie cookie)
void	setCookie(java.lang.String name, java.lang.String value, java.lang.String path, java.util.Date expirationDate, boolean secure, boolean httpOnly) For java docs, see Replication.setCookie()
void	setCookie(java.lang.String name, java.lang.String value, java.lang.String path, long maxAge, boolean secure, boolean httpOnly) For java docs, see Replication.setCookie()
void	setCreateTarget(boolean createTarget)
void	setDocIds(java.util.List<java.lang.String> docIds) Sets the documents to specify as part of the replication.
protected void	setError(java.lang.Throwable throwable)
void	setFilter(java.lang.String filterName) Set the filter to be used by this replication
void	setFilterParams(java.util.Map<java.lang.String,java.lang.Object> filterParams) Set parameters to pass to the filter function.
void	setHeaders(java.util.Map<java.lang.String,java.lang.Object> requestHeadersParam) Set Extra HTTP headers to be sent in all requests to the remote server.
void	setLastSequence(java.lang.String lastSequenceIn) in CBL_Replicator.m - (void) setLastSequence:(NSString*)lastSequence;
protected void	setLastSequenceFromWorkExecutor(java.lang.String lastSequence, java.lang.String checkpointId)
void	setLifecycle(Replication.Lifecycle lifecycle)
void	setRemoteUUID(java.lang.String remoteUUID) Set the remoteUUID representing the remote server.
protected void	setServerType(java.lang.String serverType)
boolean	shouldCreateTarget()
protected void	start() Start the replication process.
protected void	startChangeTracker()
protected void	startNetworkReachabilityManager()
protected static Status	statusFromBulkDocsResponseItem(java.util.Map<java.lang.String,java.lang.Object> item)
protected void	stop() Actual work of stopping the replication process.
protected void	stopNetworkReachabilityManager()
java.lang.String	toString()
protected RevisionInternal	transformRevision(RevisionInternal rev)
void	triggerGoOffline() Trigger this replication to go offline (async)
void	triggerGoOnline() Trigger this replication to go online (async)
void	triggerStart() Trigger this replication to start (async)
void	triggerStopGraceful() Trigger this replication to stop (async)
protected void	triggerStopImmediate() Trigger this replication to stop immediately -- assumes pending work has been drained, or that caller chooses to ignore any pending work.
protected void	waitBatcherCompleted()
protected static void	waitBatcherCompleted(Batcher<RevisionInternal> b)
protected void	waitDownloadsToInsertBatcherCompleted()
protected void	waitForAllTasksCompleted()
protected void	waitForPendingFutures()
protected void	waitPendingFuturesCompleted()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REVS_TO_GET_IN_BULK

public static final int MAX_REVS_TO_GET_IN_BULK

See Also:

Constant Field Values

MAX_NUMBER_OF_ATTS_SINCE

public static final int MAX_NUMBER_OF_ATTS_SINCE

See Also:

Constant Field Values

CHANGE_TRACKER_RESTART_DELAY_MS

public static int CHANGE_TRACKER_RESTART_DELAY_MS

MAX_PENDING_DOCS

public static final int MAX_PENDING_DOCS

See Also:

Constant Field Values

pendingSequences

protected SequenceMap pendingSequences

canBulkGet

protected java.lang.Boolean canBulkGet

revsToPull

protected java.util.List<RevisionInternal> revsToPull

bulkRevsToPull

protected java.util.List<RevisionInternal> bulkRevsToPull

deletedRevsToPull

protected java.util.List<RevisionInternal> deletedRevsToPull

httpConnectionCount

protected int httpConnectionCount

downloadsToInsert

protected Batcher<RevisionInternal> downloadsToInsert

queuedMemorySize

protected java.util.concurrent.atomic.AtomicLong queuedMemorySize

BY_CHANNEL_FILTER_NAME

public static final java.lang.String BY_CHANNEL_FILTER_NAME

See Also:

Constant Field Values

CHANNELS_QUERY_PARAM

public static final java.lang.String CHANNELS_QUERY_PARAM

See Also:

Constant Field Values

EXECUTOR_THREAD_POOL_SIZE

public static final int EXECUTOR_THREAD_POOL_SIZE

See Also:

Constant Field Values

MIN_EXECUTOR_THREAD_POOL_SIZE

public static final int MIN_EXECUTOR_THREAD_POOL_SIZE

See Also:

Constant Field Values

SYNC_GATEWAY_PREFIX

public static final java.lang.String SYNC_GATEWAY_PREFIX

See Also:

Constant Field Values

RETRY_DELAY_SECONDS

public static int RETRY_DELAY_SECONDS

parentReplication

protected Replication parentReplication

db

protected Database db

remote

protected java.net.URL remote

clientFactory

protected HttpClientFactory clientFactory

lastSequence

protected java.lang.String lastSequence

authenticator

protected Authenticator authenticator

authenticating

protected boolean authenticating

filterName

protected java.lang.String filterName

filterParams

protected java.util.Map<java.lang.String,java.lang.Object> filterParams

documentIDs

protected java.util.List<java.lang.String> documentIDs

requestHeaders

protected java.util.Map<java.lang.String,java.lang.Object> requestHeaders

batcher

protected Batcher<RevisionInternal> batcher

PROCESSOR_DELAY

protected static int PROCESSOR_DELAY

INBOX_CAPACITY

protected static int INBOX_CAPACITY

remoteRequestExecutor

protected java.util.concurrent.ScheduledExecutorService remoteRequestExecutor

remoteCheckpoint

protected java.util.Map<java.lang.String,java.lang.Object> remoteCheckpoint

completedChangesCount

protected java.util.concurrent.atomic.AtomicInteger completedChangesCount

changesCount

protected java.util.concurrent.atomic.AtomicInteger changesCount

revisionBodyTransformationBlock

protected CollectionUtils.Functor<RevisionInternal,RevisionInternal> revisionBodyTransformationBlock

sessionID

protected java.lang.String sessionID

pendingFutures

protected java.util.concurrent.BlockingQueue<java.util.concurrent.Future> pendingFutures

cancellables

protected java.util.Map<java.util.concurrent.Future,CancellableRunnable> cancellables

executor

protected java.util.concurrent.ScheduledExecutorService executor

stateMachine

protected <any> stateMachine

lifecycle

protected Replication.Lifecycle lifecycle

changeListenerNotifyStyle

protected com.couchbase.lite.replicator.ReplicationInternal.ChangeListenerNotifyStyle changeListenerNotifyStyle

waitingForPendingFutures

protected boolean waitingForPendingFutures

lockWaitForPendingFutures

protected final java.lang.Object lockWaitForPendingFutures

Constructor Detail

PullerInternal

public PullerInternal(Database db,
                      java.net.URL remote,
                      HttpClientFactory clientFactory,
                      Replication.Lifecycle lifecycle,
                      Replication parentReplication)

Method Detail

beginReplicating

protected void beginReplicating()

Actual work of starting the replication process.

onBeforeScheduleRetry

protected void onBeforeScheduleRetry()

If sub-class of ReplicationInternal needs to do additional steps before scheduling retry, you need to implement in onBeforeScheduleRetry(); https://github.com/couchbase/couchbase-lite-java-core/issues/1149

isPull

public boolean isPull()

Is this a pull replication? (Eg, it pulls data from Sync Gateway -> Device running CBL?)

maybeCreateRemoteDB

protected void maybeCreateRemoteDB()

startChangeTracker

protected void startChangeTracker()

processInbox

protected void processInbox(RevisionList inbox)

Process a bunch of remote revisions from the _changes feed at once

pullRemoteRevisions

public void pullRemoteRevisions()

Start up some HTTP GETs, within our limit on the maximum simultaneous number

The entire method is not synchronized, only the portion pulling work off the list Important to not hold the synchronized block while we do network access

pullBulkRevisions

protected void pullBulkRevisions(java.util.List<RevisionInternal> bulkRevs)

pullBulkWithAllDocs

protected void pullBulkWithAllDocs(java.util.List<RevisionInternal> bulkRevs)

insertDownloads

public void insertDownloads(java.util.List<RevisionInternal> downloads)

This will be called when _revsToInsert fills up:

pullRemoteRevision

public void pullRemoteRevision(RevisionInternal rev)

Fetches the contents of a revision from the remote db, including its parent revision ID. The contents are stored into rev.properties.

joinQuotedEscaped

public static java.lang.String joinQuotedEscaped(java.util.List<java.lang.String> strings)

queueRemoteRevision

protected void queueRemoteRevision(RevisionInternal rev)

Add a revision to the appropriate queue of revs to individually GET

getLastSequence

public java.lang.String getLastSequence()

getOkHttpClient

public OkHttpClient getOkHttpClient()

Specified by:

getOkHttpClient in interface ChangeTrackerClient

changeTrackerReceivedChange

public void changeTrackerReceivedChange(java.util.Map<java.lang.String,java.lang.Object> change)

Specified by:

changeTrackerReceivedChange in interface ChangeTrackerClient

changeTrackerStopped

public void changeTrackerStopped(ChangeTracker tracker)

Specified by:

changeTrackerStopped in interface ChangeTrackerClient

changeTrackerFinished

public void changeTrackerFinished(ChangeTracker tracker)

Specified by:

changeTrackerFinished in interface ChangeTrackerClient

changeTrackerCaughtUp

public void changeTrackerCaughtUp()

Specified by:

changeTrackerCaughtUp in interface ChangeTrackerClient

processChangeTrackerChange

protected void processChangeTrackerChange(java.util.Map<java.lang.String,java.lang.Object> change)

in CBL_Puller.m - (void) changeTrackerReceivedSequence: (id)remoteSequenceID docID: (NSString*)docID revIDs: (NSArray*)revIDs deleted: (BOOL)deleted

changed

public void changed(BlockingQueueListener.EventType type,
                    java.lang.Object o,
                    java.util.concurrent.BlockingQueue queue)

Implementation of BlockingQueueListener.changed(EventType, Object, BlockingQueue) for Pull Replication

Note: Pull replication needs to send IDLE after PUT /{db}/_local. However sending IDLE from Push replicator breaks few unit test cases. This is reason changed() method was override for pull replication

Specified by:

changed in interface BlockingQueueListener

stop

protected void stop()

Actual work of stopping the replication process.

waitForAllTasksCompleted

protected void waitForAllTasksCompleted()

waitDownloadsToInsertBatcherCompleted

protected void waitDownloadsToInsertBatcherCompleted()

shouldCreateTarget

public boolean shouldCreateTarget()

setCreateTarget

public void setCreateTarget(boolean createTarget)

goOffline

protected void goOffline()

Take the replication offline

pauseOrResume

protected void pauseOrResume()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

triggerStart

public void triggerStart()

Trigger this replication to start (async)

triggerStopGraceful

public void triggerStopGraceful()

Trigger this replication to stop (async)

triggerGoOffline

public void triggerGoOffline()

Trigger this replication to go offline (async)

triggerGoOnline

public void triggerGoOnline()

Trigger this replication to go online (async)

fireTrigger

protected void fireTrigger(com.couchbase.lite.replicator.ReplicationTrigger trigger)

Fire a trigger to the state machine

triggerStopImmediate

protected void triggerStopImmediate()

Trigger this replication to stop immediately -- assumes pending work has been drained, or that caller chooses to ignore any pending work.

start

protected void start()

Start the replication process.

goOnline

protected void goOnline()

Put the replication back online after being offline

close

protected void close()

Close all resources associated with this replicator.

initAuthorizer

protected void initAuthorizer()

initBatcher

protected void initBatcher()

startNetworkReachabilityManager

protected void startNetworkReachabilityManager()

stopNetworkReachabilityManager

protected void stopNetworkReachabilityManager()

isNetworkReachable

protected boolean isNetworkReachable()

initializeReplicationExecutor

protected java.util.concurrent.ScheduledExecutorService initializeReplicationExecutor()

initializeRequestWorkers

protected void initializeRequestWorkers()

checkSession

protected void checkSession()

checkSessionAtPath

protected void checkSessionAtPath(java.lang.String sessionPath)

login

protected void login()

setError

protected void setError(java.lang.Throwable throwable)

addToCompletedChangesCount

protected void addToCompletedChangesCount(int delta)

addToChangesCount

protected void addToChangesCount(int delta)

getCompletedChangesCount

public java.util.concurrent.atomic.AtomicInteger getCompletedChangesCount()

getChangesCount

public java.util.concurrent.atomic.AtomicInteger getChangesCount()

sendAsyncRequest

public CustomFuture sendAsyncRequest(java.lang.String method,
                                     java.lang.String relativePath,
                                     java.util.Map<java.lang.String,?> body,
                                     RemoteRequestCompletion onCompletion)

sendAsyncRequest

public CustomFuture sendAsyncRequest(java.lang.String method,
                                     java.lang.String relativePath,
                                     boolean cancelable,
                                     java.util.Map<java.lang.String,?> body,
                                     RemoteRequestCompletion onCompletion)

sendAsyncRequest

public CustomFuture sendAsyncRequest(java.lang.String method,
                                     java.lang.String relativePath,
                                     java.util.Map<java.lang.String,?> body,
                                     boolean dontLog404,
                                     RemoteRequestCompletion onCompletion)

sendAsyncRequest

public CustomFuture sendAsyncRequest(java.lang.String method,
                                     java.lang.String relativePath,
                                     boolean cancelable,
                                     java.util.Map<java.lang.String,?> body,
                                     boolean dontLog404,
                                     RemoteRequestCompletion onCompletion)

sendAsyncRequest

public CustomFuture sendAsyncRequest(java.lang.String method,
                                     java.net.URL url,
                                     boolean cancelable,
                                     java.util.Map<java.lang.String,?> body,
                                     boolean dontLog404,
                                     RemoteRequestCompletion onCompletion)

sendAsyncMultipartRequest

public CustomFuture sendAsyncMultipartRequest(java.lang.String method,
                                              java.lang.String relativePath,
                                              java.util.Map<java.lang.String,java.lang.Object> body,
                                              java.util.Map<java.lang.String,java.lang.Object> attachments,
                                              RemoteRequestCompletion onCompletion)

sendAsyncMultipartDownloaderRequest

public CustomFuture sendAsyncMultipartDownloaderRequest(java.lang.String method,
                                                        java.lang.String relativePath,
                                                        java.util.Map<java.lang.String,java.lang.Object> body,
                                                        Database db,
                                                        RemoteRequestCompletion onCompletion)

getLocalDatabase

protected Database getLocalDatabase()

Get the local database which is the source or target of this replication

getHeaders

public java.util.Map<java.lang.String,java.lang.Object> getHeaders()

Extra HTTP headers to send in all requests to the remote server. Should map strings (header names) to strings.

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.Object> requestHeadersParam)

Set Extra HTTP headers to be sent in all requests to the remote server.

saveLastSequence

public void saveLastSequence()

in CBL_Replicator.m - (void) saveLastSequence

setLastSequenceFromWorkExecutor

protected void setLastSequenceFromWorkExecutor(java.lang.String lastSequence,
                                               java.lang.String checkpointId)

buildRelativeURLString

protected java.lang.String buildRelativeURLString(java.lang.String relativePath)

fetchRemoteCheckpointDoc

public void fetchRemoteCheckpointDoc()

remoteCheckpointDocID

public java.lang.String remoteCheckpointDocID()

This is the _local document ID stored on the remote server to keep track of state. Its ID is based on the local database ID (the private one, to make the result unguessable) and the remote database's URL.

remoteCheckpointDocID

public java.lang.String remoteCheckpointDocID(java.lang.String localUUID)

getFilter

public java.lang.String getFilter()

For javadocs, see Replication

setFilter

public void setFilter(java.lang.String filterName)

Set the filter to be used by this replication

compilePushReplicationFilter

public ReplicationFilter compilePushReplicationFilter()

Get replicator filter. If the replicator is a pull replicator, calling this method will return null.

This is equivalent to CBL_ReplicatorSettings's compilePushFilterForDatabase:status:.

getDocIds

public java.util.List<java.lang.String> getDocIds()

Gets the documents to specify as part of the replication.

setDocIds

public void setDocIds(java.util.List<java.lang.String> docIds)

Sets the documents to specify as part of the replication.

isContinuous

public boolean isContinuous()

Should the replication operate continuously, copying changes as soon as the source database is modified? (Defaults to NO).

getFilterParams

public java.util.Map<java.lang.String,java.lang.Object> getFilterParams()

For javadoc, see Replication

setFilterParams

public void setFilterParams(java.util.Map<java.lang.String,java.lang.Object> filterParams)

Set parameters to pass to the filter function.

getRemoteUUID

public java.lang.String getRemoteUUID()

Get the remoteUUID representing the remote server.

setRemoteUUID

public void setRemoteUUID(java.lang.String remoteUUID)

Set the remoteUUID representing the remote server.

canSendCompressedRequests

public boolean canSendCompressedRequests()

gzip

in CBL_Replicator.m - (BOOL) canSendCompressedRequests

initializeStateMachine

protected void initializeStateMachine()

Initialize the state machine which defines the overall behavior of the replication object.

getAuthenticator

public Authenticator getAuthenticator()

setAuthenticator

public void setAuthenticator(Authenticator authenticator)

serverIsSyncGatewayVersion

protected boolean serverIsSyncGatewayVersion(java.lang.String minVersion)

serverIsSyncGateway

protected boolean serverIsSyncGateway()

serverIsSyncGatewayVersion

protected static boolean serverIsSyncGatewayVersion(java.lang.String serverName,
                                                    java.lang.String minVersion)

addToInbox

public void addToInbox(RevisionInternal rev)

retry

protected void retry()

Called after a continuous replication has gone idle, but it failed to transfer some revisions and so wants to try again in a minute. Can be overridden by subclasses.

in CBL_Replicator.m - (void) retry

retryIfReady

protected void retryIfReady()

in CBL_Replicator.m - (void) retryIfReady

retryReplicationIfError

protected void retryReplicationIfError()

Retry replication if previous attempt ends with error

setServerType

protected void setServerType(java.lang.String serverType)

getLifecycle

public Replication.Lifecycle getLifecycle()

setLifecycle

public void setLifecycle(Replication.Lifecycle lifecycle)

setLastSequence

public void setLastSequence(java.lang.String lastSequenceIn)

in CBL_Replicator.m - (void) setLastSequence:(NSString*)lastSequence;

transformRevision

protected RevisionInternal transformRevision(RevisionInternal rev)

statusFromBulkDocsResponseItem

protected static Status statusFromBulkDocsResponseItem(java.util.Map<java.lang.String,java.lang.Object> item)

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.String path,
                      long maxAge,
                      boolean secure,
                      boolean httpOnly)

For java docs, see Replication.setCookie()

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.String path,
                      java.util.Date expirationDate,
                      boolean secure,
                      boolean httpOnly)

For java docs, see Replication.setCookie()

setCookie

public void setCookie(Cookie cookie)

deleteCookie

public void deleteCookie(java.lang.String name)

For java docs, see Replication.deleteCookie()

getClientFactory

protected HttpClientFactory getClientFactory()

getChannels

public java.util.List<java.lang.String> getChannels()

For javadocs, see Replication object

setChannels

public void setChannels(java.util.List<java.lang.String> channels)

For javadocs, see Replication object

getSessionID

public java.lang.String getSessionID()

encodeDocumentId

protected static java.lang.String encodeDocumentId(java.lang.String docId)

Encodes the given document id for use in an URI.

Avoids encoding the slash in _design documents since it may cause a 301 redirect.

isRunning

protected boolean isRunning()

waitForPendingFutures

protected void waitForPendingFutures()

waitBatcherCompleted

protected void waitBatcherCompleted()

waitBatcherCompleted

protected static void waitBatcherCompleted(Batcher<RevisionInternal> b)

waitPendingFuturesCompleted

protected void waitPendingFuturesCompleted()