com.sitewhere.web.rest.controllers

Class AssetsController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.AssetsController

@Controller
@RequestMapping(value="/assets")
public class AssetsController
extends RestController

Controller for site operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
AssetsController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.spi.asset.IAssetCategory	createAssetCategory(com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Create a new asset category.
com.sitewhere.spi.asset.IHardwareAsset	createHardwareAsset(String categoryId, com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Creates a new hardware asset in the category.
com.sitewhere.spi.asset.ILocationAsset	createLocationAsset(String categoryId, com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Creates a new location asset in the category.
com.sitewhere.spi.asset.IPersonAsset	createPersonAsset(String categoryId, com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Creates a new person asset in the category.
com.sitewhere.spi.asset.IAssetCategory	deleteAssetCategory(String categoryId, javax.servlet.http.HttpServletRequest servletRequest) Delete an existing asset category.
com.sitewhere.spi.asset.IAsset	deleteCategoryAsset(String categoryId, String assetId, javax.servlet.http.HttpServletRequest servletRequest) Delete an asset from a category based on unique id.
com.sitewhere.spi.asset.IAsset	getAssetById(String assetModuleId, String assetId, javax.servlet.http.HttpServletRequest servletRequest) Get an asset from an IAssetModule by unique id.
com.sitewhere.spi.asset.IAssetCategory	getAssetCategoryById(String categoryId, javax.servlet.http.HttpServletRequest servletRequest) Get an asset category by unique id.
com.sitewhere.rest.model.asset.AssetModule	getAssetModule(String assetModuleId, javax.servlet.http.HttpServletRequest servletRequest) Search for assets in an IAssetModule that meet the given criteria.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.IDeviceAssignment>	getAssignmentsForAsset(String assetModuleId, String assetId, String siteToken, String status, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) Get all assignments for a given asset.
com.sitewhere.spi.asset.IAsset	getCategoryAsset(String categoryId, String assetId, javax.servlet.http.HttpServletRequest servletRequest) Get an asset from a category by unique id.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.asset.IAssetCategory>	listAssetCategories(int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List asset categories that match the given search criteria.
List<com.sitewhere.rest.model.asset.AssetModule>	listAssetModules(String assetType, javax.servlet.http.HttpServletRequest servletRequest) List all asset modules.
com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.asset.IAsset>	listCategoryAssets(String categoryId, int page, int pageSize, javax.servlet.http.HttpServletRequest servletRequest) List all assets for a given category.
List<com.sitewhere.spi.command.ICommandResponse>	refreshModules(javax.servlet.http.HttpServletRequest servletRequest) Refresh all asset modules.
com.sitewhere.rest.model.search.SearchResults<? extends com.sitewhere.spi.asset.IAsset>	searchAssets(String assetModuleId, String criteria, javax.servlet.http.HttpServletRequest servletRequest) Search for assets in an IAssetModule that meet the given criteria.
com.sitewhere.spi.asset.IAssetCategory	updateAssetCategory(String categoryId, com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update an existing asset category.
com.sitewhere.spi.asset.IHardwareAsset	updateHardwareAsset(String categoryId, String assetId, com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update an existing hardware asset.
com.sitewhere.spi.asset.ILocationAsset	updateLocationAsset(String categoryId, String assetId, com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update an existing location asset.
com.sitewhere.spi.asset.IPersonAsset	updatePersonAsset(String categoryId, String assetId, com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest request, javax.servlet.http.HttpServletRequest servletRequest) Update an existing person asset.

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

AssetsController

public AssetsController()

Method Detail

getAssetModule

@RequestMapping(value="/modules/{assetModuleId}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.asset.AssetModule getAssetModule(@PathVariable
                                                                                            String assetModuleId,
                                                                                            javax.servlet.http.HttpServletRequest servletRequest)
                                                          throws com.sitewhere.spi.SiteWhereException

Search for assets in an IAssetModule that meet the given criteria.

Parameters:

assetModuleId -

criteria -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

searchAssets

@RequestMapping(value="/modules/{assetModuleId}/assets",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.rest.model.search.SearchResults<? extends com.sitewhere.spi.asset.IAsset> searchAssets(@PathVariable
                                                                                                                                       String assetModuleId,
                                                                                                                                       @RequestParam(defaultValue="")
                                                                                                                                       String criteria,
                                                                                                                                       javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                     throws com.sitewhere.spi.SiteWhereException

Search for assets in an IAssetModule that meet the given criteria.

Parameters:

assetModuleId -

criteria -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssetById

@RequestMapping(value="/modules/{assetModuleId}/assets/{assetId}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAsset getAssetById(@PathVariable
                                                                              String assetModuleId,
                                                                              @PathVariable
                                                                              String assetId,
                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                            throws com.sitewhere.spi.SiteWhereException

Get an asset from an IAssetModule by unique id.

Parameters:

assetModuleId -

assetId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssignmentsForAsset

@RequestMapping(value="/modules/{assetModuleId}/assets/{assetId}/assignments",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.device.IDeviceAssignment> getAssignmentsForAsset(@PathVariable
                                                                                                                                             String assetModuleId,
                                                                                                                                             @PathVariable
                                                                                                                                             String assetId,
                                                                                                                                             @RequestParam
                                                                                                                                             String siteToken,
                                                                                                                                             @RequestParam(required=false)
                                                                                                                                             String status,
                                                                                                                                             @RequestParam(required=false,defaultValue="1")
                                                                                                                                             int page,
                                                                                                                                             @RequestParam(required=false,defaultValue="100")
                                                                                                                                             int pageSize,
                                                                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                           throws com.sitewhere.spi.SiteWhereException

Get all assignments for a given asset.

Parameters:

assetModuleId -

assetId -

siteToken -

page -

pageSize -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listAssetModules

@RequestMapping(value="/modules",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public List<com.sitewhere.rest.model.asset.AssetModule> listAssetModules(@RequestParam(required=false)
                                                                                                    String assetType,
                                                                                                    javax.servlet.http.HttpServletRequest servletRequest)
                                                                  throws com.sitewhere.spi.SiteWhereException

List all asset modules.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

refreshModules

@RequestMapping(value="/modules/refresh",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public List<com.sitewhere.spi.command.ICommandResponse> refreshModules(javax.servlet.http.HttpServletRequest servletRequest)
                                                                throws com.sitewhere.spi.SiteWhereException

Refresh all asset modules.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

createAssetCategory

@RequestMapping(value="/categories",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAssetCategory createAssetCategory(@RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Create a new asset category.

Parameters:

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateAssetCategory

@RequestMapping(value="/categories/{categoryId}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAssetCategory updateAssetCategory(@PathVariable
                                                                                             String categoryId,
                                                                                             @RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.AssetCategoryCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Update an existing asset category.

Parameters:

categoryId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAssetCategoryById

@RequestMapping(value="/categories/{categoryId}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAssetCategory getAssetCategoryById(@PathVariable
                                                                                              String categoryId,
                                                                                              javax.servlet.http.HttpServletRequest servletRequest)
                                                            throws com.sitewhere.spi.SiteWhereException

Get an asset category by unique id.

Parameters:

categoryId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteAssetCategory

@RequestMapping(value="/categories/{categoryId}",
                method=DELETE)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAssetCategory deleteAssetCategory(@PathVariable
                                                                                             String categoryId,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Delete an existing asset category.

Parameters:

categoryId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listAssetCategories

@RequestMapping(value="/categories",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.asset.IAssetCategory> listAssetCategories(@RequestParam(required=false,defaultValue="1")
                                                                                                                                      int page,
                                                                                                                                      @RequestParam(required=false,defaultValue="100")
                                                                                                                                      int pageSize,
                                                                                                                                      javax.servlet.http.HttpServletRequest servletRequest)
                                                                                                    throws com.sitewhere.spi.SiteWhereException

List asset categories that match the given search criteria.

Parameters:

page -

pageSize -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

createPersonAsset

@RequestMapping(value="/categories/{categoryId}/persons",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IPersonAsset createPersonAsset(@PathVariable
                                                                                         String categoryId,
                                                                                         @RequestBody
                                                                                         com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest request,
                                                                                         javax.servlet.http.HttpServletRequest servletRequest)
                                                       throws com.sitewhere.spi.SiteWhereException

Creates a new person asset in the category. If the category does not support person assets, an exception will be thrown.

Parameters:

categoryId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updatePersonAsset

@RequestMapping(value="/categories/{categoryId}/persons/{assetId}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IPersonAsset updatePersonAsset(@PathVariable
                                                                                         String categoryId,
                                                                                         @PathVariable
                                                                                         String assetId,
                                                                                         @RequestBody
                                                                                         com.sitewhere.rest.model.asset.request.PersonAssetCreateRequest request,
                                                                                         javax.servlet.http.HttpServletRequest servletRequest)
                                                       throws com.sitewhere.spi.SiteWhereException

Update an existing person asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

createHardwareAsset

@RequestMapping(value="/categories/{categoryId}/hardware",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IHardwareAsset createHardwareAsset(@PathVariable
                                                                                             String categoryId,
                                                                                             @RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Creates a new hardware asset in the category. If the category does not support hardware assets, an exception will be thrown.

Parameters:

categoryId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateHardwareAsset

@RequestMapping(value="/categories/{categoryId}/hardware/{assetId}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IHardwareAsset updateHardwareAsset(@PathVariable
                                                                                             String categoryId,
                                                                                             @PathVariable
                                                                                             String assetId,
                                                                                             @RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.HardwareAssetCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Update an existing hardware asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

createLocationAsset

@RequestMapping(value="/categories/{categoryId}/locations",
                method=POST)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.ILocationAsset createLocationAsset(@PathVariable
                                                                                             String categoryId,
                                                                                             @RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Creates a new location asset in the category. If the category does not support location assets, an exception will be thrown.

Parameters:

categoryId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateLocationAsset

@RequestMapping(value="/categories/{categoryId}/locations/{assetId}",
                method=PUT)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.ILocationAsset updateLocationAsset(@PathVariable
                                                                                             String categoryId,
                                                                                             @PathVariable
                                                                                             String assetId,
                                                                                             @RequestBody
                                                                                             com.sitewhere.rest.model.asset.request.LocationAssetCreateRequest request,
                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                           throws com.sitewhere.spi.SiteWhereException

Update an existing location asset.

Parameters:

categoryId -

assetId -

request -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getCategoryAsset

@RequestMapping(value="/categories/{categoryId}/assets/{assetId}",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAsset getCategoryAsset(@PathVariable
                                                                                  String categoryId,
                                                                                  @PathVariable
                                                                                  String assetId,
                                                                                  javax.servlet.http.HttpServletRequest servletRequest)
                                                throws com.sitewhere.spi.SiteWhereException

Get an asset from a category by unique id.

Parameters:

categoryId -

assetId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteCategoryAsset

@RequestMapping(value="/categories/{categoryId}/assets/{assetId}",
                method=DELETE)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.asset.IAsset deleteCategoryAsset(@PathVariable
                                                                                     String categoryId,
                                                                                     @PathVariable
                                                                                     String assetId,
                                                                                     javax.servlet.http.HttpServletRequest servletRequest)
                                                   throws com.sitewhere.spi.SiteWhereException

Delete an asset from a category based on unique id.

Parameters:

categoryId -

assetId -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listCategoryAssets

@RequestMapping(value="/categories/{categoryId}/assets",
                method=GET)
@ResponseBody
@Secured(value="ROLE_REST")
public com.sitewhere.spi.search.ISearchResults<com.sitewhere.spi.asset.IAsset> listCategoryAssets(@PathVariable
                                                                                                                             String categoryId,
                                                                                                                             @RequestParam(required=false,defaultValue="1")
                                                                                                                             int page,
                                                                                                                             @RequestParam(required=false,defaultValue="100")
                                                                                                                             int pageSize,
                                                                                                                             javax.servlet.http.HttpServletRequest servletRequest)
                                                                                           throws com.sitewhere.spi.SiteWhereException

List all assets for a given category.

Parameters:

categoryId -

page -

pageSize -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException