net.sf.jkniv.whinstone.couchdb.commands

Class AbstractCommand

java.lang.Object

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

All Implemented Interfaces:

Command, CouchCommand

Direct Known Subclasses:

AddCommand, AllDocsCommand, BulkCommand, DeleteCommand, DropIndexCommand, FindCommand, FullResponseFindCommand, GetCommand, UpdateCommand, ViewCommand

public abstract class AbstractCommand
extends Object
implements CouchCommand

HTTP code documentation from W3C RFC 2616

Since:

0.6.0

Author:

Alisson Gomes

Field Summary

Fields

Modifier and Type	Field and Description
protected String	body
protected CommandHandler	commandHandler
protected HandleableException	handlerException
protected HttpMethod	method
protected String	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
AbstractCommand()
AbstractCommand(String url)
AbstractCommand(String url, String body)

Method Summary

Modifier and Type	Method and Description
HttpMethod	asDelete()
HttpMethod	asGet()
HttpMethod	asHead()
HttpMethod	asPost()
HttpMethod	asPut()
protected String	errorFormat(org.apache.http.client.methods.HttpRequestBase http, org.apache.http.StatusLine statusLine, String json)
protected String	getContentEncode(org.apache.http.client.methods.HttpRequestBase http)
protected String	getContentType(org.apache.http.client.methods.HttpRequestBase http)
protected org.apache.http.HttpEntity	getEntity()
protected String	getRevision(Queryable queryable)
protected void	injectAutoIdentity(ObjectProxy<?> proxy, Object param, String id, String rev, String properName, PropertyAccess accessId, PropertyAccess accessRev)
protected void	injectIdentity(ObjectProxy<?> proxy, Object param, String id, String rev, PropertyAccess accessId, PropertyAccess accessRev)
protected boolean	isAccepted(int statusCode) 202 Accepted
protected boolean	isCreated(int statusCode) 201 Created
protected boolean	isExpectationFailed(int statusCode) 417 Expectation Faile
protected boolean	isNotFound(int statusCode) Verify if http status represents a record not found
protected boolean	isOk(int statusCode)
protected void	printRequest(org.apache.http.client.methods.HttpRequestBase req)
protected void	printResponse(org.apache.http.client.methods.CloseableHttpResponse resp, String json)
protected void	setBookmark(String bookmark, Queryable queryable)
Command	with(CommandHandler commandHandler) Configure the life-cycle of command
Command	with(HandleableException handlerException) Configure the handler exception for the command
<T> Command	with(T stmt) The statement to run this command

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

getBody

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

execute

Field Detail

handlerException

protected HandleableException handlerException

commandHandler

protected CommandHandler commandHandler

url

protected String url

body

protected String body

method

protected HttpMethod method

Constructor Detail

AbstractCommand

public AbstractCommand()

AbstractCommand

public AbstractCommand(String url)

AbstractCommand

public AbstractCommand(String url,
                       String body)

Method Detail

with

public <T> Command with(T stmt)

Description copied from interface: Command

The statement to run this command

Specified by:

with in interface Command

Type Parameters:

T - Type responsible to execute the statement into database. For example: Statement for JDBC or Cassandra, EntityManager for JPA, bucket for Couchbase etc

Parameters:

stmt - a statement implementation to run the command.

Returns:

a reference to this object.

with

public Command with(HandleableException handlerException)

Description copied from interface: Command

Configure the handler exception for the command

Specified by:

with in interface Command

Parameters:

handlerException - rules to handler the all exceptions

Returns:

a reference to this object.

with

public Command with(CommandHandler commandHandler)

Description copied from interface: Command

Configure the life-cycle of command

Specified by:

with in interface Command

Parameters:

commandHandler - the life-cycle of command handler

Returns:

a reference to this object.

getEntity

protected org.apache.http.HttpEntity getEntity()

getContentType

protected String getContentType(org.apache.http.client.methods.HttpRequestBase http)

getContentEncode

protected String getContentEncode(org.apache.http.client.methods.HttpRequestBase http)

errorFormat

protected String errorFormat(org.apache.http.client.methods.HttpRequestBase http,
                             org.apache.http.StatusLine statusLine,
                             String json)

asPut

public HttpMethod asPut()

Specified by:

asPut in interface CouchCommand

asPost

public HttpMethod asPost()

Specified by:

asPost in interface CouchCommand

asDelete

public HttpMethod asDelete()

Specified by:

asDelete in interface CouchCommand

asGet

public HttpMethod asGet()

Specified by:

asGet in interface CouchCommand

asHead

public HttpMethod asHead()

Specified by:

asHead in interface CouchCommand

isNotFound

protected boolean isNotFound(int statusCode)

Verify if http status represents a record not found

Parameters:

statusCode - HTTP status code

Returns:

return true when the resource it's not found, false otherwise.

isOk

protected boolean isOk(int statusCode)

isCreated

protected boolean isCreated(int statusCode)

201 Created

The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead.

Parameters:

statusCode - HTTP status code

Returns:

true when is 202 code, false otherwise

isAccepted

protected boolean isAccepted(int statusCode)

202 Accepted

The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this.

The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled.

Parameters:

statusCode - HTTP status code

Returns:

true when is 202 code, false otherwise

isExpectationFailed

protected boolean isExpectationFailed(int statusCode)

417 Expectation Faile

The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server.

Parameters:

statusCode - HTTP status code

Returns:

true when is 202 code, false otherwise

getRevision

protected String getRevision(Queryable queryable)

injectIdentity

protected void injectIdentity(ObjectProxy<?> proxy,
                              Object param,
                              String id,
                              String rev,
                              PropertyAccess accessId,
                              PropertyAccess accessRev)

injectAutoIdentity

protected void injectAutoIdentity(ObjectProxy<?> proxy,
                                  Object param,
                                  String id,
                                  String rev,
                                  String properName,
                                  PropertyAccess accessId,
                                  PropertyAccess accessRev)

setBookmark

protected void setBookmark(String bookmark,
                           Queryable queryable)

printRequest

protected void printRequest(org.apache.http.client.methods.HttpRequestBase req)

printResponse

protected void printResponse(org.apache.http.client.methods.CloseableHttpResponse resp,
                             String json)