Package org.gcube.vomanagement.usermanagement

Interface RoleManager

All Known Implementing Classes:

LiferayRoleManager, LiferayWSRoleManager

public interface RoleManager

This interface defines the manager class that manages the Roles and the Teams. Groups (Sites) can group a set of user by creating a team. The notion of a Team is somewhat similar to a Role but a Role is a portal wide entity (Role exists in any Site) while a Team is restricted to a particular Site.

Author:

Massimiliano Assante, CNR-ISTI

Method Summary

Modifier and Type	Method	Description
boolean	assignRolesToUser(long userId, long groupId, long[] roleId)
boolean	assignRoleToUser(long userId, long groupId, long roleId)
boolean	assignTeamToUser(long userId, long teamId)	associate one team to the existing teams of user
boolean	createRole(String roleName, String roleDescription)
GCubeTeam	createTeam(long creatorUserId, long groupId, String teamName, String teamDescription)
GCubeTeam	createTeam(long groupId, String teamName, String teamDescription)	it will crate the Team as Administrator, use the other method to pass the userId
boolean	deleteRole(long roleId)
GCubeTeam	deleteTeam(long teamId)
boolean	deleteTeams(long groupId)
boolean	deleteUserTeams(long userId, long[] teamIds)	delete a user from a list of teams
boolean	deleteUserTeams(long userId, List<GCubeTeam> teams)	delete a user from a list of teams
GCubeRole	getRole(long roleId)
GCubeRole	getRole(String roleName, long groupId)
long	getRoleId(String roleName, long groupId)	* @param roleName
long	getRoleIdByName(String roleName)	* @param roleName
GCubeTeam	getTeam(long teamId)
GCubeTeam	getTeam(long groupId, String teamName)
boolean	hasRole(long userId, long groupId, long roleId)
boolean	hasTeam(long userId, long teamId)
boolean	isAdmin(long userId)
List<GCubeRole>	listAllGroupRoles()
List<GCubeRole>	listAllRoles()
List<GCubeRole>	listRolesByUserAndGroup(long userId, long groupId)
List<GCubeTeam>	listTeamsByGroup(long groupId)
List<GCubeTeam>	listTeamsByUserAndGroup(long userId, long groupId)
boolean	removeAllRolesFromUser(long userId, long... groupIds)
boolean	removeRoleFromUser(long userId, long groupId, long roleId)
boolean	setUserTeams(long userId, long[] teamIds)	associate or not associate teams to a user
GCubeRole	updateRole(long roleId, String roleName, String roleDescription)
GCubeTeam	updateTeam(long teamId, String teamName, String teamDescription)

Method Details

isAdmin

boolean isAdmin(long userId)
         throws UserRetrievalFault

Parameters:

userId - the LR UserId, not the username

Returns:

true if the user is a portal administrator, false otherwise

Throws:

UserRetrievalFault

hasRole

boolean hasRole(long userId,
 long groupId,
 long roleId)

Parameters:

userId - userId the LR UserId, not the username

groupId - the LR groupId

roleId - the LR roleId

Returns:

true if the user has the role, false otherwise

hasTeam

boolean hasTeam(long userId,
 long teamId)

Parameters:

userId - userId the LR UserId, not the username

teamId - the LR teamId

Returns:

assignRoleToUser

boolean assignRoleToUser(long userId,
 long groupId,
 long roleId)
                  throws UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
RoleRetrievalFault

Parameters:

userId - the LR UserId

groupId - the LR groupId

roleId - the LR roleId

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

assignRolesToUser

boolean assignRolesToUser(long userId,
 long groupId,
 long[] roleId)
                   throws UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
RoleRetrievalFault

Parameters:

userId - the LR UserId

groupId - the LR groupId

roleId - the LR roleId

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

createRole

boolean createRole(String roleName,
 String roleDescription)
            throws UserManagementSystemException

Parameters:

roleName -

roleDescription -

Returns:

true if the role is created succesfully

Throws:

UserManagementSystemException

deleteRole

boolean deleteRole(long roleId)
            throws UserManagementSystemException,
RoleRetrievalFault

Parameters:

roleId -

Returns:

true if the role is deleted succesfully, false otherwise

Throws:

UserManagementSystemException

RoleRetrievalFault

removeRoleFromUser

boolean removeRoleFromUser(long userId,
 long groupId,
 long roleId)
                    throws UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
RoleRetrievalFault

Parameters:

userId -

groupId -

roleId -

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

removeAllRolesFromUser

boolean removeAllRolesFromUser(long userId,
 long... groupIds)
                        throws UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault

Parameters:

userId -

groupIds -

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

updateRole

GCubeRole updateRole(long roleId,
 String roleName,
 String roleDescription)
              throws RoleRetrievalFault

Parameters:

roleId -

roleName -

roleDescription -

Returns:

Throws:

RoleRetrievalFault

getRole

GCubeRole getRole(long roleId)
           throws UserManagementSystemException,
RoleRetrievalFault

Parameters:

roleId -

Returns:

Throws:

UserManagementSystemException

RoleRetrievalFault

getRole

GCubeRole getRole(String roleName,
 long groupId)
           throws RoleRetrievalFault,
GroupRetrievalFault

Parameters:

roleName -

groupId - the LR groupId

Returns:

an instance of GCubeRole if the roleName exists, null otherwise

Throws:

RoleRetrievalFault - if the roleName does not exist

GroupRetrievalFault - if the groupId does not exist

getRoleId

long getRoleId(String roleName,
 long groupId)
        throws RoleRetrievalFault,
GroupRetrievalFault

* @param roleName

Parameters:

groupId - the LR groupId

Returns:

the LR RoleId if the roleName exists

Throws:

RoleRetrievalFault - if the roleName does not exist

GroupRetrievalFault - if the groupId does not exist

getRoleIdByName

long getRoleIdByName(String roleName)
              throws RoleRetrievalFault

* @param roleName

Returns:

the LR RoleId if the roleName exists

Throws:

RoleRetrievalFault - if the roleName does not exist

listAllRoles

List<GCubeRole> listAllRoles()

Returns:

a list of GCubeRole independent from the roleType

listAllGroupRoles

List<GCubeRole> listAllGroupRoles()

Returns:

a list of GCubeRole of type Site Role (Type=2)

listRolesByUserAndGroup

List<GCubeRole> listRolesByUserAndGroup(long userId,
 long groupId)
                                 throws GroupRetrievalFault,
UserRetrievalFault

Parameters:

groupId -

userId -

Returns:

a list of GCubeRole of type Site Role (Type=2)

Throws:

GroupRetrievalFault - if the group does not exist

UserRetrievalFault - if the user does not exist

createTeam

GCubeTeam createTeam(long creatorUserId,
 long groupId,
 String teamName,
 String teamDescription)
              throws GroupRetrievalFault,
TeamRetrievalFault,
UserManagementSystemException

Parameters:

creatorUserId - the username of who is creating the team

groupId - the site group id where the team exists

teamName - the name you want to assign to this team

teamDescription -

Returns:

the GCubeTeam if the team is created succesfully, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

TeamRetrievalFault

createTeam

GCubeTeam createTeam(long groupId,
 String teamName,
 String teamDescription)
              throws GroupRetrievalFault,
TeamRetrievalFault,
UserManagementSystemException

it will crate the Team as Administrator, use the other method to pass the userId

Parameters:

groupId - the site group id where the team exists

teamName - the name you want to assign to this team

teamDescription -

Returns:

the GCubeTeam if the team is created succesfully, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

TeamRetrievalFault

getTeam

GCubeTeam getTeam(long groupId,
 String teamName)
           throws GroupRetrievalFault,
TeamRetrievalFault

Parameters:

groupId -

teamName -

Returns:

Throws:

GroupRetrievalFault

TeamRetrievalFault

getTeam

GCubeTeam getTeam(long teamId)
           throws UserManagementSystemException,
TeamRetrievalFault

Parameters:

teamId -

Returns:

the GCubeTeam istance

Throws:

UserManagementSystemException

TeamRetrievalFault - if the team does not exist

deleteTeam

GCubeTeam deleteTeam(long teamId)
              throws UserManagementSystemException,
TeamRetrievalFault

Parameters:

teamId - the LR team Id

Returns:

the team instance that was removed

Throws:

UserManagementSystemException

TeamRetrievalFault - if the team does not exist

deleteTeams

boolean deleteTeams(long groupId)
             throws UserManagementSystemException

Parameters:

groupId - the LR GroupId of the Site

Returns:

true if the teams are deleted succesfully, false otherwise

Throws:

UserManagementSystemException

deleteUserTeams

boolean deleteUserTeams(long userId,
 long[] teamIds)
                 throws UserRetrievalFault,
TeamRetrievalFault

delete a user from a list of teams

Parameters:

userId -

teamIds -

Returns:

Throws:

UserRetrievalFault - if the user does not exist

TeamRetrievalFault - if a team does not exist

deleteUserTeams

boolean deleteUserTeams(long userId,
 List<GCubeTeam> teams)
                 throws UserRetrievalFault,
TeamRetrievalFault

delete a user from a list of teams

Parameters:

userId -

teams -

Returns:

Throws:

UserRetrievalFault - if the user does not exist

TeamRetrievalFault - if a team does not exist

updateTeam

GCubeTeam updateTeam(long teamId,
 String teamName,
 String teamDescription)
              throws TeamRetrievalFault

Parameters:

teamId - the team id

teamName - the team name

teamDescription - the team description

Returns:

the updated team

Throws:

TeamRetrievalFault

setUserTeams

boolean setUserTeams(long userId,
 long[] teamIds)
              throws TeamRetrievalFault

associate or not associate teams to a user

Parameters:

userId -

teamIds -

Returns:

Throws:

TeamRetrievalFault - if a system exception occurred or a team does not exists

assignTeamToUser

boolean assignTeamToUser(long userId,
 long teamId)
                  throws UserManagementSystemException,
UserRetrievalFault,
GroupRetrievalFault,
TeamRetrievalFault

associate one team to the existing teams of user

Parameters:

userId -

teamId -

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

TeamRetrievalFault

listTeamsByGroup

List<GCubeTeam> listTeamsByGroup(long groupId)
                          throws GroupRetrievalFault

Returns:

a list of GCubeTeam belonging to a give group

Throws:

GroupRetrievalFault

listTeamsByUserAndGroup

List<GCubeTeam> listTeamsByUserAndGroup(long userId,
 long groupId)
                                 throws UserRetrievalFault,
GroupRetrievalFault

Parameters:

userId - the LR userId of the Site

groupId - the LR GroupId of the Site

Returns:

a list of GCubeTeam belonging to a user in a given group

Throws:

UserRetrievalFault

GroupRetrievalFault