com.evrythng.java.wrapper.service

Class ProductService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.ProductService

public class ProductService
extends EvrythngServiceBase

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionDeserializer	deserializer
static String	PATH_PRODUCT
static String	PATH_PRODUCT_ACTIONS
static String	PATH_PRODUCT_ALL_ACTION
static String	PATH_PRODUCT_ALL_ACTIONS
static String	PATH_PRODUCT_PROPERTIES
static String	PATH_PRODUCT_PROPERTY
static String	PATH_PRODUCT_REDIRECTOR
static String	PATH_PRODUCT_REDIRECTOR_QR
static String	PATH_PRODUCT_TYPED_ACTION
static String	PATH_PRODUCT_TYPED_ACTIONS
static String	PATH_PRODUCTS

Constructor Summary

Constructors

Constructor and Description
ProductService(ApiManager apiManager, EvrythngJacksonModule evrythngJacksonModule)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<Action>	actionAllCreator(String productId, Action action) Creates an action using /products/../actions/all endpoint.
<T extends Action> EvrythngApiBuilder.Builder<T>	actionCreator(String productId, T action) Creates an action.
<T extends Action> EvrythngApiBuilder.Builder<T>	actionReader(String productId, Class<T> actionClass, String actionId) Gets one action by actionId and type.
EvrythngApiBuilder.Builder<Action>	actionReader(String productId, String actionId) Gets one action by actionId.
EvrythngApiBuilder.Builder<CustomAction>	actionReader(String productId, String customType, String actionId) Gets one action by actionId and type.
EvrythngApiBuilder.Builder<List<Action>>	actionsReader(String productId) Gets all the actions.
<T extends Action> EvrythngApiBuilder.Builder<List<T>>	actionsReader(String productId, Class<T> actionClass) Gets all the action of a type.
EvrythngApiBuilder.Builder<List<CustomAction>>	actionsReader(String productId, 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<Product>>>	iterator() Retrieves Products, whether all, by filter, or by ids, in an iterative way.
EvrythngApiBuilder.Builder<Product>	productCreator(Product product) POST "/products"
EvrythngApiBuilder.Builder<Boolean>	productDeleter(String productId) DELETE "/products/%s"
EvrythngApiBuilder.Builder<Product>	productReader(String productId) GET "/products/%s"
EvrythngApiBuilder.Builder<Long>	productsDeleter() Bulk delete some products.
EvrythngApiBuilder.Builder<Long>	productsUpdater(Product product) Batch update a list of Product.
EvrythngApiBuilder.Builder<Product>	productUpdater(String productId, Product product) PUT "/products/%s"
EvrythngApiBuilder.Builder<List<Property<?>>>	propertiesCreator(String productId, List<Property<?>> properties) PUT "/products/%s/properties"
EvrythngApiBuilder.Builder<Boolean>	propertiesDeleter(String productId) DELETE "/products/%s/properties"
EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Property<?>>>>	propertiesIterator(String productId, String key) Retrieves Property updates with specified key, for a Product, in an iterative way.
EvrythngApiBuilder.Builder<List<Property<?>>>	propertiesReader(String productId) GET "/products/%s/properties"
EvrythngApiBuilder.Builder<Boolean>	propertyDeleter(String productId, String key) DELETE "/products/%s/properties/%s"
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyReader(String productId, 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 productId, String key, Boolean value, Long timestamp)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, Number value)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String productId, String key, Number value, Long timestamp)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String productId, String key, Property<?> update) PUT "/products/%s/properties/%s"
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String thngId, String key, String value)
EvrythngApiBuilder.Builder<List<Property<?>>>	propertyUpdater(String productId, String key, String value, Long timestamp)
EvrythngApiBuilder.Builder<Redirector>	redirectorCreator(String productId, Redirector redirection) POST "/products/%s/redirector"
EvrythngApiBuilder.Builder<Boolean>	redirectorDeleter(String productId) DELETE "/products/%s/redirector"
EvrythngApiBuilder.Builder<Redirector>	redirectorReader(String productId) GET "/products/%s/redirector"
EvrythngApiBuilder.Builder<Redirector>	redirectorUpdater(String productId, Redirector redirection) PUT "/products/%s/redirector"

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_PRODUCTS

public static final String PATH_PRODUCTS

See Also:

Constant Field Values

PATH_PRODUCT

public static final String PATH_PRODUCT

See Also:

Constant Field Values

PATH_PRODUCT_PROPERTIES

public static final String PATH_PRODUCT_PROPERTIES

See Also:

Constant Field Values

PATH_PRODUCT_PROPERTY

public static final String PATH_PRODUCT_PROPERTY

See Also:

Constant Field Values

PATH_PRODUCT_REDIRECTOR

public static final String PATH_PRODUCT_REDIRECTOR

See Also:

Constant Field Values

PATH_PRODUCT_REDIRECTOR_QR

public static final String PATH_PRODUCT_REDIRECTOR_QR

See Also:

Constant Field Values

PATH_PRODUCT_ACTIONS

public static final String PATH_PRODUCT_ACTIONS

See Also:

Constant Field Values

PATH_PRODUCT_ALL_ACTIONS

public static final String PATH_PRODUCT_ALL_ACTIONS

See Also:

Constant Field Values

PATH_PRODUCT_ALL_ACTION

public static final String PATH_PRODUCT_ALL_ACTION

See Also:

Constant Field Values

PATH_PRODUCT_TYPED_ACTIONS

public static final String PATH_PRODUCT_TYPED_ACTIONS

See Also:

Constant Field Values

PATH_PRODUCT_TYPED_ACTION

public static final String PATH_PRODUCT_TYPED_ACTION

See Also:

Constant Field Values

deserializer

protected ActionDeserializer deserializer

Constructor Detail

ProductService

public ProductService(ApiManager apiManager,
                      EvrythngJacksonModule evrythngJacksonModule)

Method Detail

productCreator

public EvrythngApiBuilder.Builder<Product> productCreator(Product product)
                                                   throws EvrythngClientException

POST "/products"

Parameters:

product - Product instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

iterator

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

Retrieves Products, 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.

productReader

public EvrythngApiBuilder.Builder<Product> productReader(String productId)
                                                  throws EvrythngClientException

GET "/products/%s"

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

productsUpdater

public EvrythngApiBuilder.Builder<Long> productsUpdater(Product product)
                                                 throws EvrythngClientException

Batch update a list of Product. Select the {Product}s to update using query parameters ?ids or ?filter.

PUT "/products"

Parameters:

product - Product instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

productUpdater

public EvrythngApiBuilder.Builder<Product> productUpdater(String productId,
                                                          Product product)
                                                   throws EvrythngClientException

PUT "/products/%s"

Parameters:

productId - product id

product - Product instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

productDeleter

public EvrythngApiBuilder.Builder<Boolean> productDeleter(String productId)
                                                   throws EvrythngClientException

DELETE "/products/%s"

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

productsDeleter

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

Bulk delete some products. Select the {Product}s to delete using query parameters ?ids or ?filter.

DELETE "/products"

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesCreator

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

PUT "/products/%s/properties"

Parameters:

productId - product id

properties - list of Property

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesReader

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

GET "/products/%s/properties"

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertiesIterator

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

Retrieves Property updates with specified key, for a Product, 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 productId)
                                                      throws EvrythngClientException

DELETE "/products/%s/properties"

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyReader

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

Deprecated. use propertiesIterator(String, String) instead.

GET "/products/%s/properties/%s"

Parameters:

productId - product id

key - key

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyUpdater

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

PUT "/products/%s/properties/%s"

Parameters:

productId - product id

key - key

update - property update

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

propertyUpdater

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

Throws:

EvrythngClientException

propertyUpdater

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

Throws:

EvrythngClientException

propertyUpdater

public EvrythngApiBuilder.Builder<List<Property<?>>> propertyUpdater(String productId,
                                                                     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 productId,
                                                           String key)
                                                    throws EvrythngClientException

DELETE "/products/%s/properties/%s"

Parameters:

productId - product id

key - key

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorCreator

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

POST "/products/%s/redirector"

Creates a redirector for the Product.

Parameters:

productId - product id

redirection - Redirector instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorReader

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

GET "/products/%s/redirector"

Retrieves the redirector for the Product.

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorDeleter

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

DELETE "/products/%s/redirector"

Deletes the redirector for the Product.

Parameters:

productId - product id

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

redirectorUpdater

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

PUT "/products/%s/redirector"

Updates the redirector for the Product.

Parameters:

productId - product id

redirection - Redirector instance

Returns:

a pre-configured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

actionCreator

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

Creates an action.

Throws:

EvrythngClientException

actionAllCreator

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

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

Throws:

EvrythngClientException

actionReader

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

Gets one action by actionId and type.

Throws:

EvrythngClientException

actionReader

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

Gets one action by actionId and type.

Throws:

EvrythngClientException

actionReader

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

Gets one action by actionId.

Throws:

EvrythngClientException

actionsReader

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

Gets all the actions.

Throws:

EvrythngClientException

actionsReader

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

Gets all the action of a type.

Throws:

EvrythngClientException

actionsReader

public EvrythngApiBuilder.Builder<List<CustomAction>> actionsReader(String productId,
                                                                    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)