Package de.dlr.proseo.usermgr.rest

Class UserControllerImpl

java.lang.Object

de.dlr.proseo.usermgr.rest.UserControllerImpl

All Implemented Interfaces:

UserController

@Component
public class UserControllerImpl
extends Object
implements UserController

Spring MVC controller for the prosEO User Manager; implements the services required to manage user accounts.

Author:

Dr. Thomas Bassler

Constructor Summary

Constructors

Constructor	Description
UserControllerImpl()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	countUsers(String missionCode)	Count the users matching the specified mission.
org.springframework.http.ResponseEntity<RestUser>	createUser(@Valid RestUser restUser)	Create a new user
org.springframework.http.ResponseEntity<?>	deleteUserByName(String username)	Delete a user by user name
org.springframework.http.ResponseEntity<RestUser>	getUserByName(String username)	Get a user by name
org.springframework.http.ResponseEntity<List<RestUser>>	getUsers(String mission, Integer recordFrom, Integer recordTo)	Get users by mission (may be null, if root user sends request)
org.springframework.http.ResponseEntity<RestUser>	modifyUser(String username, RestUser restUser)	Update a user by name

Methods inherited from class java.lang.Object

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

Constructor Details

UserControllerImpl

public UserControllerImpl()

Method Details

getUsers

public org.springframework.http.ResponseEntity<List<RestUser>> getUsers(String mission,
 Integer recordFrom,
 Integer recordTo)

Get users by mission (may be null, if root user sends request)

Specified by:

getUsers in interface UserController

Parameters:

mission - the mission code

recordFrom - first record of filtered and ordered result to return

recordTo - last record of filtered and ordered result to return

Returns:

HTTP status "OK" and a list of Json objects representing users authorized for the given mission or HTTP status "NOT_FOUND" and an error message, if no users matching the search criteria were found HTTP status "TOO MANY REQUESTS" if the result list exceeds a configured maximum

createUser

public org.springframework.http.ResponseEntity<RestUser> createUser(@Valid
 @Valid RestUser restUser)

Create a new user

Specified by:

createUser in interface UserController

Parameters:

restUser - a Json representation of the new user

Returns:

HTTP status "CREATED" and a response containing a Json object corresponding to the user after persistence (with ACL security identity ID) or HTTP status "BAD_REQUEST", if any of the input data was invalid

getUserByName

public org.springframework.http.ResponseEntity<RestUser> getUserByName(String username)

Get a user by name

Specified by:

getUserByName in interface UserController

Parameters:

username - the user name

Returns:

HTTP status "OK" and a Json object corresponding to the user found or HTTP status "BAD_REQUEST" and an error message, if no user name was given, or HTTP status "UNAUTHORIZED" and an error message, if a user (not user mgr) attempted to access the data of another user, or HTTP status "NOT_FOUND" and an error message, if no user with the given name exists

deleteUserByName

public org.springframework.http.ResponseEntity<?> deleteUserByName(String username)

Delete a user by user name

Specified by:

deleteUserByName in interface UserController

Parameters:

username - the name of the user to delete

Returns:

a response entity with HTTP status "NO_CONTENT", if the deletion was successful, or HTTP status "NOT_FOUND", if the user did not exist, or HTTP status "NOT_MODIFIED", if the deletion was unsuccessful

modifyUser

public org.springframework.http.ResponseEntity<RestUser> modifyUser(String username,
 RestUser restUser)

Update a user by name

Specified by:

modifyUser in interface UserController

Parameters:

username - the name of the user to update

restUser - a Json object containing the modified (and unmodified) attributes

Returns:

HTTP status "OK" and a response containing a Json object corresponding to the user after modification or HTTP status "NOT_MODIFIED" and a warning message, if the input date was the same as the database data, or HTTP status "NOT_FOUND" and an error message, if no user with the given name exists, or HTTP status "BAD_REQUEST" and an error message, if any of the input data was invalid, or HTTP status "UNAUTHORIZED" and an error message, if a user (not user mgr) attempted to change anything but their own password, or HTTP status "CONFLICT"and an error message, if the user has been modified since retrieval by the client

countUsers

public org.springframework.http.ResponseEntity<String> countUsers(String missionCode)

Count the users matching the specified mission.

Specified by:

countUsers in interface UserController

Parameters:

missionCode - the mission

Returns:

the number of matching users as a String (may be zero) or HTTP status "BAD_REQUEST" if the request was not made by the root user or no mission was provided