com.evrythng.java.wrapper.core

Class EvrythngApiBuilder

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngApiBuilder

public final class EvrythngApiBuilder
extends Object

Entry-point command builder for the EVRYTHNG API.

Author:

Pedro De Almeida (almeidap)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EvrythngApiBuilder.Builder<TYPE>
static class	EvrythngApiBuilder.CheckedBuilder<T> Default command builder for the EVRYTHNG API.
static class	EvrythngApiBuilder.UncheckedBuilder<T>

Method Summary

Modifier and Type	Method and Description
static EvrythngApiBuilder.Builder<Boolean>	delete(String apiKey, URI uri, Status responseStatus) Creates a EvrythngApiBuilder.Builder for executing a DELETE request.
static EvrythngApiBuilder.Builder<Long>	deleteMultiple(String apiKey, URI uri, Status responseStatus) Creates a EvrythngApiBuilder.Builder for executing a bulk DELETE request, and wrap the X-result-count header as a integer response.
static <T> EvrythngApiBuilder.Builder<T>	get(String apiKey, URI uri, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Creates a EvrythngApiBuilder.Builder for executing a GET request.
static <T> EvrythngApiBuilder.Builder<T>	post(String apiKey, URI uri, Object data, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> responseType) Creates a EvrythngApiBuilder.CheckedBuilder for executing a POST request.
static EvrythngApiBuilder.Builder<AcceptedResourceResponse>	postAsynchronously(String apiKey, URI uri, Object data, Pattern extractor)
static <T> EvrythngApiBuilder.Builder<T>	postMultipart(String apiKey, URI uri, File file, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> responseType) Creates a EvrythngApiBuilder.CheckedBuilder for executing a file upload via a POST request.
static <T> EvrythngApiBuilder.Builder<T>	put(String apiKey, URI uri, Object data, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> returnType) Creates a EvrythngApiBuilder.Builder for executing a PUT request.
static <T> EvrythngApiBuilder.Builder<T>	putMultipart(String apiKey, URI uri, File file, Status responseStatus, com.fasterxml.jackson.core.type.TypeReference<T> responseType) Creates a EvrythngApiBuilder.CheckedBuilder for executing a file upload via a PUT request.
static EvrythngApiBuilder.Builder<Long>	putMultiple(String apiKey, URI uri, Object data, Status responseStatus) Create a EvrythngApiBuilder.Builder for executing a PUT request, expecting no result payload.

Methods inherited from class java.lang.Object

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

Method Detail

post

public static <T> EvrythngApiBuilder.Builder<T> post(String apiKey,
                                                     URI uri,
                                                     Object data,
                                                     Status responseStatus,
                                                     com.fasterxml.jackson.core.type.TypeReference<T> responseType)

Creates a EvrythngApiBuilder.CheckedBuilder for executing a POST request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

data - the content data that will be associated with the POST request

responseStatus - the expected HttpResponse status

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.CheckedBuilder

postMultipart

public static <T> EvrythngApiBuilder.Builder<T> postMultipart(String apiKey,
                                                              URI uri,
                                                              File file,
                                                              Status responseStatus,
                                                              com.fasterxml.jackson.core.type.TypeReference<T> responseType)

Creates a EvrythngApiBuilder.CheckedBuilder for executing a file upload via a POST request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

file - file

responseStatus - the expected response Status

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.CheckedBuilder

putMultipart

public static <T> EvrythngApiBuilder.Builder<T> putMultipart(String apiKey,
                                                             URI uri,
                                                             File file,
                                                             Status responseStatus,
                                                             com.fasterxml.jackson.core.type.TypeReference<T> responseType)

Creates a EvrythngApiBuilder.CheckedBuilder for executing a file upload via a PUT request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

file - file

responseStatus - the expected response Status

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.CheckedBuilder

postAsynchronously

public static EvrythngApiBuilder.Builder<AcceptedResourceResponse> postAsynchronously(String apiKey,
                                                                                      URI uri,
                                                                                      Object data,
                                                                                      Pattern extractor)

get

public static <T> EvrythngApiBuilder.Builder<T> get(String apiKey,
                                                    URI uri,
                                                    Status responseStatus,
                                                    com.fasterxml.jackson.core.type.TypeReference<T> returnType)

Creates a EvrythngApiBuilder.Builder for executing a GET request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

responseStatus - the expected HttpResponse status

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

put

public static <T> EvrythngApiBuilder.Builder<T> put(String apiKey,
                                                    URI uri,
                                                    Object data,
                                                    Status responseStatus,
                                                    com.fasterxml.jackson.core.type.TypeReference<T> returnType)

Creates a EvrythngApiBuilder.Builder for executing a PUT request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

data - the content data that will be associated with the POST request

responseStatus - the expected HttpResponse status

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

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

putMultiple

public static EvrythngApiBuilder.Builder<Long> putMultiple(String apiKey,
                                                           URI uri,
                                                           Object data,
                                                           Status responseStatus)

Create a EvrythngApiBuilder.Builder for executing a PUT request, expecting no result payload. But a ApiConfiguration.HTTP_HEADER_RESULT_COUNT header which contains the amount of document updated.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

data - the content data that will be associated with the PUT request

responseStatus - the expected HttpResponse status. More likely 204 No Content

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

delete

public static EvrythngApiBuilder.Builder<Boolean> delete(String apiKey,
                                                         URI uri,
                                                         Status responseStatus)

Creates a EvrythngApiBuilder.Builder for executing a DELETE request.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

responseStatus - the expected HttpResponse status

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder

deleteMultiple

public static EvrythngApiBuilder.Builder<Long> deleteMultiple(String apiKey,
                                                              URI uri,
                                                              Status responseStatus)

Creates a EvrythngApiBuilder.Builder for executing a bulk DELETE request, and wrap the X-result-count header as a integer response.

Parameters:

apiKey - the authorization token for accessing the EVRYTHNG API

uri - the URI holding the absolute URL

responseStatus - the expected HttpResponse status

Returns:

an EVRYTHNG API-ready EvrythngApiBuilder.Builder