Package org.gcube.vomanagement.usermanagement.impl.ws

Class LiferayWSRoleManager

java.lang.Object

org.gcube.vomanagement.usermanagement.impl.ws.LiferayWSRoleManager

All Implemented Interfaces:

RoleManager

public class LiferayWSRoleManager
extends Object
implements RoleManager

Constructor Summary

Constructors

Constructor	Description
LiferayWSRoleManager(String user, String password, String host, String schema, int port)	In order to contact the json ws of Liferay, user and password are needed.

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)
protected static GCubeRole	mapLRRole(String jsonRole)
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)

Methods inherited from class java.lang.Object

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

Constructor Details

LiferayWSRoleManager

public LiferayWSRoleManager(String user,
 String password,
 String host,
 String schema,
 int port)
                     throws Exception

In order to contact the json ws of Liferay, user and password are needed. The host in which the current JVM machine runs needs to be authorized.

Parameters:

user -

password -

host - the host to contact

port - the port number

schema - the schema (http/https) https is suggested!

Throws:

Exception

Method Details

mapLRRole

protected static GCubeRole mapLRRole(String jsonRole)
                              throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException,
org.json.simple.parser.ParseException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

org.json.simple.parser.ParseException

isAdmin

public boolean isAdmin(long userId)
                throws UserRetrievalFault

Specified by:

isAdmin in interface RoleManager

Parameters:

userId - the LR UserId, not the username

Returns:

true if the user is a portal administrator, false otherwise

Throws:

UserRetrievalFault

hasRole

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

Specified by:

hasRole in interface RoleManager

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

public boolean hasTeam(long userId,
 long teamId)

Specified by:

hasTeam in interface RoleManager

Parameters:

userId - userId the LR UserId, not the username

teamId - the LR teamId

Returns:

assignRoleToUser

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

Specified by:

assignRoleToUser in interface RoleManager

Parameters:

userId - the LR UserId

groupId - the LR groupId

roleId - the LR roleId

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

assignRolesToUser

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

Specified by:

assignRolesToUser in interface RoleManager

Parameters:

userId - the LR UserId

groupId - the LR groupId

roleId - the LR roleId

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

createRole

public boolean createRole(String roleName,
 String roleDescription)
                   throws UserManagementSystemException

Specified by:

createRole in interface RoleManager

Returns:

true if the role is created succesfully

Throws:

UserManagementSystemException

deleteRole

public boolean deleteRole(long roleId)
                   throws UserManagementSystemException,
RoleRetrievalFault

Specified by:

deleteRole in interface RoleManager

Returns:

true if the role is deleted succesfully, false otherwise

Throws:

UserManagementSystemException

RoleRetrievalFault

removeRoleFromUser

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

Specified by:

removeRoleFromUser in interface RoleManager

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

RoleRetrievalFault

removeAllRolesFromUser

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

Specified by:

removeAllRolesFromUser in interface RoleManager

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

updateRole

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

Specified by:

updateRole in interface RoleManager

Returns:

Throws:

RoleRetrievalFault

getRole

public GCubeRole getRole(long roleId)
                  throws UserManagementSystemException,
RoleRetrievalFault

Specified by:

getRole in interface RoleManager

Returns:

Throws:

UserManagementSystemException

RoleRetrievalFault

getRole

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

Specified by:

getRole in interface RoleManager

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

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

Description copied from interface: RoleManager

* @param roleName

Specified by:

getRoleId in interface RoleManager

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

public long getRoleIdByName(String roleName)
                     throws RoleRetrievalFault

Description copied from interface: RoleManager

* @param roleName

Specified by:

getRoleIdByName in interface RoleManager

Returns:

the LR RoleId if the roleName exists

Throws:

RoleRetrievalFault - if the roleName does not exist

listAllRoles

public List<GCubeRole> listAllRoles()

Specified by:

listAllRoles in interface RoleManager

Returns:

a list of GCubeRole independent from the roleType

listAllGroupRoles

public List<GCubeRole> listAllGroupRoles()

Specified by:

listAllGroupRoles in interface RoleManager

Returns:

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

listRolesByUserAndGroup

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

Specified by:

listRolesByUserAndGroup in interface RoleManager

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

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

Specified by:

createTeam in interface RoleManager

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

Returns:

the GCubeTeam if the team is created succesfully, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

TeamRetrievalFault

createTeam

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

Description copied from interface: RoleManager

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

Specified by:

createTeam in interface RoleManager

Parameters:

groupId - the site group id where the team exists

teamName - the name you want to assign to this team

Returns:

the GCubeTeam if the team is created succesfully, null otherwise

Throws:

UserManagementSystemException

GroupRetrievalFault

TeamRetrievalFault

getTeam

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

Specified by:

getTeam in interface RoleManager

Returns:

Throws:

GroupRetrievalFault

TeamRetrievalFault

getTeam

public GCubeTeam getTeam(long teamId)
                  throws UserManagementSystemException,
TeamRetrievalFault

Specified by:

getTeam in interface RoleManager

Returns:

the GCubeTeam istance

Throws:

UserManagementSystemException

TeamRetrievalFault - if the team does not exist

deleteTeam

public GCubeTeam deleteTeam(long teamId)
                     throws UserManagementSystemException,
TeamRetrievalFault

Specified by:

deleteTeam in interface RoleManager

Parameters:

teamId - the LR team Id

Returns:

the team instance that was removed

Throws:

UserManagementSystemException

TeamRetrievalFault - if the team does not exist

deleteTeams

public boolean deleteTeams(long groupId)
                    throws UserManagementSystemException

Specified by:

deleteTeams in interface RoleManager

Parameters:

groupId - the LR GroupId of the Site

Returns:

true if the teams are deleted succesfully, false otherwise

Throws:

UserManagementSystemException

deleteUserTeams

public boolean deleteUserTeams(long userId,
 long[] teamIds)

Description copied from interface: RoleManager

delete a user from a list of teams

Specified by:

deleteUserTeams in interface RoleManager

Returns:

deleteUserTeams

public boolean deleteUserTeams(long userId,
 List<GCubeTeam> teams)

Description copied from interface: RoleManager

delete a user from a list of teams

Specified by:

deleteUserTeams in interface RoleManager

Returns:

updateTeam

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

Specified by:

updateTeam in interface RoleManager

Parameters:

teamId - the team id

teamName - the team name

teamDescription - the team description

Returns:

the updated team

Throws:

TeamRetrievalFault

setUserTeams

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

Description copied from interface: RoleManager

associate or not associate teams to a user

Specified by:

setUserTeams in interface RoleManager

Returns:

Throws:

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

assignTeamToUser

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

Description copied from interface: RoleManager

associate one team to the existing teams of user

Specified by:

assignTeamToUser in interface RoleManager

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

GroupRetrievalFault

TeamRetrievalFault

listTeamsByGroup

public List<GCubeTeam> listTeamsByGroup(long groupId)
                                 throws GroupRetrievalFault

Specified by:

listTeamsByGroup in interface RoleManager

Returns:

a list of GCubeTeam belonging to a give group

Throws:

GroupRetrievalFault

listTeamsByUserAndGroup

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

Specified by:

listTeamsByUserAndGroup in interface RoleManager

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