Package org.alfresco.rest.rm.community.requests.gscore.api

Class RMUserAPI

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Request>

org.alfresco.rest.rm.community.requests.RMModelRequest

org.alfresco.rest.rm.community.requests.gscore.api.RMUserAPI

public class RMUserAPI
extends RMModelRequest

RM user management API

Since:

2.6

Author:

Kristijan Conkas

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
RMUserAPI(RMRestWrapper rmRestWrapper)

Method Summary

Modifier and Type	Method	Description
void	addUserPermission(String filePlanComponentId, org.alfresco.utility.model.UserModel user, UserPermissions permission)	Helper method to add permission on a component to user
void	assignRoleToUser(String userName, String userRole)	Assign RM role to user
boolean	createUser(String userName, String userPassword, String userEmail)	Creates a user with the given name using the old APIs
void	setUserPermissionInheritance(String filePlanComponentId, Boolean isInherited)	Helper method to set permission inheritance on a file plan component

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

RMUserAPI

public RMUserAPI(RMRestWrapper rmRestWrapper)

Parameters:

rmRestWrapper - RM REST Wrapper

Method Detail

assignRoleToUser

public void assignRoleToUser(String userName,
                             String userRole)

Assign RM role to user

Parameters:

userName - User's username

userRole - User's RM role, one of UserRoles roles

Throws:

RuntimeException - for failed requests

addUserPermission

public void addUserPermission(String filePlanComponentId,
                              org.alfresco.utility.model.UserModel user,
                              UserPermissions permission)

Helper method to add permission on a component to user

Parameters:

filePlanComponentId - The id of the file plan component on which permission should be given

user - UserModel for a user to be granted permission

permission - UserPermissions to be granted

setUserPermissionInheritance

public void setUserPermissionInheritance(String filePlanComponentId,
                                         Boolean isInherited)

Helper method to set permission inheritance on a file plan component

Parameters:

filePlanComponentId - The id of the file plan component on which inherited permission should be set

isInherited - true if the permission is inherited false if the permission inheritance is disabled

createUser

public boolean createUser(String userName,
                          String userPassword,
                          String userEmail)

Creates a user with the given name using the old APIs

Parameters:

userName - The user name

userPassword - The user's password

userEmail - The user's e-mail address

Returns:

true if the user was created successfully, false otherwise.