com.sitewhere.web.rest.controllers

Class UsersController

java.lang.Object

com.sitewhere.web.rest.RestController

com.sitewhere.web.rest.controllers.UsersController

@Controller
@RequestMapping(value="/users")
public class UsersController
extends RestController

Controller for user operations.

Author:

Derek Adams

Constructor Summary

Constructors

Constructor and Description
UsersController()

Method Summary

Methods

Modifier and Type	Method and Description
com.sitewhere.rest.model.user.User	createUser(com.sitewhere.rest.model.user.request.UserCreateRequest input) Create a new user.
com.sitewhere.rest.model.user.User	deleteUserByUsername(String username, boolean force) Delete information for a given user based on username.
com.sitewhere.rest.model.search.SearchResults<com.sitewhere.rest.model.user.GrantedAuthority>	getAuthoritiesForUsername(String username) Get a list of detailed authority information for a given user.
List<com.sitewhere.spi.user.ITenant>	getTenantsForUsername(String username, boolean includeRuntimeInfo) Get tenants associated with a user.
com.sitewhere.rest.model.user.User	getUserByUsername(String username) Get a user by unique username.
com.sitewhere.rest.model.search.SearchResults<com.sitewhere.rest.model.user.User>	listUsers(boolean includeDeleted, int count) List devices that match given criteria.
com.sitewhere.rest.model.user.User	updateUser(String username, com.sitewhere.rest.model.user.request.UserCreateRequest input) Update an existing user.

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

UsersController

public UsersController()

Method Detail

createUser

@RequestMapping(method=POST)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.user.User createUser(@RequestBody
                                                                                     com.sitewhere.rest.model.user.request.UserCreateRequest input)
                                              throws com.sitewhere.spi.SiteWhereException

Create a new user.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

updateUser

@RequestMapping(value="/{username:.+}",
                method=PUT)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.user.User updateUser(@PathVariable
                                                                                     String username,
                                                                                     @RequestBody
                                                                                     com.sitewhere.rest.model.user.request.UserCreateRequest input)
                                              throws com.sitewhere.spi.SiteWhereException

Update an existing user.

Parameters:

input -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getUserByUsername

@RequestMapping(value="/{username:.+}",
                method=GET)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.user.User getUserByUsername(@PathVariable
                                                                                            String username)
                                                     throws com.sitewhere.spi.SiteWhereException

Get a user by unique username.

Parameters:

username -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

deleteUserByUsername

@RequestMapping(value="/{username:.+}",
                method=DELETE)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.user.User deleteUserByUsername(@PathVariable
                                                                                               String username,
                                                                                               @RequestParam(defaultValue="false")
                                                                                               boolean force)
                                                        throws com.sitewhere.spi.SiteWhereException

Delete information for a given user based on username.

Parameters:

siteToken -

force -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getAuthoritiesForUsername

@RequestMapping(value="/{username:.+}/authorities",
                method=GET)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.search.SearchResults<com.sitewhere.rest.model.user.GrantedAuthority> getAuthoritiesForUsername(@PathVariable
                                                                                                                                                               String username)
                                                                                                                        throws com.sitewhere.spi.SiteWhereException

Get a list of detailed authority information for a given user.

Parameters:

username -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

listUsers

@RequestMapping(method=GET)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public com.sitewhere.rest.model.search.SearchResults<com.sitewhere.rest.model.user.User> listUsers(@RequestParam(defaultValue="false")
                                                                                                                                   boolean includeDeleted,
                                                                                                                                   @RequestParam(defaultValue="100")
                                                                                                                                   int count)
                                                                                            throws com.sitewhere.spi.SiteWhereException

List devices that match given criteria.

Returns:

Throws:

com.sitewhere.spi.SiteWhereException

getTenantsForUsername

@RequestMapping(value="/{username:.+}/tenants",
                method=GET)
@ResponseBody
@PreAuthorize(value="hasRole(\'ROLE_REST\') and hasRole(\'ROLE_ADMINISTER_USERS\')")
public List<com.sitewhere.spi.user.ITenant> getTenantsForUsername(@PathVariable
                                                                                                  String username,
                                                                                                  @RequestParam(required=false,defaultValue="false")
                                                                                                  boolean includeRuntimeInfo)
                                                           throws com.sitewhere.spi.SiteWhereException

Get tenants associated with a user.

Parameters:

username -

Returns:

Throws:

com.sitewhere.spi.SiteWhereException