com.evrythng.java.wrapper.service

Class ActionService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.ActionService

public class ActionService
extends EvrythngServiceBase

Service wrapper for the /actions endpoint of the EVRYTHNG API.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionDeserializer	deserializer
static String	PATH_ACTIONS
static String	PATH_ALL_ACTION
static String	PATH_ALL_ACTIONS
static String	PATH_TYPED_ACTION
static String	PATH_TYPED_ACTIONS

Constructor Summary

Constructors

Constructor and Description
ActionService(ApiManager apiManager, EvrythngJacksonModule evrythngJacksonModule)

Method Summary

Modifier and Type	Method and Description
<T extends Action> EvrythngApiBuilder.Builder<T>	actionCreator(T action) Creates an action.
<T extends Action> EvrythngApiBuilder.Builder<Boolean>	actionDeleter(Class<T> actionClass, String id) Deletes one action by id and type.
EvrythngApiBuilder.Builder<Boolean>	actionDeleter(String customType, String id) Deletes one action by id and type.
<T extends Action> EvrythngApiBuilder.Builder<T>	actionReader(Class<T> actionClass, String id) Gets one action by id and type.
EvrythngApiBuilder.Builder<Action>	actionReader(String id) Gets one action by id.
EvrythngApiBuilder.Builder<CustomAction>	actionReader(String customType, String id) Gets one action by id and type.
EvrythngApiBuilder.Builder<Actions>	actionsCreator(Actions actions) Creates an action.
EvrythngApiBuilder.Builder<List<Action>>	actionsReader() Deprecated. use iterator() instead.
<T extends Action> EvrythngApiBuilder.Builder<List<T>>	actionsReader(Class<T> actionClass) Gets all the action of a type.
EvrythngApiBuilder.Builder<List<CustomAction>>	actionsReader(String customType) Deprecated. use iterator(String) instead.
EvrythngApiBuilder.Builder<ActionType>	actionTypeCreator(ActionType type) Creates an action type.
EvrythngApiBuilder.Builder<Boolean>	actionTypeDeleter(String type) Deletes an action type and all actions of this type.
EvrythngApiBuilder.Builder<List<ActionType>>	actionTypesReader() Gets the custom types and the built-in action types.
EvrythngApiBuilder.Builder<ActionType>	actionTypeUpdater(String actionTypeName, ActionType update) Updates an action type.
protected void	checkCustomType(String customType)
<T extends Action> String	getType(Class<T> actionClass)
EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Action>>>	iterator()
EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Action>>>	iterator(String actionTypeName)

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_ACTIONS

public static final String PATH_ACTIONS

See Also:

Constant Field Values

PATH_ALL_ACTIONS

public static final String PATH_ALL_ACTIONS

See Also:

Constant Field Values

PATH_ALL_ACTION

public static final String PATH_ALL_ACTION

See Also:

Constant Field Values

PATH_TYPED_ACTIONS

public static final String PATH_TYPED_ACTIONS

See Also:

Constant Field Values

PATH_TYPED_ACTION

public static final String PATH_TYPED_ACTION

See Also:

Constant Field Values

deserializer

protected ActionDeserializer deserializer

Constructor Detail

ActionService

public ActionService(ApiManager apiManager,
                     EvrythngJacksonModule evrythngJacksonModule)

Parameters:

apiManager - ApiManager instance

Method Detail

actionTypesReader

public EvrythngApiBuilder.Builder<List<ActionType>> actionTypesReader()
                                                               throws EvrythngClientException

Gets the custom types and the built-in action types.

Throws:

EvrythngClientException

actionTypeCreator

public EvrythngApiBuilder.Builder<ActionType> actionTypeCreator(ActionType type)
                                                         throws EvrythngClientException

Creates an action type.

Throws:

EvrythngClientException

actionTypeDeleter

public EvrythngApiBuilder.Builder<Boolean> actionTypeDeleter(String type)
                                                      throws EvrythngClientException

Deletes an action type and all actions of this type.

Throws:

EvrythngClientException

actionCreator

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

Creates an action.

Throws:

EvrythngClientException

actionsCreator

public EvrythngApiBuilder.Builder<Actions> actionsCreator(Actions actions)
                                                   throws EvrythngClientException

Creates an action.

Throws:

EvrythngClientException

actionsReader

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

Deprecated. use iterator() instead.

Gets all the actions.

Throws:

EvrythngClientException

actionsReader

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

Gets all the action of a type.

Throws:

EvrythngClientException

actionsReader

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

Deprecated. use iterator(String) instead.

Gets all the action of a type.

Throws:

EvrythngClientException

actionReader

public EvrythngApiBuilder.Builder<Action> actionReader(String id)
                                                throws EvrythngClientException

Gets one action by id.

Throws:

EvrythngClientException

actionReader

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

Gets one action by id and type.

Throws:

EvrythngClientException

actionReader

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

Gets one action by id and type.

Throws:

EvrythngClientException

actionDeleter

public <T extends Action> EvrythngApiBuilder.Builder<Boolean> actionDeleter(Class<T> actionClass,
                                                                            String id)
                                                                     throws EvrythngClientException

Deletes one action by id and type.

Throws:

EvrythngClientException

actionDeleter

public EvrythngApiBuilder.Builder<Boolean> actionDeleter(String customType,
                                                         String id)
                                                  throws EvrythngClientException

Deletes one action by id and type.

Throws:

EvrythngClientException

actionTypeUpdater

public EvrythngApiBuilder.Builder<ActionType> actionTypeUpdater(String actionTypeName,
                                                                ActionType update)
                                                         throws EvrythngClientException

Updates an action type.

Throws:

EvrythngClientException

checkCustomType

protected void checkCustomType(String customType)

getType

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

iterator

public EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Action>>> iterator()

iterator

public EvrythngApiBuilder.Builder<Iterator<org.pcollections.PVector<Action>>> iterator(String actionTypeName)