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

Class LiferayWSUserManager

java.lang.Object

org.gcube.vomanagement.usermanagement.impl.ws.LiferayWSUserManager

All Implemented Interfaces:

UserManager

public class LiferayWSUserManager
extends Object
implements UserManager

Exploit Liferay JSON Web Service to perform UserManager's operations.

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Constructor Summary

Constructors

Constructor	Description
LiferayWSUserManager(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
GCubeMembershipRequest	acceptMembershipRequest(long requestUserId, long groupId, boolean addUserToGroup, String replyUsername, String replyComment)	accept a membership request and optionally add the user to the group
void	assignUserToGroup(long groupId, long userId)	this method assigns the user to the Group and perform other necessary actions (such as adding him to the HL Folder)
GCubeUser	createUser(boolean autoScreenName, String username, String email, String firstName, String middleName, String lastName, String jobTitle, String location_industry, String backgroundSummary, boolean male, String reminderQuestion, String reminderAnswer, boolean sendEmail, boolean forcePasswordReset, byte[] portraitBytes, int type)	Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password.
GCubeUser	createUser(boolean autoScreenName, String username, String email, String firstName, String middleName, String lastName, String jobTitle, String location_industry, String backgroundSummary, boolean male, String reminderQuestion, String reminderAnswer, boolean sendEmail, boolean forcePasswordReset, byte[] portraitBytes, String mySpacesn, String twittersn, String facebooksn, String skypesn, String jabbersn, String aimsn, int type)	Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password.
GCubeUser	createUser(boolean autoScreenName, String username, String email, String firstName, String middleName, String lastName, String jobTitle, String location_industry, String backgroundSummary, boolean male, String reminderQuestion, String reminderAnswer, boolean sendEmail, boolean forcePasswordReset, int type)	Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password.
GCubeUser	createUser(boolean autoScreenName, String username, String email, String firstName, String middleName, String lastName, String jobTitle, String location_industry, String backgroundSummary, boolean male, String reminderQuestion, String reminderAnswer, int type)	Create the user without sending notification mail and without forcing him to change the password at first login.
void	deleteUserByEMail(String email)	Delete a user given his mail
void	dismissUserFromGroup(long groupId, long userId)	this method removes the user to the Group and perform other necessary actions (such as removing him from the HL Folder)
String	getFullNameFromEmail(String email)	Returns the user's full name given his email
int	getGroupUsersCount(long groupId)	Returns the number of users in the group (VRE).
List<GCubeMembershipRequest>	getMembershipRequests(long userId, long groupId, MembershipRequestStatus status)
GCubeMembershipRequest	getMembershipRequestsById(long membershipRequestId)
byte[]	getUserAvatarBytes(String screenName)	Retrieve user's avatar as bytes
GCubeUser	getUserByEmail(String email)
GCubeUser	getUserById(long userId)
GCubeUser	getUserByScreenName(String username)
GCubeUser	getUserByUsername(String username)
Set<GCubeUser>	getUserContactsByGroup(long userId, long scopeGroupId)
long	getUserId(String username)
List<Long>	getUserIdsByGroup(long groupId)	Retrieve the list of user identifiers by group id.
String	getUserOpenId(String screenName)	Retrieve user's openId field
String	getUserProfessionalBackground(long userId)
int	getUsersCount()	Returns the number of total users.
boolean	isPasswordChanged(String email)	Check if the user changed his/her password from the initial one.
List<GCubeMembershipRequest>	listMembershipRequestsByGroup(long groupId)
List<GCubeMembershipRequest>	listPendingMembershipRequestsByGroup(long groupId)
List<GCubeUser>	listUnregisteredUsersByGroup(long groupId)
long[]	listUserIdsByGroupAndRole(long groupId, long roleId)
List<GCubeUser>	listUsers()
List<GCubeUser>	listUsers(boolean indexed)
List<GCubeUser>	listUsers(int start, int end)	Returns a range of all the users.
Map<GCubeUser,List<GCubeRole>>	listUsersAndRolesByGroup(long groupId)
List<GCubeUser>	listUsersByGlobalRole(long roleId)	Retrieve a list of users having a global role (e.g., Administrator)
List<GCubeUser>	listUsersByGroup(long groupId)
List<GCubeUser>	listUsersByGroup(long groupId, boolean indexed)
List<GCubeUser>	listUsersByGroup(long groupId, int start, int end)
List<GCubeUser>	listUsersByGroupAndRole(long groupId, long roleId)
List<GCubeUser>	listUsersByGroupName(String name)
List<GCubeUser>	listUsersByTeam(long teamId)	/**
Serializable	readCustomAttr(long userId, String attributeKey)
GCubeMembershipRequest	rejectMembershipRequest(long userId, long groupId, String replyUsername, String replyComment)	rejects a membership request
GCubeMembershipRequest	requestMembership(long userId, long groupId, String comment)	request the membership to a restricted Site, no further actions are performed (no emails are sent, nor notifications)
void	saveCustomAttr(long userId, String attributeKey, Serializable value)
List<GCubeUser>	searchUsersByGroup(String keywords, long groupId)
void	setUserProfessionalBackground(long userId, String summary)	Save the user professional background
boolean	updateContactInformation(String screenName, String mySpacesn, String twittersn, String facebooksn, String skypesn, String jabbersn, String aimsn)	Update screenName user's contact information
boolean	updateJobTitle(long userId, String theJob)
boolean	userExistsByEmail(String email)	Check if a user with such email exists.

Methods inherited from class java.lang.Object

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

Constructor Details

LiferayWSUserManager

public LiferayWSUserManager(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

createUser

public GCubeUser createUser(boolean autoScreenName,
 String username,
 String email,
 String firstName,
 String middleName,
 String lastName,
 String jobTitle,
 String location_industry,
 String backgroundSummary,
 boolean male,
 String reminderQuestion,
 String reminderAnswer,
 int type)
                     throws UserManagementSystemException

Description copied from interface: UserManager

Create the user without sending notification mail and without forcing him to change the password at first login.

Specified by:

createUser in interface UserManager

Parameters:

autoScreenName - set true if you want liferay to auto generate a screename for this user, false otherwise

username - the username of the user you want

email - a valid email address

Returns:

an instance of the yet created user

Throws:

UserManagementSystemException

createUser

public GCubeUser createUser(boolean autoScreenName,
 String username,
 String email,
 String firstName,
 String middleName,
 String lastName,
 String jobTitle,
 String location_industry,
 String backgroundSummary,
 boolean male,
 String reminderQuestion,
 String reminderAnswer,
 boolean sendEmail,
 boolean forcePasswordReset,
 int type)
                     throws UserManagementSystemException

Description copied from interface: UserManager

Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password.

Specified by:

createUser in interface UserManager

Parameters:

autoScreenName - set true if you want liferay to auto generate a screename for this user, false otherwise

username - the username of the user you want

email - a valid email address

Returns:

an instance of the yet created user

Throws:

UserManagementSystemException

createUser

public GCubeUser createUser(boolean autoScreenName,
 String username,
 String email,
 String firstName,
 String middleName,
 String lastName,
 String jobTitle,
 String location_industry,
 String backgroundSummary,
 boolean male,
 String reminderQuestion,
 String reminderAnswer,
 boolean sendEmail,
 boolean forcePasswordReset,
 byte[] portraitBytes,
 int type)
                     throws UserManagementSystemException

Description copied from interface: UserManager

Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password. You can also pass the avatar to set as bytes.

Specified by:

createUser in interface UserManager

Parameters:

autoScreenName - set true if you want liferay to auto generate a screename for this user, false otherwise

username - the username of the user you want

email - a valid email address

portraitBytes - the bytes of the avatar to use for the user

type - the type of user

Returns:

an instance of the yet created user

Throws:

UserManagementSystemException - if a system exception occurs

createUser

public GCubeUser createUser(boolean autoScreenName,
 String username,
 String email,
 String firstName,
 String middleName,
 String lastName,
 String jobTitle,
 String location_industry,
 String backgroundSummary,
 boolean male,
 String reminderQuestion,
 String reminderAnswer,
 boolean sendEmail,
 boolean forcePasswordReset,
 byte[] portraitBytes,
 String mySpacesn,
 String twittersn,
 String facebooksn,
 String skypesn,
 String jabbersn,
 String aimsn,
 int type)
                     throws UserManagementSystemException

Description copied from interface: UserManager

Create the user and let you choose if you want to send him/her a mail notification and force or not the user to change his/her password. You can also pass the avatar to set as bytes. Moreover, contact information can be passed.

Specified by:

createUser in interface UserManager

mySpacesn - please note that this field will be used for Linkedin information!!

Returns:

Throws:

UserManagementSystemException

getUserByUsername

public GCubeUser getUserByUsername(String username)
                            throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserByUsername in interface UserManager

Parameters:

username - the username of the user you want to get

Returns:

the instance of the user

Throws:

UserManagementSystemException

UserRetrievalFault

getUserByScreenName

public GCubeUser getUserByScreenName(String username)
                              throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserByScreenName in interface UserManager

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

getUserByEmail

public GCubeUser getUserByEmail(String email)
                         throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserByEmail in interface UserManager

Parameters:

email - the email of the user you want to get

Returns:

the instance of the user

Throws:

UserManagementSystemException - if a system exception occurs

UserRetrievalFault - if the user does not exist

getUserById

public GCubeUser getUserById(long userId)
                      throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserById in interface UserManager

Parameters:

userId - the LR UserId

Returns:

the instance of the user

Throws:

UserManagementSystemException

UserRetrievalFault

getUserId

public long getUserId(String username)
               throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserId in interface UserManager

Parameters:

username - the LR screenname

Returns:

the LR userId associated to this screenname

Throws:

UserManagementSystemException

UserRetrievalFault

getUserProfessionalBackground

public String getUserProfessionalBackground(long userId)
                                     throws UserManagementSystemException,
UserRetrievalFault

Specified by:

getUserProfessionalBackground in interface UserManager

Parameters:

userId - the LR UserId

Returns:

the user professional background

Throws:

UserManagementSystemException

UserRetrievalFault

setUserProfessionalBackground

public void setUserProfessionalBackground(long userId,
 String summary)
                                   throws UserManagementSystemException,
UserRetrievalFault

Description copied from interface: UserManager

Save the user professional background

Specified by:

setUserProfessionalBackground in interface UserManager

Throws:

UserManagementSystemException - if a system exception occurs

UserRetrievalFault - if the user does not exist

listUsers

public List<GCubeUser> listUsers()
                          throws UserManagementSystemException

Specified by:

listUsers in interface UserManager

Returns:

a list of all portal active users (using indexed version search) no matter if the belong or not to a VRE, if a user is deactived is not returned

Throws:

UserManagementSystemException

listUsers

public List<GCubeUser> listUsers(boolean indexed)
                          throws UserManagementSystemException

Specified by:

listUsers in interface UserManager

Parameters:

indexed - set to true to use the indexed version search false for a real time query to the DB.

Returns:

a list of all portal active users no matter if the belong or not to a VRE, if a user is deactived is not returned

Throws:

UserManagementSystemException

listUsersByGroup

public List<GCubeUser> listUsersByGroup(long groupId)
                                 throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUsersByGroup in interface UserManager

Parameters:

groupId - the LR groupId

Returns:

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

listUsersByGroup

public List<GCubeUser> listUsersByGroup(long groupId,
 boolean indexed)
                                 throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUsersByGroup in interface UserManager

Parameters:

groupId - the LR groupId

indexed - set to true to use the indexed version search false for a real time query to the DB.

Returns:

a list of all portal active users belonging to the given groupid

Throws:

UserManagementSystemException - if a system exception occurs

GroupRetrievalFault - if the group does not exist

UserRetrievalFault - .

listUsersByGroupName

public List<GCubeUser> listUsersByGroupName(String name)
                                     throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUsersByGroupName in interface UserManager

Parameters:

name - the name of the VO or VRE (e.g. devVRE, or gcube etc.)

Returns:

a list of users

Throws:

UserManagementSystemException - if a system exception occurs

GroupRetrievalFault

UserRetrievalFault

getUserContactsByGroup

public Set<GCubeUser> getUserContactsByGroup(long userId,
 long scopeGroupId)
                                      throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

getUserContactsByGroup in interface UserManager

Parameters:

userId - the LR userid for which you need to fetch the contacts

scopeGroupId - the liferay groupid number of the current Site

Returns:

a set containing all portal active users that the user can contact/see (depending on the scopeGroupId he/she can see the users a VRE, or the users of all the VREs he/she is subscribed)

Throws:

UserManagementSystemException - .

GroupRetrievalFault - .

UserRetrievalFault - .

listMembershipRequestsByGroup

public List<GCubeMembershipRequest> listMembershipRequestsByGroup(long groupId)
                                                           throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listMembershipRequestsByGroup in interface UserManager

Parameters:

groupId - the LR groupId

Returns:

the list of GCubeMembershipRequest with their status and users given the LR GroupId (status can be requested, approved or rejected, @see MembershipRequestStatus

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

listPendingMembershipRequestsByGroup

public List<GCubeMembershipRequest> listPendingMembershipRequestsByGroup(long groupId)
                                                                  throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listPendingMembershipRequestsByGroup in interface UserManager

Parameters:

groupId - the LR groupId

Returns:

the list of GCubeMembershipRequest with status requested and users given the LR GroupId @see MembershipRequestStatus

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

getMembershipRequestsById

public GCubeMembershipRequest getMembershipRequestsById(long membershipRequestId)

Specified by:

getMembershipRequestsById in interface UserManager

Parameters:

membershipRequestId - the id of the request

Returns:

an istance of GCubeMembershipRequest

getMembershipRequests

public List<GCubeMembershipRequest> getMembershipRequests(long userId,
 long groupId,
 MembershipRequestStatus status)
                                                   throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

getMembershipRequests in interface UserManager

Parameters:

userId - the LR userid

groupId - the LR groupId the

status - an istance of MembershipRequestStatus

Returns:

the list of GCubeMembershipRequest with their status and users given the LR GroupId and userId (status can be requested, approved or rejected, @see MembershipRequestStatus

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

requestMembership

public GCubeMembershipRequest requestMembership(long userId,
 long groupId,
 String comment)
                                         throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Description copied from interface: UserManager

request the membership to a restricted Site, no further actions are performed (no emails are sent, nor notifications)

Specified by:

requestMembership in interface UserManager

Parameters:

userId - the LR userid

groupId - the LR groupId the

comment - a comment to the request must not be null

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

acceptMembershipRequest

public GCubeMembershipRequest acceptMembershipRequest(long requestUserId,
 long groupId,
 boolean addUserToGroup,
 String replyUsername,
 String replyComment)
                                               throws UserManagementSystemException,
GroupRetrievalFault,
UserManagementPortalException

Description copied from interface: UserManager

accept a membership request and optionally add the user to the group

Specified by:

acceptMembershipRequest in interface UserManager

Parameters:

requestUserId - the LR userid of the request

groupId - the LR groupId

addUserToGroup - if you want it to also add the user to the group

replyUsername - the username (screenname) of the user accepting the request

replyComment - a comment attachd to the reply (must not be null)

Throws:

UserManagementSystemException - if a system exception occurs

GroupRetrievalFault

UserManagementPortalException

rejectMembershipRequest

public GCubeMembershipRequest rejectMembershipRequest(long userId,
 long groupId,
 String replyUsername,
 String replyComment)
                                               throws UserManagementSystemException,
GroupRetrievalFault,
UserManagementPortalException

Description copied from interface: UserManager

rejects a membership request

Specified by:

rejectMembershipRequest in interface UserManager

Parameters:

userId - the LR userid of the request

groupId - the LR groupId

replyUsername - the username (screenname) of the user accepting the request

replyComment - a comment attachd to the reply (must not be null)

Throws:

UserManagementSystemException - if a system exception occurs

GroupRetrievalFault

UserManagementPortalException

listUsersAndRolesByGroup

public Map<GCubeUser,List<GCubeRole>> listUsersAndRolesByGroup(long groupId)
                                                        throws GroupRetrievalFault,
UserManagementSystemException,
UserRetrievalFault

Specified by:

listUsersAndRolesByGroup in interface UserManager

Parameters:

groupId - the LR groupId

Returns:

the list of GCubeUser with their GCubeRole given the LR GroupId

Throws:

GroupRetrievalFault

UserManagementSystemException

UserRetrievalFault

listUsersByGroupAndRole

public List<GCubeUser> listUsersByGroupAndRole(long groupId,
 long roleId)
                                        throws UserManagementSystemException,
RoleRetrievalFault,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUsersByGroupAndRole in interface UserManager

Parameters:

groupId - the LR groupId

roleId - the LR roleId

Returns:

the list of GCubeUser having group and role that matches

Throws:

UserManagementSystemException

GroupRetrievalFault - if the group does not exist

UserRetrievalFault

RoleRetrievalFault

listUsersByTeam

public List<GCubeUser> listUsersByTeam(long teamId)
                                throws UserManagementSystemException,
TeamRetrievalFault,
UserRetrievalFault

Description copied from interface: UserManager

/**

Specified by:

listUsersByTeam in interface UserManager

Parameters:

teamId - the LR teamId

Returns:

the list of GCubeUser having teamId that matches

Throws:

UserManagementSystemException

TeamRetrievalFault - if the team does not exist

UserRetrievalFault

assignUserToGroup

public void assignUserToGroup(long groupId,
 long userId)
                       throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault,
UserManagementPortalException

Description copied from interface: UserManager

this method assigns the user to the Group and perform other necessary actions (such as adding him to the HL Folder)

Specified by:

assignUserToGroup in interface UserManager

Parameters:

groupId - LR groupId

userId - LR userId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

UserManagementPortalException

dismissUserFromGroup

public void dismissUserFromGroup(long groupId,
 long userId)
                          throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Description copied from interface: UserManager

this method removes the user to the Group and perform other necessary actions (such as removing him from the HL Folder)

Specified by:

dismissUserFromGroup in interface UserManager

Parameters:

groupId - LR groupId

userId - LR userId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

listUnregisteredUsersByGroup

public List<GCubeUser> listUnregisteredUsersByGroup(long groupId)
                                             throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUnregisteredUsersByGroup in interface UserManager

Parameters:

groupId - LR groupId

Returns:

all the users of the portal not belonging to the groupId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

isPasswordChanged

public boolean isPasswordChanged(String email)

Description copied from interface: UserManager

Check if the user changed his/her password from the initial one.

Specified by:

isPasswordChanged in interface UserManager

Parameters:

email - the email of the user to consider

Returns:

true if the password has been changed, false if it has been not or the user doesn't exist.

userExistsByEmail

public boolean userExistsByEmail(String email)

Description copied from interface: UserManager

Check if a user with such email exists.

Specified by:

userExistsByEmail in interface UserManager

Returns:

true on success, false otherwise

getFullNameFromEmail

public String getFullNameFromEmail(String email)

Description copied from interface: UserManager

Returns the user's full name given his email

Specified by:

getFullNameFromEmail in interface UserManager

Returns:

null on failure

deleteUserByEMail

public void deleteUserByEMail(String email)
                       throws UserManagementSystemException,
UserManagementPortalException,
com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException

Description copied from interface: UserManager

Delete a user given his mail

Specified by:

deleteUserByEMail in interface UserManager

Throws:

UserManagementSystemException

UserManagementPortalException

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getUserAvatarBytes

public byte[] getUserAvatarBytes(String screenName)

Description copied from interface: UserManager

Retrieve user's avatar as bytes

Specified by:

getUserAvatarBytes in interface UserManager

getUserOpenId

public String getUserOpenId(String screenName)

Description copied from interface: UserManager

Retrieve user's openId field

Specified by:

getUserOpenId in interface UserManager

updateContactInformation

public boolean updateContactInformation(String screenName,
 String mySpacesn,
 String twittersn,
 String facebooksn,
 String skypesn,
 String jabbersn,
 String aimsn)

Description copied from interface: UserManager

Update screenName user's contact information

Specified by:

updateContactInformation in interface UserManager

mySpacesn - used for linkedin contact info

Returns:

true on success, false otherwise

updateJobTitle

public boolean updateJobTitle(long userId,
 String theJob)

Specified by:

updateJobTitle in interface UserManager

theJob - the job headline

Returns:

true if ok

readCustomAttr

public Serializable readCustomAttr(long userId,
 String attributeKey)
                            throws UserRetrievalFault

Specified by:

readCustomAttr in interface UserManager

attributeKey - the name of the attribute you want to read its value

Returns:

the attributeKey value if existing, null otherwise

Throws:

UserRetrievalFault

saveCustomAttr

public void saveCustomAttr(long userId,
 String attributeKey,
 Serializable value)
                    throws UserRetrievalFault

Specified by:

saveCustomAttr in interface UserManager

attributeKey - the name of the attribute you want to save

value - the value

Throws:

UserRetrievalFault

listUsersByGlobalRole

public List<GCubeUser> listUsersByGlobalRole(long roleId)

Description copied from interface: UserManager

Retrieve a list of users having a global role (e.g., Administrator)

Specified by:

listUsersByGlobalRole in interface UserManager

Returns:

getUserIdsByGroup

public List<Long> getUserIdsByGroup(long groupId)

Description copied from interface: UserManager

Retrieve the list of user identifiers by group id.

Specified by:

getUserIdsByGroup in interface UserManager

Returns:

listUsers

public List<GCubeUser> listUsers(int start,
 int end)
                          throws UserManagementSystemException

Description copied from interface: UserManager

Returns a range of all the users. Useful when paginating results. Returns a maximum of end - start instances, 0 refers to the first result in the set.

Specified by:

listUsers in interface UserManager

Parameters:

start - start the lower bound of the range of users

end - end the upper bound of the range of users (not inclusive)

Returns:

the range of users

Throws:

UserManagementSystemException

getUsersCount

public int getUsersCount()
                  throws UserManagementSystemException

Description copied from interface: UserManager

Returns the number of total users.

Specified by:

getUsersCount in interface UserManager

Returns:

the number of users

Throws:

UserManagementSystemException

searchUsersByGroup

public List<GCubeUser> searchUsersByGroup(String keywords,
 long groupId)
                                   throws GroupRetrievalFault

Specified by:

searchUsersByGroup in interface UserManager

Parameters:

keywords - the keywords (space separated), which may occur in the user's first name, middle name, last name, username, or email address

Returns:

all the users who match the keywords ordered by username (Ascendent order)

Throws:

GroupRetrievalFault - if the group does not exist

listUsersByGroup

public List<GCubeUser> listUsersByGroup(long groupId,
 int start,
 int end)
                                 throws UserManagementSystemException,
GroupRetrievalFault,
UserRetrievalFault

Specified by:

listUsersByGroup in interface UserManager

Parameters:

groupId - the LR groupId

Returns:

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

getGroupUsersCount

public int getGroupUsersCount(long groupId)
                       throws GroupRetrievalFault

Description copied from interface: UserManager

Returns the number of users in the group (VRE).

Specified by:

getGroupUsersCount in interface UserManager

Returns:

the number of users in the group (VRE).

Throws:

GroupRetrievalFault

listUserIdsByGroupAndRole

public long[] listUserIdsByGroupAndRole(long groupId,
 long roleId)

Specified by:

listUserIdsByGroupAndRole in interface UserManager

Returns:

the list of userId having group and role that matches