main.java.com.cloudant.client.api.Replication Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudant-client Show documentation
Official Cloudant client for Java
There is a newer version: 2.20.1
package com.cloudant.client.api;

import java.util.Map;

import org.lightcouch.ReplicationResult;
import org.lightcouch.ReplicationResult.ReplicationHistory;
import org.lightcouch.Replicator;

/**
 * This class provides access to the database replication API; a replication request 
 * is sent via HTTP POST to _replicate URI.
 * 
 * Usage Example:
 *  * ReplicationResult replication = db.replication()
 * 	.source("source-db")
 * 	.target("target-db")
 * 	.createTarget(true)
 *	.filter("example/filter1")
 * 	.trigger();
 * 
 * {@code
 * List histories = replication.getHistories();
 * }
 * 
 * 
 * @see CloudantClient#replication()
 * @see ReplicationResult
 * @see ReplicationHistory
 * @see Replicator
 * @since 0.0.1
 * @author Ganesh K Choudhary
 *
 */
public class Replication {
	private org.lightcouch.Replication replication ;
	
	/*public Replication(CouchDbClientBase client) {
		this.replication = new org.lightcouch.Replication(client);
	}*/
	
	Replication(org.lightcouch.Replication replication){
		this.replication = replication ;
	}

	/**
	 * Triggers a replication request. 
	 */
	public com.cloudant.client.api.model.ReplicationResult trigger() {
		ReplicationResult couchDbReplicationResult = replication.trigger();
		com.cloudant.client.api.model.ReplicationResult replicationResult = new com.cloudant.client.api.model.ReplicationResult(couchDbReplicationResult);
		return replicationResult ;
	}

	/**
	 * @param source
	 * @return
	 */
	public Replication source(String source) {
		this.replication = replication.source(source);
		return this ;
	}

	/**
	 * @param target
	 * @return
	 */
	public Replication target(String target) {
		 this.replication = replication.target(target);
		 return this ;
	}

	/**
	 * @param continuous
	 * @return
	 */
	public Replication continuous(Boolean continuous) {
		this.replication = replication.continuous(continuous);
		return this ;
	}

	/**
	 * @param filter
	 * @return
	 */
	public Replication filter(String filter) {
		this.replication =  replication.filter(filter);
		return this ;
	}

	/**
	 * @param queryParams
	 * @return
	 */
	public Replication queryParams(String queryParams) {
		this.replication = replication.queryParams(queryParams);
		return this ;
	}

	/**
	 * @param queryParams
	 * @return
	 */
	public Replication queryParams(
			Map queryParams) {
		this.replication =  replication.queryParams(queryParams);
		return this ;
	}

	/**
	 * @param docIds
	 * @return
	 * @see org.lightcouch.Replication#docIds(java.lang.String[])
	 */
	public Replication docIds(String... docIds) {
		this.replication =  replication.docIds(docIds);
		return this ;
	}

	/**
	 * @param proxy
	 * @return
	 */
	public Replication proxy(String proxy) {
		this.replication = replication.proxy(proxy);
		return this ;
	}

	/**
	 * @param cancel
	 * @return
	 */
	public Replication cancel(Boolean cancel) {
		this.replication = replication.cancel(cancel);
		return this ;
	}

	/**
	 * @param createTarget
	 * @return
	 */
	public Replication createTarget(Boolean createTarget) {
		this.replication = replication.createTarget(createTarget);
		return this ;
	}


	/**
	 * Starts a replication since an update sequence.  
	 */
	public Replication sinceSeq(Integer sinceSeq) {
		this.replication =  replication.sinceSeq(sinceSeq);
		return this ;
	}

	/**
	 * @param consumerSecret
	 * @param consumerKey
	 * @param tokenSecret
	 * @param token
	 * @return
	 */
	public Replication targetOauth(String consumerSecret,
			String consumerKey, String tokenSecret, String token) {
		this.replication = replication.targetOauth(consumerSecret, consumerKey,
				tokenSecret, token);
		return this ;
	}

}