net.sf.jkniv.whinstone.couchdb.commands

Class AddCommand

java.lang.Object

net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

net.sf.jkniv.whinstone.couchdb.commands.AddCommand

All Implemented Interfaces:

Command, CouchCommand

public class AddCommand
extends AbstractCommand
implements CouchCommand

 
 http://docs.couchdb.org/en/2.0.0/api/document/common.html
 
 PUT /{db}/{docid}

  The PUT method creates a new named document, or creates a new revision of the existing document. 
  Unlike the POST /{db}, you must specify the document ID in the request URL.
  
  Parameters: 

      db – Database name
      docid – Document ID

  Request Headers:
      
 
      Accept –
          application/json
          text/plain
      Content-Type – application/json
      If-Match – Document’s revision. Alternative to rev query parameter
      X-Couch-Full-Commit – Overrides server’s commit policy. Possible values are: false and true. Optional
 
  Query Parameters:
      

      batch (string) – Stores document in batch mode. Possible values: ok. Optional
      new_edits (boolean) – Prevents insertion of a conflicting document. 
                            Possible values: true (default) and false. If false, a well-formed _rev must be included 
                            in the document. new_edits=false is used by the replicator to insert documents into 
                            the target database even if that leads to the creation of conflicts. Optional

  Response Headers:
      

      Content-Type –
                     application/json
                     text/plain; charset=utf-8
      ETag – Quoted document’s new revision
      Location – Document URI

  Response JSON Object:
      

      id (string) – Document ID
      ok (boolean) – Operation status
      rev (string) – Revision MVCC token

  Status Codes:   
 
      201 Created – Document created and stored on disk
      202 Accepted – Document data accepted, but not yet stored on disk
      400 Bad Request – Invalid request body or parameters
      401 Unauthorized – Write privileges required
      404 Not Found – Specified database or document ID doesn’t exists
      409 Conflict – Document with the specified ID already exists or specified revision is not 
                     latest for target document

 

Since:

0.6.0

Author:

Alisson Gomes

Field Summary

Fields inherited from class net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

body, commandHandler, handlerException, method, url

Fields inherited from interface net.sf.jkniv.whinstone.couchdb.commands.CouchCommand

HTTP_ACCEPTED, HTTP_BAD_REQUEST, HTTP_CREATED, HTTP_EXPECTATION_FAILED, HTTP_NO_CONTENT, HTTP_NOT_FOUND, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_RESET_CONTENT

Constructor Summary

Constructors

Constructor and Description
AddCommand(HttpBuilder httpBuilder, Queryable queryable)

Method Summary

Modifier and Type	Method and Description
HttpMethod	asPost()
HttpMethod	asPut()
<T> T	execute() Execute the database statement could be a Command or a Query
String	getBody()

Methods inherited from class net.sf.jkniv.whinstone.couchdb.commands.AbstractCommand

asDelete, asGet, asHead, errorFormat, getContentEncode, getContentType, getEntity, getRevision, injectAutoIdentity, injectIdentity, isAccepted, isCreated, isExpectationFailed, isNotFound, isOk, printRequest, printResponse, setBookmark, with, with, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jkniv.whinstone.couchdb.commands.CouchCommand

asDelete, asGet, asHead

Methods inherited from interface net.sf.jkniv.whinstone.commands.Command

with, with, with

Constructor Detail

AddCommand

public AddCommand(HttpBuilder httpBuilder,
                  Queryable queryable)

Method Detail

execute

public <T> T execute()

Description copied from interface: Command

Execute the database statement could be a Command or a Query

Specified by:

execute in interface Command

Type Parameters:

T - Generic type of return, example: rows affected by a command or list of objects.

Returns:

the result of the statement execution

getBody

public String getBody()

Specified by:

getBody in interface CouchCommand

asPut

public HttpMethod asPut()

Specified by:

asPut in interface CouchCommand

Overrides:

asPut in class AbstractCommand

asPost

public HttpMethod asPost()

Specified by:

asPost in interface CouchCommand

Overrides:

asPost in class AbstractCommand