com.evrythng.java.wrapper.core.api

Class ApiCommandBuilder<T,B extends ApiCommandBuilder>

java.lang.Object

com.evrythng.java.wrapper.core.api.ApiCommandBuilder<T,B>

Direct Known Subclasses:

EvrythngApiBuilder.Builder

public class ApiCommandBuilder<T,B extends ApiCommandBuilder>
extends Object

Generic API command builder.

Constructor Summary

Constructors

Constructor and Description
ApiCommandBuilder(HttpMethodBuilder.MethodBuilder<?> methodBuilder, URI uri, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> responseType)

Method Summary

Modifier and Type	Method and Description
B	accept(String mediaType) Sets the value of the Accept HTTP header.
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 ApiCommand.responseType.
ApiCommand<T>	getCommand()
B	header(String name, String value) Sets a request header or removes it if value equals null.
B	placeHolder(Boolean placeHolder)
B	queryParam(QueryParamValue qpv) Sets a query parameter or removes it if the value equals null.
B	queryParam(String name, List<String> value) Sets a multi-valued query parameter or removes it if value equals null.
B	queryParam(String name, String value) Sets a query parameter or removes it if value equals null .
B	queryParamList(String name, List<String> values) Sets a multi-valued query parameter or removes it if value equals null.
B	queryParamList(String name, String... values) Sets a multi-valued query parameter or removes it if value equals null.
B	queryParams(Map<String,String> params) Sets the provided query parametes.
org.apache.http.HttpResponse	request() Executes the current command and returns the native HttpResponse.
InputStream	stream() Executes the current command and returns the HttpResponse content InputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiCommandBuilder

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

Parameters:

methodBuilder - the HttpMethodBuilder.MethodBuilder used for creating the request

uri - the URI holding the absolute URL

responseStatus - the expected response Status

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

Method Detail

queryParam

public B queryParam(String name,
                    String value)

Sets a query parameter or removes it if value equals null .

Parameters:

name - the query parameter name

value - the query parameter value

Returns:

the current B instance

placeHolder

public B placeHolder(Boolean placeHolder)

queryParam

public B queryParam(QueryParamValue qpv)

Sets a query parameter or removes it if the value equals null.

Parameters:

qpv - the name and the value of the query parameter.

Returns:

the current B instance

queryParam

public B queryParam(String name,
                    List<String> value)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

value - parameter values or null

Returns:

the current B instance

queryParamList

public B queryParamList(String name,
                        List<String> values)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

values - parameter values or null

Returns:

the current B instance

queryParamList

public B queryParamList(String name,
                        String... values)

Sets a multi-valued query parameter or removes it if value equals null.

Parameters:

name - parameter name

values - parameter values or null

Returns:

the current B instance

queryParams

public B queryParams(Map<String,String> params)

Sets the provided query parametes.

Parameters:

params - a map name/value entries

Returns:

the current B instance

See Also:

queryParam(String, String)

header

public B header(String name,
                String value)

Sets a request header or removes it if value equals null.

Parameters:

name - request header name

value - the request header value

Returns:

the current B instance

accept

public B accept(String mediaType)

Sets the value of the Accept HTTP header.

Parameters:

mediaType - a valid media type for the Accept HTTP header

Returns:

the current B instance

execute

public T execute()
          throws EvrythngException

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

Returns:

the HttpResponse entity mapped to T

Throws:

EvrythngException

See Also:

ApiCommand.execute()

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

See Also:

ApiCommand.content()

request

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

Executes the current command and returns the native HttpResponse.

Returns:

the HttpResponse resulting from the request

Throws:

EvrythngException

See Also:

ApiCommand.request()

stream

public InputStream stream()
                   throws EvrythngException

Executes the current command and returns the HttpResponse content InputStream.

Returns:

the InputStream of the HttpResponse

Throws:

EvrythngException

See Also:

ApiCommand.stream()

getCommand

public ApiCommand<T> getCommand()

Returns:

ApiCommand instance