AbstractReplicatorConfiguration (Couchbase, Inc. Community Edition License Agreement 3.0.0-beta1)

java.lang.Object
- com.couchbase.lite.AbstractReplicatorConfiguration

Direct Known Subclasses:

ReplicatorConfiguration
```
public abstract class AbstractReplicatorConfiguration
extends Object
```
Replicator configuration.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractReplicatorConfiguration.ReplicatorType
Deprecated.
Use AbstractReplicator.ReplicatorType

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractReplicatorConfiguration.ReplicatorType` Deprecated. Use AbstractReplicator.ReplicatorType

Field Summary

Fields
Modifier and Type Field and Description

static int DISABLE_HEARTBEAT
This is a long time: just under 25 days.

Fields
Modifier and Type	Field and Description
`static int`	`DISABLE_HEARTBEAT` This is a long time: just under 25 days.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.
`int`	`getHeartbeat()` Return the heartbeat interval, in seconds.
`int`	`getMaxAttempts()` Return the max number of retry attempts made after connection failure.
`int`	`getMaxAttemptWaitTime()` Return the max time between retry attempts (exponential backoff).
`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.
`AbstractReplicatorConfiguration.ReplicatorType`	`getReplicatorType()` Deprecated. Use getType()
`Endpoint`	`getTarget()` Return the replication target to replicate with.
`ReplicatorType`	`getType()` Return Replicator type indicating the direction of the replicator.
`boolean`	`isAutoPurgeEnabled()` Enable/disable auto-purge.
`boolean`	`isContinuous()` Return the continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.
`ReplicatorConfiguration`	`setAuthenticator(Authenticator authenticator)` Sets the authenticator to authenticate with a remote target server.
`ReplicatorConfiguration`	`setAutoPurgeEnabled(boolean enabled)` Enable/disable auto-purge.
`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`	`setHeartbeat(int heartbeat)` Set the heartbeat interval, in seconds.
`ReplicatorConfiguration`	`setMaxAttempts(int maxAttempts)` Set the max number of retry attempts made after a connection failure.
`ReplicatorConfiguration`	`setMaxAttemptWaitTime(int maxAttemptWaitTime)` Set the max time between retry attempts (exponential backoff).
`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(AbstractReplicatorConfiguration.ReplicatorType replicatorType)` Deprecated. Use setType(AbstractReplicator.ReplicatorType)
`ReplicatorConfiguration`	`setType(ReplicatorType type)` 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

- Field Detail
  - DISABLE_HEARTBEAT
```
public static final int DISABLE_HEARTBEAT
```
    This is a long time: just under 25 days. This many seconds, however, is just less than Integer.MAX_INT millis, and will fit in the heartbeat property.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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
```
@NonNull
public final ReplicatorConfiguration setConflictResolver(@Nullable
                                                                  ConflictResolver conflictResolver)
```
    Sets the the conflict resolver.
    
    Parameters:
    
    conflictResolver - A conflict resolver.
    
    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(@Nullable
                                                         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(@Nullable
                                                            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
```
@Deprecated
 @NonNull
public final ReplicatorConfiguration setReplicatorType(@NonNull
                                                                             AbstractReplicatorConfiguration.ReplicatorType replicatorType)
```
    Deprecated. Use setType(AbstractReplicator.ReplicatorType)
    
    Old setter for replicator type, indicating the direction of the replicator. The default value is PUSH_AND_PULL which is bi-directional.
    
    Parameters:
    
    replicatorType - The replicator type.
    
    Returns:
    
    this.
  - setType
```
@NonNull
public final ReplicatorConfiguration setType(@NonNull
                                                      ReplicatorType type)
```
    Sets the replicator type indicating the direction of the replicator. The default value is .pushAndPull which is bi-directional.
    
    Parameters:
    
    type - The replicator type.
    
    Returns:
    
    this.
  - setMaxAttempts
```
@NonNull
public final ReplicatorConfiguration setMaxAttempts(int maxAttempts)
```
    Set the max number of retry attempts made after a connection failure. Set to 0 for default values. Set to 1 for no retries.
    
    Parameters:
    
    maxAttempts - max retry attempts
  - setMaxAttemptWaitTime
```
@NonNull
public final ReplicatorConfiguration setMaxAttemptWaitTime(int maxAttemptWaitTime)
```
    Set the max time between retry attempts (exponential backoff). Set to 0 for default values.
    
    Parameters:
    
    maxAttemptWaitTime - max attempt wait time
  - setHeartbeat
```
@NonNull
public final ReplicatorConfiguration setHeartbeat(int heartbeat)
```
    Set the heartbeat interval, in seconds. Set to 0 for default values
    Must be non-negative and less than Integer.MAX_VALUE milliseconds
  - setAutoPurgeEnabled
```
@NonNull
public final ReplicatorConfiguration setAutoPurgeEnabled(boolean enabled)
```
    Enable/disable auto-purge. Default is enabled.
  - 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
```
@Deprecated
 @NonNull
public final AbstractReplicatorConfiguration.ReplicatorType getReplicatorType()
```
    Deprecated. Use getType()
    
    Old getter for Replicator type indicating the direction of the replicator.
  - getType
```
@NonNull
public final ReplicatorType getType()
```
    Return Replicator type indicating the direction of the replicator.
  - getTarget
```
@NonNull
public final Endpoint getTarget()
```
    Return the replication target to replicate with.
  - getMaxAttempts
```
public final int getMaxAttempts()
```
    Return the max number of retry attempts made after connection failure.
  - getMaxAttemptWaitTime
```
public final int getMaxAttemptWaitTime()
```
    Return the max time between retry attempts (exponential backoff).
    
    Returns:
    
    max retry wait time
  - getHeartbeat
```
public final int getHeartbeat()
```
    Return the heartbeat interval, in seconds.
    
    Returns:
    
    heartbeat interval in seconds
  - isAutoPurgeEnabled
```
public final boolean isAutoPurgeEnabled()
```
    Enable/disable auto-purge. Default is enabled.
  - toString
```
@NonNull
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractReplicatorConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISABLE_HEARTBEAT

Method Detail

setAuthenticator

setChannels

setConflictResolver

setContinuous

setDocumentIDs

setHeaders

setPinnedServerCertificate

setPullFilter

setPushFilter

setReplicatorType

setType

setMaxAttempts

setMaxAttemptWaitTime

setHeartbeat

setAutoPurgeEnabled

getAuthenticator

getChannels

getConflictResolver

isContinuous

getDatabase

getDocumentIDs

getHeaders

getPinnedServerCertificate

getPullFilter

getPushFilter

getReplicatorType

getType

getTarget

getMaxAttempts

getMaxAttemptWaitTime

getHeartbeat

isAutoPurgeEnabled

toString