Class Replication

java.lang.Object

org.lightcouch.Replication

public class Replication
extends Object

This class provides access to the database replication API; a replication request is sent via HTTP POST to _replicate URI.

Usage Example:

ReplicationResult replication = dbClient.replication()
        .source("source-db")
        .target("target-db")
        .createTarget(true)
.filter("example/filter1")
        .trigger();


List<ReplicationHistory> histories = replication.getHistories();

Since:

0.0.2

See Also:

• CouchDbClientBase.replication()
• ReplicationResult
• ReplicationResult.ReplicationHistory
• Replicator

Field Summary

Fields

Modifier and Type	Field	Description
private Boolean	cancel
private String	consumerKey
private String	consumerSecret
private Boolean	continuous
private Boolean	createTarget
private CouchDbClientBase	dbc
private String[]	docIds
private String	filter
(package private) static final org.apache.commons.logging.Log	log
private String	proxy
private com.google.gson.JsonObject	queryParams
private String	sinceSeq
private String	source
private String	target
private com.google.gson.JsonObject	targetOauth
private String	token
private String	tokenSecret

Constructor Summary

Constructors

Constructor	Description
Replication(CouchDbClientBase dbc)

Method Summary

Modifier and Type	Method	Description
private void	addProperty(com.google.gson.JsonObject json, String name, Object value)
Replication	cancel(Boolean cancel)
Replication	continuous(Boolean continuous)
private com.google.gson.JsonObject	createJson()
Replication	createTarget(Boolean createTarget)
Replication	docIds(String... docIds)
Replication	filter(String filter)
Replication	proxy(String proxy)
Replication	queryParams(String queryParams)
Replication	queryParams(Map<String,Object> queryParams)
Replication	sinceSeq(String sinceSeq)	Starts a replication since an update sequence.
Replication	source(String source)
Replication	target(String target)
Replication	targetOauth(String consumerSecret, String consumerKey, String tokenSecret, String token)
ReplicationResult	trigger()	Triggers a replication request.

Methods inherited from class Object

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

Field Details

log

static final org.apache.commons.logging.Log log

source

private String source

target

private String target

cancel

private Boolean cancel

continuous

private Boolean continuous

filter

private String filter

queryParams

private com.google.gson.JsonObject queryParams

docIds

private String[] docIds

proxy

private String proxy

createTarget

private Boolean createTarget

sinceSeq

private String sinceSeq

targetOauth

private com.google.gson.JsonObject targetOauth

consumerSecret

private String consumerSecret

consumerKey

private String consumerKey

tokenSecret

private String tokenSecret

token

private String token

dbc

private CouchDbClientBase dbc

Constructor Details

Replication

public Replication(CouchDbClientBase dbc)

Method Details

trigger

public ReplicationResult trigger()

Triggers a replication request.

Returns:

ReplicationResult

source

public Replication source(String source)

target

public Replication target(String target)

continuous

public Replication continuous(Boolean continuous)

filter

public Replication filter(String filter)

queryParams

public Replication queryParams(String queryParams)

queryParams

public Replication queryParams(Map<String,Object> queryParams)

docIds

public Replication docIds(String... docIds)

proxy

public Replication proxy(String proxy)

cancel

public Replication cancel(Boolean cancel)

createTarget

public Replication createTarget(Boolean createTarget)

sinceSeq

public Replication sinceSeq(String sinceSeq)

Starts a replication since an update sequence.

Parameters:

sinceSeq - The update sequence

Returns:

Replication

targetOauth

public Replication targetOauth(String consumerSecret,
 String consumerKey,
 String tokenSecret,
 String token)

createJson

private com.google.gson.JsonObject createJson()

addProperty

private void addProperty(com.google.gson.JsonObject json,
 String name,
 Object value)