it.eng.rdlab.soa3.um.rest
Interface IUserManagementService.RoleManager

All Known Implementing Classes:

RoleManagerImpl

Enclosing interface:

IUserManagementService

public static interface IUserManagementService.RoleManager

The role interface in the user management hierarchy.

Version:

1.0

Author:

Ermanno Travaglino

Method Summary

String	createRole(String roleName, String organizationName, String adminUserId, String adminPassword) Creates a new role by roleName (and organizationName)
boolean	deleteRole(String roleName, String organizationName, String adminUserId, String adminPassword) Deletes a role by roleName (and by organizationName)
boolean	deleteRoles(String organizationName, String adminUserId, String adminPassword) Deletes all present roles under an organization by organizationName
RoleModel	getRole(String roleName, String organizationName, String adminUserId, String adminPassword) Gets the role by roleName (and by organizatioName)
String	getRoleIdByName(String roleName, String organizationName) Gets the roleId by roleName (and by organizationName)
List<RoleModel>	listRoles(String adminUserId, String adminPassword) Lists all present roles
List<RoleModel>	listRolesByOrganization(String organizationName, String adminUserId, String adminPassword) Lists all roles under an organization by organizationName
boolean	removeAllUsers(String roleName, String organizationName, String adminUserId, String adminPassword) Removes all users with a specific roleName role (and by organizationName)
boolean	updateRole(RoleModel role, String organizationName, String adminUserId, String adminPassword) Updates role's attribute

Method Detail

createRole

String createRole(String roleName,
                  String organizationName,
                  String adminUserId,
                  String adminPassword)

Creates a new role by roleName (and organizationName)

Parameters:

roleName -

organizationName -

adminUserId -

adminPassword -

Returns:

role creation process response String

deleteRole

boolean deleteRole(String roleName,
                   String organizationName,
                   String adminUserId,
                   String adminPassword)

Deletes a role by roleName (and by organizationName)

Parameters:

roleName -

organizationName -

adminUserId -

adminPassword -

Returns:

true if the organization was removed as a result of this call

deleteRoles

boolean deleteRoles(String organizationName,
                    String adminUserId,
                    String adminPassword)

Deletes all present roles under an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

true if the roles have been removed as a result of this call

updateRole

boolean updateRole(RoleModel role,
                   String organizationName,
                   String adminUserId,
                   String adminPassword)

Updates role's attribute

Parameters:

role -

organizationName -

adminUserId -

adminPassword -

Returns:

true if this role updated as a result of the call

getRole

RoleModel getRole(String roleName,
                  String organizationName,
                  String adminUserId,
                  String adminPassword)

Gets the role by roleName (and by organizatioName)

Parameters:

roleName -

organizationName -

adminUserId -

adminPassword -

Returns:

object with specified name RoleModel

listRoles

List<RoleModel> listRoles(String adminUserId,
                          String adminPassword)

Lists all present roles

Parameters:

adminUserId -

adminPassword -

Returns:

a List containing all roles

getRoleIdByName

String getRoleIdByName(String roleName,
                       String organizationName)

Gets the roleId by roleName (and by organizationName)

Parameters:

roleName -

organizationName -

adminUserId -

adminPassword -

Returns:

object with specified name OrganizationModel

listRolesByOrganization

List<RoleModel> listRolesByOrganization(String organizationName,
                                        String adminUserId,
                                        String adminPassword)

Lists all roles under an organization by organizationName

Parameters:

organizationName -

adminUserId -

adminPassword -

Returns:

a List containing all roles by organization as a result of the call

removeAllUsers

boolean removeAllUsers(String roleName,
                       String organizationName,
                       String adminUserId,
                       String adminPassword)

Removes all users with a specific roleName role (and by organizationName)

Parameters:

roleName -

organizationName -

adminUserId -

adminPassword -

Returns:

true if the role was removed from all users as a result of this call