com.evrythng.java.wrapper.core.api

Class ApiCommand<T>

java.lang.Object

com.evrythng.java.wrapper.core.api.ApiCommand<T>

public class ApiCommand<T>
extends Object

Generic definition for API commands.

Constructor Summary

Constructors

Constructor and Description
ApiCommand(HttpMethodBuilder.MethodBuilder<?> methodBuilder, URI uri, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> responseType) Creates a new instance of ApiCommand.

Method Summary

Modifier and Type	Method and Description
TypedResponseWithEntity<T>	bundle() Execute the current command and returns both HttpResponse and the entity typed.
String	content() Executes the current command and returns the HttpResponse entity content as String.
T	execute() Executes the current command and maps the HttpResponse entity to T specified by responseType.
T	execute(boolean retryOnConnectTimeout) Executes the current command and maps the HttpResponse entity to T specified by responseType.
Status	getExpectedResponseStatus() Gets the expected response status.
HttpMethodBuilder.Method	getMethod() Gets the HTTP method.
com.fasterxml.jackson.core.type.TypeReference<T>	getResponseType() Gets the response type.
org.apache.http.Header	head(String headerName) Executes the current command using the HTTP HEAD method and returns the value of the first HttpResponse Header specified by headerName.
void	removeHeader(String name) Removes the specified request header.
void	removeQueryParam(String name) Removes the specified query parameter.
org.apache.http.HttpResponse	request() Executes the current command and returns the native HttpResponse.
void	setHeader(String name, String value) Sets (adds or overwrittes) the specified request header.
void	setHttpParams(org.apache.http.params.HttpParams params) Sets HTTP-specific params, {
void	setQueryParam(QueryParamValue queryParam)
void	setQueryParam(String name, List<String> value) Sets (adds or overwrittes) the multi-value of specified query parameter.
void	setQueryParam(String name, String value) Sets (adds or overwrittes) the specified query parameter.
protected void	shutdown(org.apache.http.client.HttpClient client) Shuts down the connection manager to ensure immediate deallocation of all system resources.
InputStream	stream() Executes the current command and returns the HttpResponse entity body as InputStream.
URI	uri() Builds the final URI using uri as base URL and all defined queryParams as query parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiCommand

public ApiCommand(HttpMethodBuilder.MethodBuilder<?> methodBuilder,
                  URI uri,
                  Status responseStatus,
                  com.fasterxml.jackson.core.type.TypeReference<T> responseType)

Creates a new instance of ApiCommand.

Parameters:

methodBuilder - the HttpMethodBuilder.MethodBuilder used for creating the request

uri - the URI holding the absolute URL

responseStatus - the expected HttpResponse status

responseType - the native type to which the HttpResponse will be mapped to

Method Detail

getExpectedResponseStatus

public Status getExpectedResponseStatus()

Gets the expected response status.

Returns:

Status instance

getResponseType

public com.fasterxml.jackson.core.type.TypeReference<T> getResponseType()

Gets the response type.

Returns:

TypeReference instance

getMethod

public HttpMethodBuilder.Method getMethod()

Gets the HTTP method.

Returns:

HttpMethodBuilder.Method type

execute

public T execute()
          throws EvrythngException

Executes the current command and maps the HttpResponse entity to T specified by responseType.

Returns:

the HttpResponse entity mapped to T

Throws:

EvrythngException

execute

public T execute(boolean retryOnConnectTimeout)
          throws EvrythngException

Executes the current command and maps the HttpResponse entity to T specified by responseType.

If the retryOnConnectTimeout parameter is true the connection will be attempted up to CONNECTION_RETRY_ATTEMPTS times.

Parameters:

retryOnConnectTimeout - if true the connection will be attempted up to CONNECTION_RETRY_ATTEMPTS times when a connect timeout is encountered

Returns:

the HttpResponse entity mapped to T

Throws:

EvrythngException - in case an exception is encountered during the request

content

public String content()
               throws EvrythngException

Executes the current command and returns the HttpResponse entity content as String.

Returns:

the HttpResponse entity content as String

Throws:

EvrythngException

request

public org.apache.http.HttpResponse request()
                                     throws EvrythngException

Executes the current command and returns the native HttpResponse.

Returns:

the HttpResponse implied by the request

Throws:

EvrythngException

stream

public InputStream stream()
                   throws EvrythngException

Executes the current command and returns the HttpResponse entity body as InputStream.

Returns:

the HttpResponse entity as InputStream

Throws:

EvrythngException

bundle

public TypedResponseWithEntity<T> bundle()
                                  throws EvrythngException

Execute the current command and returns both HttpResponse and the entity typed. Bundled in a TypedResponseWithEntity object

Returns:

HttpResponse bundled with entity

Throws:

EvrythngException

head

public org.apache.http.Header head(String headerName)
                            throws EvrythngException

Executes the current command using the HTTP HEAD method and returns the value of the first HttpResponse Header specified by headerName. This method is usefull for obtaining metainformation about the HttpResponse implied by the request without transferring the entity-body.

FIXME: HEAD not supported for now, using GET instead

Parameters:

headerName - the HttpResponse header to be retrieved

Returns:

the value of the first retrieved HttpResponse header or null if no such header could be found.

Throws:

EvrythngException

See Also:

HttpMessage.getFirstHeader(String)

setHeader

public void setHeader(String name,
                      String value)

Sets (adds or overwrittes) the specified request header.

Parameters:

name - the request header name

value - the request header value

removeHeader

public void removeHeader(String name)

Removes the specified request header.

Parameters:

name - the name of the request header to be removed

setQueryParam

public void setQueryParam(String name,
                          String value)

Sets (adds or overwrittes) the specified query parameter.

Parameters:

name - the query parameter name

value - the query parameter value

setQueryParam

public void setQueryParam(QueryParamValue queryParam)

setQueryParam

public void setQueryParam(String name,
                          List<String> value)

Sets (adds or overwrittes) the multi-value of specified query parameter.

Parameters:

name - the query parameter name

value - the query parameter values list

removeQueryParam

public void removeQueryParam(String name)

Removes the specified query parameter.

Parameters:

name - the name of the query parameter to be removed

setHttpParams

public void setHttpParams(org.apache.http.params.HttpParams params)

Sets HTTP-specific params, {

Parameters:

params - HttpParams instance

See Also:

HttpClient

uri

public final URI uri()
              throws EvrythngClientException

Builds the final URI using uri as base URL and all defined queryParams as query parameters.

Returns:

the absolute URI

Throws:

EvrythngClientException

shutdown

protected void shutdown(org.apache.http.client.HttpClient client)

Shuts down the connection manager to ensure immediate deallocation of all system resources.

Parameters:

client - the HttpClient to shut down