com.cloudant.sync.replication

Class ReplicatorBuilder<S,T,E>

java.lang.Object

com.cloudant.sync.replication.ReplicatorBuilder<S,T,E>

Direct Known Subclasses:

ReplicatorBuilder.Pull, ReplicatorBuilder.Push

public abstract class ReplicatorBuilder<S,T,E>
extends java.lang.Object

A Builder to create a Object

API Status: Public

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplicatorBuilder.Pull A Pull Replication Builder
static class	ReplicatorBuilder.Push A Push Replication Builder

Constructor Summary

Constructors

Constructor and Description
ReplicatorBuilder()

Method Summary

Modifier and Type	Method and Description
E	addRequestInterceptors(com.cloudant.http.HttpConnectionRequestInterceptor... interceptors) Variable argument version of addRequestInterceptors(List)
E	addRequestInterceptors(java.util.List<com.cloudant.http.HttpConnectionRequestInterceptor> interceptors) Adds interceptors to the list of request interceptors to use for each request made by this replication.
E	addResponseInterceptors(com.cloudant.http.HttpConnectionResponseInterceptor... interceptors) Variable argument version of addResponseInterceptors(List)
E	addResponseInterceptors(java.util.List<com.cloudant.http.HttpConnectionResponseInterceptor> interceptors) Adds interceptors to the list of response interceptors to use for each response received by this replication.
abstract Replicator	build() Builds a replicator based on the configuration set.
E	from(S source) Sets the source database for the replication
static ReplicatorBuilder.Pull	pull() Creates a pull replication builder.
static ReplicatorBuilder.Push	push() Creates a ReplicatorBuilder.Push replication builder.
Replicator	start() Builds a replicator by calling build() and then Replicator.start() on the replicator returned.
E	to(T target) Sets the target database for the replication
E	withId(int id)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicatorBuilder

public ReplicatorBuilder()

Method Detail

to

public E to(T target)

Sets the target database for the replication

Parameters:

target - The target for the replication

Returns:

This instance of ReplicatorBuilder

from

public E from(S source)

Sets the source database for the replication

Parameters:

source - The source database for the replication

Returns:

This instance of ReplicatorBuilder

withId

public E withId(int id)

addRequestInterceptors

public E addRequestInterceptors(com.cloudant.http.HttpConnectionRequestInterceptor... interceptors)

Variable argument version of addRequestInterceptors(List)

Parameters:

interceptors - The request interceptors to add.

Returns:

The current instance of ReplicatorBuilder

addRequestInterceptors

public E addRequestInterceptors(java.util.List<com.cloudant.http.HttpConnectionRequestInterceptor> interceptors)

Adds interceptors to the list of request interceptors to use for each request made by this replication.

Parameters:

interceptors - The request interceptors to add.

Returns:

The current instance of ReplicatorBuilder

addResponseInterceptors

public E addResponseInterceptors(com.cloudant.http.HttpConnectionResponseInterceptor... interceptors)

Variable argument version of addResponseInterceptors(List)

Parameters:

interceptors - The response interceptors to add.

Returns:

The current instance of ReplicatorBuilder

addResponseInterceptors

public E addResponseInterceptors(java.util.List<com.cloudant.http.HttpConnectionResponseInterceptor> interceptors)

Adds interceptors to the list of response interceptors to use for each response received by this replication.

Parameters:

interceptors - The response interceptors to add.

Returns:

The current instance of ReplicatorBuilder

start

public Replicator start()

Builds a replicator by calling build() and then Replicator.start() on the replicator returned.

Returns:

The replicator running the replication for this builder.

build

public abstract Replicator build()

Builds a replicator based on the configuration set.

Returns:

Replicator that will carry out the replication

pull

public static ReplicatorBuilder.Pull pull()

Creates a pull replication builder.

Returns:

A newly created ReplicatorBuilder.Pull replication builder

push

public static ReplicatorBuilder.Push push()

Creates a ReplicatorBuilder.Push replication builder.

Returns:

A newly created @{Link Push} replication builder