org.glyptodon.guacamole.net.basic.rest.user

Class UserRESTService

java.lang.Object

org.glyptodon.guacamole.net.basic.rest.user.UserRESTService

public class UserRESTService
extends Object

A REST Service for handling user CRUD operations.

Author:

James Muehlner, Michael Jumper

Constructor Summary

Constructors

Constructor and Description
UserRESTService()

Method Summary

Modifier and Type	Method and Description
String	createUser(String authToken, String authProviderIdentifier, APIUser user) Creates a new user and returns the username.
void	deleteUser(String authToken, String authProviderIdentifier, String username) Deletes an individual existing user.
APIPermissionSet	getPermissions(String authToken, String authProviderIdentifier, String username) Gets a list of permissions for the user with the given username.
APIUser	getUser(String authToken, String authProviderIdentifier, String username) Retrieves an individual user.
List<APIUser>	getUsers(String authToken, String authProviderIdentifier, List<ObjectPermission.Type> permissions) Gets a list of users in the given data source (UserContext), filtering the returned list by the given permission, if specified.
void	patchPermissions(String authToken, String authProviderIdentifier, String username, List<APIPatch<String>> patches) Applies a given list of permission patches.
void	updatePassword(String authToken, String authProviderIdentifier, String username, APIUserPasswordUpdate userPasswordUpdate, javax.servlet.http.HttpServletRequest request) Updates the password for an individual existing user.
void	updateUser(String authToken, String authProviderIdentifier, String username, APIUser user) Updates an individual existing user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserRESTService

public UserRESTService()

Method Detail

getUsers

public List<APIUser> getUsers(String authToken,
                              String authProviderIdentifier,
                              List<ObjectPermission.Type> permissions)
                       throws GuacamoleException

Gets a list of users in the given data source (UserContext), filtering the returned list by the given permission, if specified.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext from which the users are to be retrieved.

permissions - The set of permissions to filter with. A user must have one or more of these permissions for a user to appear in the result. If null, no filtering will be performed.

Returns:

A list of all visible users. If a permission was specified, this list will contain only those users for whom the current user has that permission.

Throws:

GuacamoleException - If an error is encountered while retrieving users.

getUser

public APIUser getUser(String authToken,
                       String authProviderIdentifier,
                       String username)
                throws GuacamoleException

Retrieves an individual user.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext from which the requested user is to be retrieved.

username - The username of the user to retrieve.

Returns:

user The user having the given username.

Throws:

GuacamoleException - If an error occurs while retrieving the user.

createUser

public String createUser(String authToken,
                         String authProviderIdentifier,
                         APIUser user)
                  throws GuacamoleException

Creates a new user and returns the username.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext in which the requested user is to be created.

user - The new user to create.

Returns:

The username of the newly created user.

Throws:

GuacamoleException - If a problem is encountered while creating the user.

updateUser

public void updateUser(String authToken,
                       String authProviderIdentifier,
                       String username,
                       APIUser user)
                throws GuacamoleException

Updates an individual existing user.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext in which the requested user is to be updated.

username - The username of the user to update.

user - The data to update the user with.

Throws:

GuacamoleException - If an error occurs while updating the user.

updatePassword

public void updatePassword(String authToken,
                           String authProviderIdentifier,
                           String username,
                           APIUserPasswordUpdate userPasswordUpdate,
                           @Context
                           javax.servlet.http.HttpServletRequest request)
                    throws GuacamoleException

Updates the password for an individual existing user.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext in which the requested user is to be updated.

username - The username of the user to update.

userPasswordUpdate - The object containing the old password for the user, as well as the new password to set for that user.

request - The HttpServletRequest associated with the password update attempt.

Throws:

GuacamoleException - If an error occurs while updating the user's password.

deleteUser

public void deleteUser(String authToken,
                       String authProviderIdentifier,
                       String username)
                throws GuacamoleException

Deletes an individual existing user.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext from which the requested user is to be deleted.

username - The username of the user to delete.

Throws:

GuacamoleException - If an error occurs while deleting the user.

getPermissions

public APIPermissionSet getPermissions(String authToken,
                                       String authProviderIdentifier,
                                       String username)
                                throws GuacamoleException

Gets a list of permissions for the user with the given username.

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext in which the requested user is to be found.

username - The username of the user to retrieve permissions for.

Returns:

A list of all permissions granted to the specified user.

Throws:

GuacamoleException - If an error occurs while retrieving permissions.

patchPermissions

public void patchPermissions(String authToken,
                             String authProviderIdentifier,
                             String username,
                             List<APIPatch<String>> patches)
                      throws GuacamoleException

Applies a given list of permission patches. Each patch specifies either an "add" or a "remove" operation for a permission type, represented by a string. Valid permission types depend on the path of each patch operation, as the path dictates the permission being modified, such as "/connectionPermissions/42" or "/systemPermissions".

Parameters:

authToken - The authentication token that is used to authenticate the user performing the operation.

authProviderIdentifier - The unique identifier of the AuthenticationProvider associated with the UserContext in which the requested user is to be found.

username - The username of the user to modify the permissions of.

patches - The permission patches to apply for this request.

Throws:

GuacamoleException - If a problem is encountered while modifying permissions.