com.cloudant.client.api

Class Replicator

java.lang.Object

com.cloudant.client.api.Replicator

public class Replicator
extends java.lang.Object

This class provides access to the _replicator database introduced in CouchDB version 1.1.0

A replication is triggered by persisting a document, and cancelled by removing the document that triggered the replication.

Usage Example:

 
 // first get a client instance
 CloudantClient client = ClientBuilder.account("my-cloudant-account").
   username("username").
   password("password").
   build();

 // create a replicator doc
 Response response = client.replicator()
 	.source("source-db")
 	.target("target-db")
 	.continuous(true)
 	.createTarget(true)
 	.replicatorDB("replicator-db-name") // optional, defaults to _replicator
 	.replicatorDocId("doc-id")          // optional, defaults to UUID
 	.save(); // trigger replication

 // find an existing replicator doc
 ReplicatorDocument replicatorDoc = client.replicator()
 	.replicatorDocId("doc-id")
 	.replicatorDocRev("doc-rev") // optional
 	.find();

 // get all replicator docs
 List<ReplicatorDocument> replicatorDocs = client.replicator().findAll();

 // delete a replicator doc
 Response response = client.replicator()
 	.replicatorDocId("doc-id")
 	.replicatorDocRev("doc-rev")
 	.remove(); // cancels a replication
 
 

Since:

0.0.1

See Also:

CloudantClient.replicator(), Replication, ReplicatorDocument

Method Summary

Modifier and Type	Method and Description
Replicator	connectionTimeout(long connectionTimeout)
Replicator	continuous(boolean continuous)
Replicator	createTarget(java.lang.Boolean createTarget)
Replicator	docIds(java.lang.String... docIds)
Replicator	filter(java.lang.String filter)
ReplicatorDocument	find() Finds a document in the replicator database.
java.util.List<ReplicatorDocument>	findAll() Finds all documents in the replicator database.
Replicator	httpConnections(int httpConnections)
Replicator	proxy(java.lang.String proxy)
Replicator	queryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams)
Replicator	queryParams(java.lang.String queryParams)
Response	remove() Removes a document from the replicator database.
Replicator	replicatorDB(java.lang.String replicatorDB)
Replicator	replicatorDocId(java.lang.String replicatorDocId)
Replicator	replicatorDocRev(java.lang.String replicatorDocRev)
Replicator	retriesPerRequest(int retriesPerRequest)
Response	save() Adds a new document to the replicator database.
Replicator	sinceSeq(java.lang.Integer sinceSeq)
Replicator	source(java.lang.String source)
Replicator	sourceIamApiKey(java.lang.String iamApiKey)
Replicator	target(java.lang.String target)
Replicator	targetIamApiKey(java.lang.String iamApiKey)
Replicator	userCtxName(java.lang.String userCtxName)
Replicator	userCtxRoles(java.lang.String... userCtxRoles)
Replicator	workerBatchSize(int workerBatchSize)
Replicator	workerProcesses(int workerProcesses)

Methods inherited from class java.lang.Object

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

Method Detail

save

public Response save()

Adds a new document to the replicator database.

Returns:

Response

find

public ReplicatorDocument find()

Finds a document in the replicator database.

Returns:

ReplicatorDocument

findAll

public java.util.List<ReplicatorDocument> findAll()

Finds all documents in the replicator database.

Returns:

the list of ReplicatorDocuments

remove

public Response remove()

Removes a document from the replicator database.

Returns:

Response

source

public Replicator source(java.lang.String source)

target

public Replicator target(java.lang.String target)

continuous

public Replicator continuous(boolean continuous)

filter

public Replicator filter(java.lang.String filter)

queryParams

public Replicator queryParams(java.lang.String queryParams)

queryParams

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

docIds

public Replicator docIds(java.lang.String... docIds)

proxy

public Replicator proxy(java.lang.String proxy)

createTarget

public Replicator createTarget(java.lang.Boolean createTarget)

workerProcesses

public Replicator workerProcesses(int workerProcesses)

connectionTimeout

public Replicator connectionTimeout(long connectionTimeout)

replicatorDB

public Replicator replicatorDB(java.lang.String replicatorDB)

replicatorDocId

public Replicator replicatorDocId(java.lang.String replicatorDocId)

replicatorDocRev

public Replicator replicatorDocRev(java.lang.String replicatorDocRev)

workerBatchSize

public Replicator workerBatchSize(int workerBatchSize)

httpConnections

public Replicator httpConnections(int httpConnections)

retriesPerRequest

public Replicator retriesPerRequest(int retriesPerRequest)

userCtxRoles

public Replicator userCtxRoles(java.lang.String... userCtxRoles)

sinceSeq

public Replicator sinceSeq(java.lang.Integer sinceSeq)

userCtxName

public Replicator userCtxName(java.lang.String userCtxName)

sourceIamApiKey

public Replicator sourceIamApiKey(java.lang.String iamApiKey)

targetIamApiKey

public Replicator targetIamApiKey(java.lang.String iamApiKey)