Replication (couchbase-lite-java-core API)

java.lang.Object
- com.couchbase.lite.replicator.Replication

All Implemented Interfaces:

NetworkReachabilityListener, com.couchbase.lite.replicator.ReplicationInternal.ChangeListener
```
public class Replication
extends java.lang.Object
implements com.couchbase.lite.replicator.ReplicationInternal.ChangeListener, NetworkReachabilityListener
```
The external facade for the Replication API

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Replication.ChangeEvent` The type of event raised by a Replication when any of the following properties change: mode, running, error, completed, total.
`static interface`	`Replication.ChangeListener` A delegate that can be used to listen for Replication changes.
`static class`	`Replication.Direction` Enum to specify which direction this replication is going (eg, push vs pull)
`static class`	`Replication.Lifecycle` Enum to specify whether this replication is oneshot or continuous.
`static class`	`Replication.ReplicationField`
`static class`	`Replication.ReplicationStatus` Options for what metadata to include in document bodies

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpClientFactory`	`clientFactory`
`protected Database`	`db`
`static int`	`DEFAULT_HEARTBEAT`
`static long`	`DEFAULT_MAX_TIMEOUT_FOR_SHUTDOWN`
`protected Replication.Direction`	`direction`
`protected java.lang.Throwable`	`lastError`
`protected Replication.Lifecycle`	`lifecycle`
`protected java.net.URL`	`remote`
`protected com.couchbase.lite.replicator.ReplicationInternal`	`replicationInternal`
`static java.lang.String`	`REPLICATOR_DATABASE_NAME`

Constructor Summary

Constructors
Constructor and Description
`Replication(Database db, java.net.URL remote, Replication.Direction direction)` Constructor
`Replication(Database db, java.net.URL remote, Replication.Direction direction, HttpClientFactory factory)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(Replication.ChangeListener changeListener)` Adds a change delegate that will be called whenever the Replication changes.
`protected java.lang.String`	`buildRelativeURLString(java.lang.String relativePath)`
`void`	`changed(Replication.ChangeEvent event)` This is called back for changes from the ReplicationInternal.
`boolean`	`clearAuthenticationStores()` Deletes any persistent credentials (passwords, auth tokens...) associated with this replication's CBLAuthenticator.
`void`	`deleteCookie(java.lang.String name)` Deletes an HTTP cookie for the Replication.
`Authenticator`	`getAuthenticator()` Get the Authenticator used for authenticating with the Sync Gateway
`int`	`getChangesCount()` The total number of changes to be processed, if the task is active, else 0 (observable).
`java.util.List<java.lang.String>`	`getChannels()` List of Sync Gateway channel names to filter by; a nil value means no filtering, i.e.
`protected HttpClientFactory`	`getClientFactory()`
`int`	`getCompletedChangesCount()` The number of completed changes processed, if the task is active, else 0 (observable).
`java.util.List<java.lang.String>`	`getDocIds()` Gets the documents to specify as part of the replication.
`java.lang.String`	`getFilter()` Name of an optional filter function to run on the source server.
`java.util.Map<java.lang.String,java.lang.Object>`	`getFilterParams()` Parameters to pass to the filter function.
`java.util.Map<java.lang.String,java.lang.Object>`	`getHeaders()` Extra HTTP headers to send in all requests to the remote server.
`java.lang.Throwable`	`getLastError()` The error status of the replication, or null if there have not been any errors since it started.
`Database`	`getLocalDatabase()` Get the local database which is the source or target of this replication
`java.util.Set<java.lang.String>`	`getPendingDocumentIDs()`
`java.net.URL`	`getRemoteUrl()` Get the remote URL which is the source or target of this replication
`java.lang.String`	`getRemoteUUID()` Get the remote UUID representing the remote server.
`java.lang.String`	`getSessionID()`
`Replication.ReplicationStatus`	`getStatus()` The replication's current state, one of {stopped, offline, idle, active}.
`java.lang.String`	`getUsername()` The server user name that the authenticator has logged in as, if known.
`void`	`goOffline()` Tell the replication to go offline, asynchronously.
`void`	`goOnline()` Tell the replication to go online, asynchronously.
`boolean`	`isContinuous()` Is this replication continous?
`boolean`	`isDocumentPending(Document doc)`
`boolean`	`isPull()` Is this a pull replication? (Eg, it pulls data from Sync Gateway -> Device running CBL?)
`boolean`	`isRunning()` True while the replication is running, False if it's stopped.
`void`	`networkReachable()`
`void`	`networkUnreachable()`
`java.lang.String`	`remoteCheckpointDocID()` Following two methods for temporary methods instead of CBL_ReplicatorSettings implementation.
`void`	`removeChangeListener(Replication.ChangeListener changeListener)` Removes the specified delegate as a listener for the Replication change event.
`void`	`restart()` Restarts the replication.
`protected boolean`	`serverIsSyncGatewayVersion(java.lang.String minVersion)`
`void`	`setAuthenticator(Authenticator authenticator)` Set the Authenticator used for authenticating with the Sync Gateway
`void`	`setChannels(java.util.List<java.lang.String> channels)` Set the list of Sync Gateway channel names
`protected void`	`setClientFactory(HttpClientFactory factory)` Set the HTTP client factory if one was passed in, or use the default set in the manager if available.
`void`	`setContinuous(boolean isContinous)` Set whether this replication is continous
`void`	`setCookie(java.lang.String name, java.lang.String value, java.lang.String path, java.util.Date expirationDate, boolean secure, boolean httpOnly)` Sets an HTTP cookie for the Replication.
`void`	`setCookie(java.lang.String name, java.lang.String value, java.lang.String path, long maxAge, boolean secure, boolean httpOnly)` Sets an HTTP cookie for the Replication.
`void`	`setCreateTarget(boolean createTarget)` Set whether the target database be created if it doesn't already exist?
`void`	`setDocIds(java.util.List<java.lang.String> docIds)` Sets the documents to specify as part of the replication.
`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.
`protected void`	`setLastError(java.lang.Throwable lastError)` Update the lastError
`void`	`setRemoteUUID(java.lang.String remoteUUID)` Set the remote UUID representing the remote server.
`protected void`	`setServerType(java.lang.String serverType)`
`boolean`	`shouldCreateTarget()` Should the target database be created if it doesn't already exist? (Defaults to NO).
`void`	`start()` Starts the replication, asynchronously.
`void`	`stop()` Stops the replication, asynchronously.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - REPLICATOR_DATABASE_NAME
```
public static final java.lang.String REPLICATOR_DATABASE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_TIMEOUT_FOR_SHUTDOWN
```
public static long DEFAULT_MAX_TIMEOUT_FOR_SHUTDOWN
```
  - DEFAULT_HEARTBEAT
```
public static int DEFAULT_HEARTBEAT
```
  - db
```
protected Database db
```
  - remote
```
protected java.net.URL remote
```
  - clientFactory
```
protected HttpClientFactory clientFactory
```
  - replicationInternal
```
protected com.couchbase.lite.replicator.ReplicationInternal replicationInternal
```
  - lifecycle
```
protected Replication.Lifecycle lifecycle
```
  - lastError
```
protected java.lang.Throwable lastError
```
  - direction
```
protected Replication.Direction direction
```
- Constructor Detail
  - Replication
```
public Replication(Database db,
                   java.net.URL remote,
                   Replication.Direction direction)
```
    Constructor
  - Replication
```
public Replication(Database db,
                   java.net.URL remote,
                   Replication.Direction direction,
                   HttpClientFactory factory)
```
    Constructor
- Method Detail
  - start
```
public void start()
```
    Starts the replication, asynchronously.
  - restart
```
public void restart()
```
    Restarts the replication. This blocks until the replication successfully stops.
    Alternatively, you can stop() the replication and create a brand new one and start() it.
  - goOffline
```
public void goOffline()
```
    Tell the replication to go offline, asynchronously.
  - goOnline
```
public void goOnline()
```
    Tell the replication to go online, asynchronously.
  - isRunning
```
public boolean isRunning()
```
    True while the replication is running, False if it's stopped. Note that a continuous replication never actually stops; it only goes idle waiting for new data to appear.
  - stop
```
public void stop()
```
    Stops the replication, asynchronously.
  - isContinuous
```
public boolean isContinuous()
```
    Is this replication continous?
  - setContinuous
```
public void setContinuous(boolean isContinous)
```
    Set whether this replication is continous
  - setAuthenticator
```
public void setAuthenticator(Authenticator authenticator)
```
    Set the Authenticator used for authenticating with the Sync Gateway
  - getAuthenticator
```
public Authenticator getAuthenticator()
```
    Get the Authenticator used for authenticating with the Sync Gateway
  - shouldCreateTarget
```
public boolean shouldCreateTarget()
```
    Should the target database be created if it doesn't already exist? (Defaults to NO).
  - setCreateTarget
```
public void setCreateTarget(boolean createTarget)
```
    Set whether the target database be created if it doesn't already exist?
  - addChangeListener
```
public void addChangeListener(Replication.ChangeListener changeListener)
```
    Adds a change delegate that will be called whenever the Replication changes.
  - removeChangeListener
```
public void removeChangeListener(Replication.ChangeListener changeListener)
```
    Removes the specified delegate as a listener for the Replication change event.
  - getStatus
```
public Replication.ReplicationStatus getStatus()
```
    The replication's current state, one of {stopped, offline, idle, active}.
  - changed
```
public void changed(Replication.ChangeEvent event)
```
    This is called back for changes from the ReplicationInternal. Simply propagate the events back to all listeners.
    
    Specified by:
    
    changed in interface com.couchbase.lite.replicator.ReplicationInternal.ChangeListener
  - getLastError
```
public java.lang.Throwable getLastError()
```
    The error status of the replication, or null if there have not been any errors since it started.
  - getCompletedChangesCount
```
public int getCompletedChangesCount()
```
    The number of completed changes processed, if the task is active, else 0 (observable).
  - getChangesCount
```
public int getChangesCount()
```
    The total number of changes to be processed, if the task is active, else 0 (observable).
  - setLastError
```
protected void setLastError(java.lang.Throwable lastError)
```
    Update the lastError
  - remoteCheckpointDocID
```
public java.lang.String remoteCheckpointDocID()
```
    Following two methods for temporary methods instead of CBL_ReplicatorSettings implementation.
  - getPendingDocumentIDs
```
public java.util.Set<java.lang.String> getPendingDocumentIDs()
```
  - isDocumentPending
```
public boolean isDocumentPending(Document doc)
```
  - setClientFactory
```
protected void setClientFactory(HttpClientFactory factory)
```
    Set the HTTP client factory if one was passed in, or use the default set in the manager if available.
    
    Parameters:
    
    factory -
  - serverIsSyncGatewayVersion
```
protected boolean serverIsSyncGatewayVersion(java.lang.String minVersion)
```
  - setServerType
```
protected void setServerType(java.lang.String serverType)
```
  - setFilter
```
public void setFilter(java.lang.String filterName)
```
    Set the filter to be used by this replication
  - setDocIds
```
public void setDocIds(java.util.List<java.lang.String> docIds)
```
    Sets the documents to specify as part of the replication.
  - getDocIds
```
public java.util.List<java.lang.String> getDocIds()
```
    Gets the documents to specify as part of the replication.
  - setFilterParams
```
public void setFilterParams(java.util.Map<java.lang.String,java.lang.Object> filterParams)
```
    Set parameters to pass to the filter function.
  - getUsername
```
public java.lang.String getUsername()
```
    The server user name that the authenticator has logged in as, if known.
  - setCookie
```
public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.String path,
                      long maxAge,
                      boolean secure,
                      boolean httpOnly)
```
    Sets an HTTP cookie for the Replication.
    
    Parameters:
    
    name - The name of the cookie.
    
    value - The value of the cookie.
    
    path - The path attribute of the cookie. If null or empty, will use remote.getPath()
    
    maxAge - The maxAge, in milliseconds, that this cookie should be valid for.
    
    secure - Whether the cookie should only be sent using a secure protocol (e.g. HTTPS).
    
    httpOnly - (ignored) Whether the cookie should only be used when transmitting HTTP, or HTTPS, requests thus restricting access from other, non-HTTP APIs.
  - setCookie
```
public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.lang.String path,
                      java.util.Date expirationDate,
                      boolean secure,
                      boolean httpOnly)
```
    Sets an HTTP cookie for the Replication.
    
    Parameters:
    
    name - The name of the cookie.
    
    value - The value of the cookie.
    
    path - The path attribute of the cookie. If null or empty, will use remote.getPath()
    
    expirationDate - The expiration date of the cookie.
    
    secure - Whether the cookie should only be sent using a secure protocol (e.g. HTTPS).
    
    httpOnly - (ignored) Whether the cookie should only be used when transmitting HTTP, or HTTPS, requests thus restricting access from other, non-HTTP APIs.
  - deleteCookie
```
public void deleteCookie(java.lang.String name)
```
    Deletes an HTTP cookie for the Replication.
    
    Parameters:
    
    name - The name of the cookie.
  - clearAuthenticationStores
```
public boolean clearAuthenticationStores()
```
    Deletes any persistent credentials (passwords, auth tokens...) associated with this replication's CBLAuthenticator. Also removes session cookies from the cookie store.
  - getRemoteUUID
```
public java.lang.String getRemoteUUID()
```
    Get the remote UUID representing the remote server.
  - setRemoteUUID
```
public void setRemoteUUID(java.lang.String remoteUUID)
```
    Set the remote UUID representing the remote server.
    In some cases, especially Peer-to-peer replication, the remote or target database might not have a fixed URL - The hostname or IP address or port could change. As a result, URL couldn't be used to represent the remote database when persistently identifying the replication. In such cases, set a remote unique identifier to represent the remote database.
    
    Parameters:
    
    remoteUUID - remote unique identifier
  - getClientFactory
```
protected HttpClientFactory getClientFactory()
```
  - buildRelativeURLString
```
protected java.lang.String buildRelativeURLString(java.lang.String relativePath)
```
  - getChannels
```
public java.util.List<java.lang.String> getChannels()
```
    List of Sync Gateway channel names to filter by; a nil value means no filtering, i.e. all available channels will be synced. Only valid for pull replications whose source database is on a Couchbase Sync Gateway server. (This is a convenience that just reads or changes the values of .filter and .query_params.)
  - setChannels
```
public void setChannels(java.util.List<java.lang.String> channels)
```
    Set the list of Sync Gateway channel names
  - getFilter
```
public java.lang.String getFilter()
```
    Name of an optional filter function to run on the source server. Only documents for which the function returns true are replicated.
    For a pull replication, the name looks like "designdocname/filtername". For a push replication, use the name under which you registered the filter with the Database.
  - getFilterParams
```
public java.util.Map<java.lang.String,java.lang.Object> getFilterParams()
```
    Parameters to pass to the filter function. Should map strings 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.
  - 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.
  - getSessionID
```
public java.lang.String getSessionID()
```
  - getLocalDatabase
```
public Database getLocalDatabase()
```
    Get the local database which is the source or target of this replication
  - getRemoteUrl
```
public java.net.URL getRemoteUrl()
```
    Get the remote URL which is the source or target of this replication
  - isPull
```
public boolean isPull()
```
    Is this a pull replication? (Eg, it pulls data from Sync Gateway -> Device running CBL?)
  - networkReachable
```
public void networkReachable()
```
    Specified by:
    
    networkReachable in interface NetworkReachabilityListener
  - networkUnreachable
```
public void networkUnreachable()
```
    Specified by:
    
    networkUnreachable in interface NetworkReachabilityListener
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Replication

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REPLICATOR_DATABASE_NAME

DEFAULT_MAX_TIMEOUT_FOR_SHUTDOWN

DEFAULT_HEARTBEAT

db

remote

clientFactory

replicationInternal

lifecycle

lastError

direction

Constructor Detail

Replication

Replication

Method Detail

start

restart

goOffline

goOnline

isRunning

stop

isContinuous

setContinuous

setAuthenticator

getAuthenticator

shouldCreateTarget

setCreateTarget

addChangeListener

removeChangeListener

getStatus

changed

getLastError

getCompletedChangesCount

getChangesCount

setLastError

remoteCheckpointDocID

getPendingDocumentIDs

isDocumentPending

setClientFactory

serverIsSyncGatewayVersion

setServerType

setFilter

setDocIds

getDocIds

setFilterParams

getUsername

setCookie

setCookie

deleteCookie

clearAuthenticationStores

getRemoteUUID

setRemoteUUID

getClientFactory

buildRelativeURLString

getChannels

setChannels

getFilter

getFilterParams

setHeaders

getHeaders

getSessionID

getLocalDatabase

getRemoteUrl

isPull

networkReachable

networkUnreachable

toString