com.sitewhere.web.rest.controllers

Class BatchOperationsController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.BatchOperationsController

@Controller
@RequestMapping(value="/batch")
public class BatchOperationsController
extends RestController

Controller for batch operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
BatchOperationsController()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.sitewhere.spi.device.command.IDeviceCommand	assureDeviceCommand(String token, javax.servlet.http.HttpServletRequest servletRequest) Get a device command by unique token.
com.sitewhere.spi.device.batch.IBatchOperation	createBatchCommandByCriteria(com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest request, javax.servlet.http.HttpServletRequest servletRequest) Create a batch operation that invokes a command for all devices that match the given criteria.
com.sitewhere.spi.device.batch.IBatchOperation	createBatchCommandInvocation(com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest request, javax.servlet.http.HttpServletRequest servletRequest)
com.sitewhere.spi.device.batch.IBatchOperation	getBatchOperationByToken(String batchToken, javax.servlet.http.HttpServletRequest servletRequest)
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.batch.IBatchElement>	listBatchOperationElements(String operationToken, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest)
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.batch.IBatchOperation>	listBatchOperations(boolean includeDeleted, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest)
com.sitewhere.spi.scheduling.IScheduledJob	scheduleBatchCommandByCriteria(com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest request, String scheduleToken, javax.servlet.http.HttpServletRequest servletRequest) Schedule job that will create a new batch command invocation based on the given criteria.

Methods inherited from class com.sitewhere.web.rest.RestController

getTenant, getTenantAuthToken, handleAccessDenied, handleMissingContent, handleRuntimeException, handleSuccessfulAdd, handleSystemException

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchOperationsController

public BatchOperationsController()

Method Detail

getBatchOperationByToken

@RequestMapping(value="/{batchToken}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.batch.IBatchOperation getBatchOperationByToken(@PathVariable
                                                                                                          String batchToken,
                                                                                                          javax.servlet.http.HttpServletRequest servletRequest)
                                                                        throws com.sitewhere.spi.SiteWhereException

Throws:

com.sitewhere.spi.SiteWhereException

listBatchOperations

@RequestMapping(method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.batch.IBatchOperation> listBatchOperations(@RequestParam(defaultValue="false")
                                                                                                                                              boolean includeDeleted,
                                                                                                                                              @RequestParam(required=false,defaultValue="1")
                                                                                                                                              int page,
                                                                                                                                              @RequestParam(required=false,defaultValue="100")
                                                                                                                                              int pageSize,
                                                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                            throws com.sitewhere.spi.SiteWhereException

Throws:

com.sitewhere.spi.SiteWhereException

listBatchOperationElements

@RequestMapping(value="/{operationToken}/elements",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.batch.IBatchElement> listBatchOperationElements(@PathVariable
                                                                                                                                                   String operationToken,
                                                                                                                                                   @RequestParam(required=false,defaultValue="1")
                                                                                                                                                   int page,
                                                                                                                                                   @RequestParam(required=false,defaultValue="100")
                                                                                                                                                   int pageSize,
                                                                                                                                                   javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                                 throws com.sitewhere.spi.SiteWhereException

Throws:

com.sitewhere.spi.SiteWhereException

createBatchCommandInvocation

@RequestMapping(value="/command",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.batch.IBatchOperation createBatchCommandInvocation(@RequestBody
                                                                                                              com.sitewhere.rest.model.device.request.BatchCommandInvocationRequest request,
                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                                                            throws com.sitewhere.spi.SiteWhereException

Throws:

com.sitewhere.spi.SiteWhereException

createBatchCommandByCriteria

@RequestMapping(value="/command/criteria",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.batch.IBatchOperation createBatchCommandByCriteria(@RequestBody
                                                                                                              com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest request,
                                                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                                                            throws com.sitewhere.spi.SiteWhereException

Create a batch operation that invokes a command for all devices that match the given criteria.

Parameters:

request -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

scheduleBatchCommandByCriteria

@RequestMapping(value="/command/criteria/schedules/{scheduleToken}",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.scheduling.IScheduledJob scheduleBatchCommandByCriteria(@RequestBody
                                                                                                            com.sitewhere.rest.model.device.request.BatchCommandForCriteriaRequest request,
                                                                                                            @PathVariable
                                                                                                            String scheduleToken,
                                                                                                            javax.servlet.http.HttpServletRequest servletRequest)
                                                                          throws com.sitewhere.spi.SiteWhereException

Schedule job that will create a new batch command invocation based on the given criteria.

Parameters:

request -

scheduleToken -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

assureDeviceCommand

protected com.sitewhere.spi.device.command.IDeviceCommand assureDeviceCommand(String token,
                                                                  javax.servlet.http.HttpServletRequest servletRequest)
                                                                       throws com.sitewhere.spi.SiteWhereException

Get a device command by unique token. Throw an exception if not found.

Parameters:

token -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException