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
/*
 * Copyright (c) 2015 IBM Corp. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package com.cloudant.client.api;

import com.cloudant.client.org.lightcouch.ReplicationResult;
import com.cloudant.client.org.lightcouch.ReplicationResult.ReplicationHistory;
import com.cloudant.client.org.lightcouch.Replicator;

import java.util.Map;

/**
 * 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();
 * }
 * 
 *
 * @author Ganesh K Choudhary
 * @see CloudantClient#replication()
 * @see ReplicationResult
 * @see ReplicationHistory
 * @see Replicator
 * @since 0.0.1
 */
public class Replication {
    private com.cloudant.client.org.lightcouch.Replication replication;

    Replication(com.cloudant.client.org.lightcouch.Replication replication) {
        this.replication = replication;
    }

    /**
     * Triggers a replication request, blocks while the replication is in progress.
     * @return ReplicationResult encapsulating the result
     */
    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;
    }

    public Replication source(String source) {
        this.replication = replication.source(source);
        return this;
    }

    public Replication target(String target) {
        this.replication = replication.target(target);
        return this;
    }

    public Replication continuous(Boolean continuous) {
        this.replication = replication.continuous(continuous);
        return this;
    }

    public Replication filter(String filter) {
        this.replication = replication.filter(filter);
        return this;
    }

    public Replication queryParams(String queryParams) {
        this.replication = replication.queryParams(queryParams);
        return this;
    }

    public Replication queryParams(Map queryParams) {
        this.replication = replication.queryParams(queryParams);
        return this;
    }

    /**
     * Limit the replication to the specified document IDs.
     *
     * @param docIds one or more document IDs to include in the replication
     * @return this to set more options or trigger the replication
     */
    public Replication docIds(String... docIds) {
        this.replication = replication.docIds(docIds);
        return this;
    }

    public Replication proxy(String proxy) {
        this.replication = replication.proxy(proxy);
        return this;
    }

    public Replication cancel(Boolean cancel) {
        this.replication = replication.cancel(cancel);
        return this;
    }

    public Replication createTarget(Boolean createTarget) {
        this.replication = replication.createTarget(createTarget);
        return this;
    }


    /**
     * Starts a replication since an update sequence.
     *
     * @param sinceSeq sequence number
     * @return this to set more options or trigger the replication
     */
    public Replication sinceSeq(Integer sinceSeq) {
        this.replication = replication.sinceSeq(sinceSeq);
        return this;
    }

    /**
     * Set OAuth 1 authentication credentials for the replication target
     *
     * @param consumerSecret client secret
     * @param consumerKey client identifier
     * @param tokenSecret OAuth server token secret
     * @param token OAuth server issued token
     * @return this to set more options or trigger the replication
     */
    public Replication targetOauth(String consumerSecret,
                                   String consumerKey, String tokenSecret, String token) {
        this.replication = replication.targetOauth(consumerSecret, consumerKey,
                tokenSecret, token);
        return this;
    }

}