com.evrythng.java.wrapper.service

Class ThngService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.ThngService

public class ThngService
extends EvrythngServiceBase

Service wrapper for the /thngs endpoint of the EVRYTHNG Engine API.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionDeserializer	deserializer
static String	PATH_THNG
static String	PATH_THNG_ACTIONS
static String	PATH_THNG_ALL_ACTION
static String	PATH_THNG_ALL_ACTIONS
static String	PATH_THNG_LOCATION
static String	PATH_THNG_PROPERTIES
static String	PATH_THNG_PROPERTY
static String	PATH_THNG_REDIRECTOR
static String	PATH_THNG_REDIRECTOR_QR
static String	PATH_THNG_TYPED_ACTION
static String	PATH_THNG_TYPED_ACTIONS
static String	PATH_THNGS

Constructor Summary

Constructors

Constructor and Description
ThngService(ApiManager apiManager, EvrythngJacksonModule evrythngJacksonModule)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<Action>	actionAllCreator(String thngId, Action action) Creates an action using /thngs/../actions/all endpoint.
<T extends Action> EvrythngApiBuilder.Builder<T>	actionCreator(String thngId, T action) Creates an action.
<T extends Action> EvrythngApiBuilder.Builder<T>	actionReader(String thngId, Class<T> actionClass, String actionId) Gets one action by actionId and type.
EvrythngApiBuilder.Builder<Action>	actionReader(String thngId, String actionId) Gets one action by actionId.
EvrythngApiBuilder.Builder<CustomAction>	actionReader(String thngId, String customType, String actionId) Gets one action by actionId and type.
EvrythngApiBuilder.Builder<List<Action>>	actionsReader(String thngId) Gets all the actions.
<T extends Action> EvrythngApiBuilder.Builder<List<T>>	actionsReader(String thngId, Class<T> actionClass) Gets all the action of a type.
EvrythngApiBuilder.Builder<List<CustomAction>>	actionsReader(String thngId, String customType) Gets all the action of a type.
protected void	checkCustomType(String customType)
<T extends Action> String	getType(Class<T> actionClass)
EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Thng>>>	iterator() Retrieves Thngs, whether all, by filter, or by ids, in an iterative way.
EvrythngApiBuilder.Builder<Boolean>	locationDeleter(String thngId) Deletes the Location of the referenced Thng.
EvrythngApiBuilder.Builder<List<Location>>	locationReader(String thngId) Retrieves the last Location resources from the referenced Thng.
EvrythngApiBuilder.Builder<List<Location>>	locationUpdater(String thngId, List<Location> locations) Updates the referenced Thng with multiple Location resources.
EvrythngApiBuilder.Builder<List<Location>>	locationUpdater(String thngId, Location location) Updates the current Location of the referenced Thng.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertiesCreator(String thngId, List<Property<?>> properties) Creates multiple StringProperty resources on the referenced Thng.
EvrythngApiBuilder.Builder<Boolean>	propertiesDeleter(String thngId) Deletes all StringProperty resources from the referenced Thng.
EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Property<?>>>>	propertiesIterator(String thngId, String key) Retrieves Property updates with specified key, for a Thng, in an iterative way.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertiesReader(String thngId) Retrieves the last updated StringProperty resources from the referenced Thng.
EvrythngApiBuilder.Builder<Boolean>	propertyDeleter(String thngId, String key) Deletes the StringProperty named key from the referenced Thng.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyReader(String thngId, String key) Deprecated. use propertiesIterator(String, String) instead.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Boolean value)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Boolean value, Long timestamp)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Number value)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Number value, Long timestamp)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Property<?> update) Updates the StringProperty named key of the referenced Thng.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, String value)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, String value, Long timestamp)
EvrythngApiBuilder.Builder<Redirector>	redirectorCreator(String thngId, Redirector redirection) Creates a redirector for the Thng.
EvrythngApiBuilder.Builder<Boolean>	redirectorDeleter(String thngId) Deletes the redirector for the Thng.
EvrythngApiBuilder.Builder<Redirector>	redirectorReader(String thngId) Retrieves the redirector for the Thng.
EvrythngApiBuilder.Builder<Redirector>	redirectorUpdater(String thngId, Redirector redirection) Updates the redirector for the Thng.
EvrythngApiBuilder.Builder<Thng>	thngCreator(Thng thng) Creates a new Thng.
EvrythngApiBuilder.Builder<Boolean>	thngDeleter(String thngId) Deletes the referenced Thng.
EvrythngApiBuilder.Builder<Thng>	thngReader(String thngId) Retrieves the referenced Thng.
EvrythngApiBuilder.Builder<Long>	thngsDeleter() Bulk delete some thngs.
EvrythngApiBuilder.Builder<Long>	thngsUpdater(Thng thng) Batch update a list of Thng.
EvrythngApiBuilder.Builder<Thng>	thngUpdater(String thngId, Thng thng) Updates the referenced Thng.

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_THNGS

public static final String PATH_THNGS

See Also:

Constant Field Values

PATH_THNG

public static final String PATH_THNG

See Also:

Constant Field Values

PATH_THNG_PROPERTIES

public static final String PATH_THNG_PROPERTIES

See Also:

Constant Field Values

PATH_THNG_PROPERTY

public static final String PATH_THNG_PROPERTY

See Also:

Constant Field Values

PATH_THNG_LOCATION

public static final String PATH_THNG_LOCATION

See Also:

Constant Field Values

PATH_THNG_REDIRECTOR

public static final String PATH_THNG_REDIRECTOR

See Also:

Constant Field Values

PATH_THNG_REDIRECTOR_QR

public static final String PATH_THNG_REDIRECTOR_QR

See Also:

Constant Field Values

PATH_THNG_ACTIONS

public static final String PATH_THNG_ACTIONS

See Also:

Constant Field Values

PATH_THNG_ALL_ACTIONS

public static final String PATH_THNG_ALL_ACTIONS

See Also:

Constant Field Values

PATH_THNG_ALL_ACTION

public static final String PATH_THNG_ALL_ACTION

See Also:

Constant Field Values

PATH_THNG_TYPED_ACTIONS

public static final String PATH_THNG_TYPED_ACTIONS

See Also:

Constant Field Values

PATH_THNG_TYPED_ACTION

public static final String PATH_THNG_TYPED_ACTION

See Also:

Constant Field Values

deserializer

protected ActionDeserializer deserializer

Constructor Detail

ThngService

public ThngService(ApiManager apiManager,
                   EvrythngJacksonModule evrythngJacksonModule)

Method Detail

thngCreator

public EvrythngApiBuilder.Builder<Thng> thngCreator(Thng thng)
                                             throws EvrythngClientException

Creates a new Thng.

POST "/thngs"

Parameters:

thng - Thng instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

iterator

public final EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Thng>>> iterator()
                                                                                    throws EvrythngClientException

Retrieves Thngs, whether all, by filter, or by ids, in an iterative way.

Returns:

A remote iterator that keeps returning a page, with size specified by the EvrythngApiBuilder.Builder.perPage(int) method, until all matching resources are returned.

Throws:

EvrythngClientException - in case server communication fails.

thngReader

public EvrythngApiBuilder.Builder<Thng> thngReader(String thngId)
                                            throws EvrythngClientException

Retrieves the referenced Thng.

GET "/thngs/%s"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngUpdater

public EvrythngApiBuilder.Builder<Thng> thngUpdater(String thngId,
                                                    Thng thng)
                                             throws EvrythngClientException

Updates the referenced Thng.

PUT "/thngs/%s"

Parameters:

thngId - thng id

thng - Thng instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngsUpdater

public EvrythngApiBuilder.Builder<Long> thngsUpdater(Thng thng)
                                              throws EvrythngClientException

Batch update a list of Thng. Select the Thngs to update using query parameters ?ids or ?filter.

PUT "/thngs"

Parameters:

thng - Thng instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngDeleter

public EvrythngApiBuilder.Builder<Boolean> thngDeleter(String thngId)
                                                throws EvrythngClientException

Deletes the referenced Thng.

DELETE "/thngs/%s"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngsDeleter

public EvrythngApiBuilder.Builder<Long> thngsDeleter()
                                              throws EvrythngClientException

Bulk delete some thngs. Select the Thngs to delete using query parameters ?ids or ?filter.

DELETE "/thngs"

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesCreator

public EvrythngApiBuilder.Builder<List<Property<?>>> propertiesCreator(String thngId,
                                                                       List<Property<?>> properties)
                                                                throws EvrythngClientException

Creates multiple StringProperty resources on the referenced Thng.

PUT "/thngs/%s/properties"

Parameters:

thngId - thng id

properties - list of StringProperty instances

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesReader

public EvrythngApiBuilder.Builder<List<Property<?>>> propertiesReader(String thngId)
                                                               throws EvrythngClientException

Retrieves the last updated StringProperty resources from the referenced Thng.

GET "/thngs/%s/properties"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesIterator

public final EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Property<?>>>> propertiesIterator(String thngId,
                                                                                                            String key)
                                                                                                     throws EvrythngClientException

Retrieves Property updates with specified key, for a Thng, in an iterative way.

Returns:

A remote iterator that keeps returning a page, with size specified by the EvrythngApiBuilder.Builder.perPage(int) method, until all matching resources are returned.

Throws:

EvrythngClientException - in case server communication fails.

propertiesDeleter

public EvrythngApiBuilder.Builder<Boolean> propertiesDeleter(String thngId)
                                                      throws EvrythngClientException

Deletes all StringProperty resources from the referenced Thng.

DELETE "/thngs/%s/properties"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyReader

@Deprecated
public EvrythngApiBuilder.Builder<List<Property<?>>> propertyReader(String thngId,
                                                                                String key)
                                                                         throws EvrythngClientException

Deprecated. use propertiesIterator(String, String) instead.

Retrieves the last values of the StringProperty named key from the referenced Thng.

GET "/thngs/%s/properties/%s"

Parameters:

thngId - thng id

key - key

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     Property<?> update)
                                                              throws EvrythngClientException

Updates the StringProperty named key of the referenced Thng.

PUT "/thngs/%s/properties/%s"

Parameters:

thngId - thng id

key - key

update - property update

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     String value,
                                                                     Long timestamp)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     Number value,
                                                                     Long timestamp)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     Boolean value,
                                                                     Long timestamp)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     String value)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     Number value)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String thngId,
                                                                     String key,
                                                                     Boolean value)
                                                              throws EvrythngClientException

Throws:

EvrythngClientException

propertyDeleter

public EvrythngApiBuilder.Builder<Boolean> propertyDeleter(String thngId,
                                                           String key)
                                                    throws EvrythngClientException

Deletes the StringProperty named key from the referenced Thng.

DELETE "/thngs/%s/properties/%s"

Parameters:

thngId - thng id

key - key

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

locationReader

public EvrythngApiBuilder.Builder<List<Location>> locationReader(String thngId)
                                                          throws EvrythngClientException

Retrieves the last Location resources from the referenced Thng.

GET "/thngs/%s/location"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

locationUpdater

public EvrythngApiBuilder.Builder<List<Location>> locationUpdater(String thngId,
                                                                  Location location)
                                                           throws EvrythngClientException

Updates the current Location of the referenced Thng.

PUT "/thngs/%s/location"

Parameters:

thngId - thng id

location - Location instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

See Also:

locationUpdater(String, List)

locationUpdater

public EvrythngApiBuilder.Builder<List<Location>> locationUpdater(String thngId,
                                                                  List<Location> locations)
                                                           throws EvrythngClientException

Updates the referenced Thng with multiple Location resources.

PUT "/thngs/%s/location"

Parameters:

thngId - thng id

locations - list of Location

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

locationDeleter

public EvrythngApiBuilder.Builder<Boolean> locationDeleter(String thngId)
                                                    throws EvrythngClientException

Deletes the Location of the referenced Thng.

DELETE "/thngs/%s/location"

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorCreator

public EvrythngApiBuilder.Builder<Redirector> redirectorCreator(String thngId,
                                                                Redirector redirection)
                                                         throws EvrythngClientException

Creates a redirector for the Thng.

Parameters:

thngId - thng id

redirection - Redirector instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorReader

public EvrythngApiBuilder.Builder<Redirector> redirectorReader(String thngId)
                                                        throws EvrythngClientException

Retrieves the redirector for the Thng.

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorDeleter

public EvrythngApiBuilder.Builder<Boolean> redirectorDeleter(String thngId)
                                                      throws EvrythngClientException

Deletes the redirector for the Thng.

Parameters:

thngId - thng id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorUpdater

public EvrythngApiBuilder.Builder<Redirector> redirectorUpdater(String thngId,
                                                                Redirector redirection)
                                                         throws EvrythngClientException

Updates the redirector for the Thng.

Parameters:

thngId - thng id

redirection - Redirector instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

actionCreator

public <T extends Action> EvrythngApiBuilder.Builder<T> actionCreator(String thngId,
                                                                      T action)
                                                               throws EvrythngClientException

Creates an action.

Throws:

EvrythngClientException

actionAllCreator

public EvrythngApiBuilder.Builder<Action> actionAllCreator(String thngId,
                                                           Action action)
                                                    throws EvrythngClientException

Creates an action using /thngs/../actions/all endpoint.

Throws:

EvrythngClientException

actionReader

public <T extends Action> EvrythngApiBuilder.Builder<T> actionReader(String thngId,
                                                                     Class<T> actionClass,
                                                                     String actionId)
                                                              throws EvrythngClientException

Gets one action by actionId and type.

Throws:

EvrythngClientException

actionReader

public EvrythngApiBuilder.Builder<CustomAction> actionReader(String thngId,
                                                             String customType,
                                                             String actionId)
                                                      throws EvrythngClientException

Gets one action by actionId and type.

Throws:

EvrythngClientException

actionReader

public EvrythngApiBuilder.Builder<Action> actionReader(String thngId,
                                                       String actionId)
                                                throws EvrythngClientException

Gets one action by actionId.

Throws:

EvrythngClientException

actionsReader

public EvrythngApiBuilder.Builder<List<Action>> actionsReader(String thngId)
                                                       throws EvrythngClientException

Gets all the actions.

Throws:

EvrythngClientException

actionsReader

public <T extends Action> EvrythngApiBuilder.Builder<List<T>> actionsReader(String thngId,
                                                                            Class<T> actionClass)
                                                                     throws EvrythngClientException

Gets all the action of a type.

Throws:

EvrythngClientException

actionsReader

public EvrythngApiBuilder.Builder<List<CustomAction>> actionsReader(String thngId,
                                                                    String customType)
                                                             throws EvrythngClientException

Gets all the action of a type.

Throws:

EvrythngClientException

checkCustomType

protected void checkCustomType(String customType)

getType

public <T extends Action> String getType(Class<T> actionClass)