com.cloudant.mazha

Class CouchClient

java.lang.Object

com.cloudant.mazha.CouchClient

public class CouchClient
extends java.lang.Object

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CouchClient.MissingRevisions

Constructor Summary

Constructors

Constructor and Description
CouchClient(java.net.URI rootUri, java.util.List<com.cloudant.http.HttpConnectionRequestInterceptor> requestInterceptors, java.util.List<com.cloudant.http.HttpConnectionResponseInterceptor> responseInterceptors)

Method Summary

Modifier and Type	Method and Description
java.util.List<Response>	bulkCreateDocs(java.util.List<?> objects)
java.util.List<Response>	bulkCreateDocs(java.lang.Object... objects)
java.util.List<Response>	bulkCreateSerializedDocs(java.util.List<java.lang.String> serializedDocs) Bulk insert a list of document that are serialized to JSON data already.
java.util.List<Response>	bulkCreateSerializedDocs(java.lang.String... serializedDocs) Bulk insert a list of document that are serialized to JSON data already.
java.lang.Iterable<DocumentRevsList>	bulkReadDocsWithOpenRevisions(java.util.List<BulkGetRequest> request, boolean pullAttachmentsInline) Return an iterator representing the result of calling the _bulk_docs endpoint.
ChangesResult	changes(java.util.Map<java.lang.String,java.lang.Object> options)
ChangesResult	changes(java.lang.Object since)
ChangesResult	changes(java.lang.Object since, java.lang.Integer limit)
ChangesResult	changes(java.lang.String filterName, java.util.Map<java.lang.String,java.lang.String> filterParameters, java.lang.Object since, java.lang.Integer limit)
boolean	contains(java.lang.String id)
Response	create(java.lang.Object document)
void	createDb()
Response	delete(java.lang.String id, java.lang.String rev)
void	deleteDb()
java.io.InputStream	getAttachmentStream(java.lang.String id, java.lang.String rev, java.lang.String attachmentName, boolean acceptGzip)
CouchDbInfo	getDbInfo()
<T> T	getDocConflictRevs(java.lang.String id) Convenience method to get document with all the conflicts revisions.
DocumentRevs	getDocRevisions(java.lang.String id, java.lang.String rev) Get document along with its revision history, and the result is converted to a DocumentRevs object.
<T> T	getDocRevisions(java.lang.String id, java.lang.String rev, com.fasterxml.jackson.core.type.TypeReference<T> type)
java.util.Map<java.lang.String,java.lang.Object>	getDocument(java.lang.String id)
<T> T	getDocument(java.lang.String id, java.lang.Class<T> type)
<T> T	getDocument(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> options, com.fasterxml.jackson.core.type.TypeReference<T> type)
java.util.Map<java.lang.String,java.lang.Object>	getDocument(java.lang.String id, java.lang.String rev)
<T> T	getDocument(java.lang.String id, java.lang.String rev, java.lang.Class<T> type)
<T> T	getDocument(java.lang.String id, java.lang.String rev, com.fasterxml.jackson.core.type.TypeReference<T> type)
java.io.InputStream	getDocumentStream(java.lang.String id, java.lang.String rev)
java.util.List<OpenRevision>	getDocWithOpenRevisions(java.lang.String id, java.util.Collection<java.lang.String> revisions, java.util.Collection<java.lang.String> attsSince, boolean pullAttachmentsInline) Convenience method to get document with revision history for a given list of open revisions.
java.net.URI	getRootUri()
boolean	isBulkSupported()
void	putAttachmentStream(java.lang.String id, java.lang.String rev, java.lang.String attachmentName, java.lang.String contentType, byte[] attachmentData)
Response	putMultipart(MultipartAttachmentWriter mpw)
java.util.Map<java.lang.String,CouchClient.MissingRevisions>	revsDiff(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> revisions) Returns the subset of given the documentId/revisions that are not stored in the database.
Response	update(java.lang.String id, java.lang.Object document)

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchClient

public CouchClient(java.net.URI rootUri,
                   java.util.List<com.cloudant.http.HttpConnectionRequestInterceptor> requestInterceptors,
                   java.util.List<com.cloudant.http.HttpConnectionResponseInterceptor> responseInterceptors)

Method Detail

getRootUri

public java.net.URI getRootUri()

createDb

public void createDb()

deleteDb

public void deleteDb()

getDbInfo

public CouchDbInfo getDbInfo()

changes

public ChangesResult changes(java.lang.Object since)

changes

public ChangesResult changes(java.lang.Object since,
                             java.lang.Integer limit)

changes

public ChangesResult changes(java.lang.String filterName,
                             java.util.Map<java.lang.String,java.lang.String> filterParameters,
                             java.lang.Object since,
                             java.lang.Integer limit)

changes

public ChangesResult changes(java.util.Map<java.lang.String,java.lang.Object> options)

contains

public boolean contains(java.lang.String id)

create

public Response create(java.lang.Object document)

getDocumentStream

public java.io.InputStream getDocumentStream(java.lang.String id,
                                             java.lang.String rev)

getAttachmentStream

public java.io.InputStream getAttachmentStream(java.lang.String id,
                                               java.lang.String rev,
                                               java.lang.String attachmentName,
                                               boolean acceptGzip)

putAttachmentStream

public void putAttachmentStream(java.lang.String id,
                                java.lang.String rev,
                                java.lang.String attachmentName,
                                java.lang.String contentType,
                                byte[] attachmentData)

getDocConflictRevs

public <T> T getDocConflictRevs(java.lang.String id)

Convenience method to get document with all the conflicts revisions. It does that by adding "conflicts=true" option to the GET request. An example response JSON is the following: { "_id" : "c3fe5bfdee767fa3d51717bb8b51d55b", "_rev" : "3-176c3c8b3f284d4fa6e8c075d58b7b86", "hello" : "world", "name" : "Tom", "_conflicts" : [ "2-d9789a01da0c41aeb3d86ff039f461f6", "2-65ddd7d56da84f25af544e84a3267ccf" ] }

getDocWithOpenRevisions

public java.util.List<OpenRevision> getDocWithOpenRevisions(java.lang.String id,
                                                            java.util.Collection<java.lang.String> revisions,
                                                            java.util.Collection<java.lang.String> attsSince,
                                                            boolean pullAttachmentsInline)

Convenience method to get document with revision history for a given list of open revisions. It does that by adding "open_revs=["rev1", "rev2"]" option to the GET request. It must return a list because that is how CouchDB return its results.

bulkReadDocsWithOpenRevisions

public java.lang.Iterable<DocumentRevsList> bulkReadDocsWithOpenRevisions(java.util.List<BulkGetRequest> request,
                                                                          boolean pullAttachmentsInline)

Return an iterator representing the result of calling the _bulk_docs endpoint.

Each time the iterator is advanced, a DocumentRevsList is returned, which represents the leaf nodes and their ancestries for a given document id.

Parameters:

request - A request for 1 or more (id,rev) pairs.

pullAttachmentsInline - If true, retrieve attachments as inline base64

Returns:

An iterator representing the result of calling the _bulk_docs endpoint.

getDocument

public java.util.Map<java.lang.String,java.lang.Object> getDocument(java.lang.String id)

getDocument

public <T> T getDocument(java.lang.String id,
                         java.lang.Class<T> type)

getDocument

public <T> T getDocument(java.lang.String id,
                         java.util.Map<java.lang.String,java.lang.Object> options,
                         com.fasterxml.jackson.core.type.TypeReference<T> type)

getDocument

public java.util.Map<java.lang.String,java.lang.Object> getDocument(java.lang.String id,
                                                                    java.lang.String rev)

getDocument

public <T> T getDocument(java.lang.String id,
                         java.lang.String rev,
                         com.fasterxml.jackson.core.type.TypeReference<T> type)

getDocument

public <T> T getDocument(java.lang.String id,
                         java.lang.String rev,
                         java.lang.Class<T> type)

getDocRevisions

public DocumentRevs getDocRevisions(java.lang.String id,
                                    java.lang.String rev)

Get document along with its revision history, and the result is converted to a DocumentRevs object.

See Also:

DocumentRevs

getDocRevisions

public <T> T getDocRevisions(java.lang.String id,
                             java.lang.String rev,
                             com.fasterxml.jackson.core.type.TypeReference<T> type)

update

public Response update(java.lang.String id,
                       java.lang.Object document)

delete

public Response delete(java.lang.String id,
                       java.lang.String rev)

bulkCreateDocs

public java.util.List<Response> bulkCreateDocs(java.lang.Object... objects)

bulkCreateDocs

public java.util.List<Response> bulkCreateDocs(java.util.List<?> objects)

bulkCreateSerializedDocs

public java.util.List<Response> bulkCreateSerializedDocs(java.lang.String... serializedDocs)

Bulk insert a list of document that are serialized to JSON data already. For performance reasons, the JSON doc is not validated.

Parameters:

serializedDocs - array of JSON documents

Returns:

list of Response

bulkCreateSerializedDocs

public java.util.List<Response> bulkCreateSerializedDocs(java.util.List<java.lang.String> serializedDocs)

Bulk insert a list of document that are serialized to JSON data already. For performance reasons, the JSON doc is not validated.

Parameters:

serializedDocs - list of JSON documents

Returns:

list of Response

revsDiff

public java.util.Map<java.lang.String,CouchClient.MissingRevisions> revsDiff(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> revisions)

Returns the subset of given the documentId/revisions that are not stored in the database. The input revisions is a map, whose key is document id, and value is a list of revisions. An example input could be (in JSON format): { "03ee06461a12f3c288bb865b22000170": [ "1-b2e54331db828310f3c772d6e042ac9c", "2-3a24009a9525bde9e4bfa8a99046b00d" ], "82e04f650661c9bdb88c57e044000a4b": [ "3-bb39f8c740c6ffb8614c7031b46ac162" ] } The output is in same format. If the id has no missing revision, it should not appear in the Map's key set. If all ids do not have missing revisions, the returned Map should be empty map, but never null.

See Also:

HttpPostRevsDiff documentation

putMultipart

public Response putMultipart(MultipartAttachmentWriter mpw)

isBulkSupported

public boolean isBulkSupported()