com.evrythng.java.wrapper.core

Class EvrythngServiceBase

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

Direct Known Subclasses:

ActionJobsService, ActionService, ApplicationService, AuthService, BatchService, CollectionService, FileService, JobsService, PlaceService, ProductService, ProjectService, RedirectorService, ScanService, SearchService, ThngService, TimeService, UrlBindingService

public class EvrythngServiceBase
extends Object

Base definition for EVRYTHNG API services.

Constructor Summary

Constructors

Constructor and Description
EvrythngServiceBase(ApiManager api) Creates a new instance of EvrythngServiceBase using the provided ApiManager.

Method Summary

Modifier and Type	Method and Description
protected URI	absoluteUri(String relativePath) Builds an absolute URI using the provided relativePath and the predefined ApiConfiguration.getUrl().
EvrythngApiBuilder.Builder<Boolean>	delete(String relativePath) Returns a preconfigured EvrythngApiBuilder.Builder for executing DELETE requests.
EvrythngApiBuilder.Builder<Long>	deleteMultiple(String relativePath) Returns a preconfigured EvrythngApiBuilder.Builder for executing bulk DELETE requests.
protected String	encodeBase64(InputStream image, String mime)
<T> EvrythngApiBuilder.Builder<T>	get(String relativePath, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for executing GET requests.
ApiConfiguration	getConfig()
protected <T> EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<T>>>	iterator(String relativePath, com.fasterxml.jackson.core.type.TypeReference<List<T>> pageType)
protected String	mqttUrl()
protected void	onBuilderCreated(EvrythngApiBuilder.Builder<?> builder)
<T> EvrythngApiBuilder.Builder<T>	post(String relativePath, Object data, Status expected, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for executing POST requests.
<T> EvrythngApiBuilder.Builder<T>	post(String relativePath, Object data, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for executing POST requests.
EvrythngApiBuilder.Builder<AcceptedResourceResponse>	postAsynchronously(String relativePath, Object data, Pattern pattern)
<T> EvrythngApiBuilder.Builder<T>	postMultipart(String relativePath, File file, Status expected, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via POST requests
<T> EvrythngApiBuilder.Builder<T>	postMultipart(String relativePath, File file, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via POST requests
<T> EvrythngApiBuilder.Builder<T>	put(String relativePath, Object data, Status expected, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests.
<T> EvrythngApiBuilder.Builder<T>	put(String relativePath, Object data, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests.
<T> EvrythngApiBuilder.Builder<T>	putMultipart(String relativePath, File file, Status expected, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via PUT requests
<T> EvrythngApiBuilder.Builder<T>	putMultipart(String relativePath, File file, com.fasterxml.jackson.core.type.TypeReference<T> type) Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via PUT requests
EvrythngApiBuilder.Builder<Long>	putMultiple(String relativePath, Object data) Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests.
protected static String	urlEncodePathPart(String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

EvrythngServiceBase

public EvrythngServiceBase(ApiManager api)

Creates a new instance of EvrythngServiceBase using the provided ApiManager.

Parameters:

api - the ApiManager for accessing the API service.

Method Detail

iterator

protected final <T> EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<T>>> iterator(String relativePath,
                                                                                               com.fasterxml.jackson.core.type.TypeReference<List<T>> pageType)
                                                                                        throws EvrythngClientException

Throws:

EvrythngClientException

post

public <T> EvrythngApiBuilder.Builder<T> post(String relativePath,
                                              Object data,
                                              com.fasterxml.jackson.core.type.TypeReference<T> type)
                                       throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing POST requests. Expects 201 (created) return code

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

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

type - the TypeReference for mapping the HttpResponse entity.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing POST requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.post(String, URI, Object, Status, TypeReference)

post

public <T> EvrythngApiBuilder.Builder<T> post(String relativePath,
                                              Object data,
                                              Status expected,
                                              com.fasterxml.jackson.core.type.TypeReference<T> type)
                                       throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing POST requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

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

expected - The expected return status

type - the TypeReference for mapping the HttpResponse entity.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing POST requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.post(String, URI, Object, Status, TypeReference)

postMultipart

public <T> EvrythngApiBuilder.Builder<T> postMultipart(String relativePath,
                                                       File file,
                                                       com.fasterxml.jackson.core.type.TypeReference<T> type)
                                                throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via POST requests

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

file - file

type - the TypeReference for mapping the HttpResponse entity

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing POST requests

Throws:

EvrythngClientException

See Also:

postMultipart(String, File, Status, TypeReference)

postMultipart

public <T> EvrythngApiBuilder.Builder<T> postMultipart(String relativePath,
                                                       File file,
                                                       Status expected,
                                                       com.fasterxml.jackson.core.type.TypeReference<T> type)
                                                throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via POST requests

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

file - file

expected - expected return Status

type - the TypeReference for mapping the HttpResponse entity

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing POST requests

Throws:

EvrythngClientException

putMultipart

public <T> EvrythngApiBuilder.Builder<T> putMultipart(String relativePath,
                                                      File file,
                                                      com.fasterxml.jackson.core.type.TypeReference<T> type)
                                               throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via PUT requests

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

file - file

type - the TypeReference for mapping the HttpResponse entity

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing PUT requests

Throws:

EvrythngClientException

See Also:

postMultipart(String, File, Status, TypeReference)

putMultipart

public <T> EvrythngApiBuilder.Builder<T> putMultipart(String relativePath,
                                                      File file,
                                                      Status expected,
                                                      com.fasterxml.jackson.core.type.TypeReference<T> type)
                                               throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for uploading file via PUT requests

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

file - file

expected - expected return Status

type - the TypeReference for mapping the HttpResponse entity

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing PUT requests

Throws:

EvrythngClientException

postAsynchronously

public EvrythngApiBuilder.Builder<AcceptedResourceResponse> postAsynchronously(String relativePath,
                                                                               Object data,
                                                                               Pattern pattern)
                                                                        throws EvrythngClientException

Throws:

EvrythngClientException

get

public <T> EvrythngApiBuilder.Builder<T> get(String relativePath,
                                             com.fasterxml.jackson.core.type.TypeReference<T> type)
                                      throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing GET requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

type - the TypeReference for mapping the HttpResponse entity.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing GET requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.get(String, URI, Status, TypeReference)

put

public <T> EvrythngApiBuilder.Builder<T> put(String relativePath,
                                             Object data,
                                             Status expected,
                                             com.fasterxml.jackson.core.type.TypeReference<T> type)
                                      throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

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

expected - the expected Status code of the future request. Will be checked.

type - the TypeReference for mapping the HttpResponse entity.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing PUT requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.post(String, URI, Object, Status, TypeReference)

put

public <T> EvrythngApiBuilder.Builder<T> put(String relativePath,
                                             Object data,
                                             com.fasterxml.jackson.core.type.TypeReference<T> type)
                                      throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

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

type - the TypeReference for mapping the HttpResponse entity.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing PUT requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.put(String, URI, Object, Status, TypeReference)

putMultiple

public EvrythngApiBuilder.Builder<Long> putMultiple(String relativePath,
                                                    Object data)
                                             throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing PUT requests. The reference return type is Long, and will contain the amount of updated documents.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

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

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing PUT requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.putMultiple(String, URI, Object, Status)

delete

public EvrythngApiBuilder.Builder<Boolean> delete(String relativePath)
                                           throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing DELETE requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing DELETE requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.post(String, URI, Object, Status, TypeReference)

deleteMultiple

public EvrythngApiBuilder.Builder<Long> deleteMultiple(String relativePath)
                                                throws EvrythngClientException

Returns a preconfigured EvrythngApiBuilder.Builder for executing bulk DELETE requests.

Parameters:

relativePath - the relative path of the API endpoint. It will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

Returns:

a preconfigured EvrythngApiBuilder.Builder for executing DELETE requests

Throws:

EvrythngClientException

See Also:

EvrythngApiBuilder.deleteMultiple(String, URI, Status)

absoluteUri

protected URI absoluteUri(String relativePath)
                   throws EvrythngClientException

Builds an absolute URI using the provided relativePath and the predefined ApiConfiguration.getUrl().

Parameters:

relativePath - the relative path that will be appended to ApiConfiguration.getUrl() in order to build the absolute endpoint URL.

Returns:

the absolute endpoint URI

Throws:

EvrythngClientException

mqttUrl

protected String mqttUrl()
                  throws EvrythngClientException

Throws:

EvrythngClientException

getConfig

public ApiConfiguration getConfig()

onBuilderCreated

protected void onBuilderCreated(EvrythngApiBuilder.Builder<?> builder)

urlEncodePathPart

protected static String urlEncodePathPart(String s)

encodeBase64

protected String encodeBase64(InputStream image,
                              String mime)
                       throws IOException

Throws:

IOException