com.sitewhere.web.rest.controllers

Class CommandsController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.CommandsController

@Controller
@RequestMapping(value="/commands")
public class CommandsController
extends RestController

Controller for device command operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
CommandsController()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.sitewhere.spi.device.command.IDeviceCommand	assertDeviceCommandByToken(String token, javax.servlet.http.HttpServletRequest servletRequest) Gets a device command by token and throws an exception if not found.
com.sitewhere.spi.device.command.IDeviceCommand	deleteDeviceCommand(String token, boolean force, javax.servlet.http.HttpServletRequest servletRequest) Delete an existing device command.
com.sitewhere.spi.device.command.IDeviceCommand	getDeviceCommandByToken(String token, javax.servlet.http.HttpServletRequest servletRequest) Get a device command by unique token.
com.sitewhere.spi.device.command.IDeviceCommand	updateDeviceCommand(String token, com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update an existing device command.

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

CommandsController

public CommandsController()

Method Detail

updateDeviceCommand

@RequestMapping(value="/{token}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.command.IDeviceCommand updateDeviceCommand(@PathVariable
                                                                                                      String token,
                                                                                                      @RequestBody
                                                                                                      com.sitewhere.rest.model.device.request.DeviceCommandCreateRequest request,
                                                                                                      javax.servlet.http.HttpServletRequest servletRequest)
                                                                    throws com.sitewhere.spi.SiteWhereException

Update an existing device command.

Parameters:

token -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getDeviceCommandByToken

@RequestMapping(value="/{token}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.command.IDeviceCommand getDeviceCommandByToken(@PathVariable
                                                                                                          String token,
                                                                                                          javax.servlet.http.HttpServletRequest servletRequest)
                                                                        throws com.sitewhere.spi.SiteWhereException

Get a device command by unique token.

Parameters:

hardwareId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteDeviceCommand

@RequestMapping(value="/{token}",
                method=DELETE)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.device.command.IDeviceCommand deleteDeviceCommand(@PathVariable
                                                                                                      String token,
                                                                                                      @RequestParam(defaultValue="false")
                                                                                                      boolean force,
                                                                                                      javax.servlet.http.HttpServletRequest servletRequest)
                                                                    throws com.sitewhere.spi.SiteWhereException

Delete an existing device command.

Parameters:

token -

force -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

assertDeviceCommandByToken

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

Gets a device command by token and throws an exception if not found.

Parameters:

token -

servletRequest -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException