Package org.gcube.vomanagement.usermanagement

Interface UserManager

All Known Implementing Classes:

LiferayUserManager, LiferayWSUserManager

public interface UserManager

Author:

Massimiliano Assante, CNR-ISTI

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)	Deprecated. use getUserByUsername
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.

Method Details

createUser

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

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

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

firstName -

middleName -

lastName -

jobTitle -

backgroundSummary -

male -

Returns:

an instance of the yet created user

Throws:

UserManagementSystemException

createUser

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

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.

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

firstName -

middleName -

lastName -

jobTitle -

backgroundSummary -

male -

Returns:

an instance of the yet created user

Throws:

UserManagementSystemException

createUser

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

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.

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

firstName -

middleName -

lastName -

jobTitle -

backgroundSummary -

male -

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

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

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

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.

Parameters:

autoScreenName -

username -

email -

firstName -

middleName -

lastName -

jobTitle -

location_industry -

backgroundSummary -

male -

reminderQuestion -

reminderAnswer -

sendEmail -

forcePasswordReset -

portraitBytes -

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

twittersn -

facebooksn -

skypesn -

jabbersn -

aimsn -

Returns:

Throws:

UserManagementSystemException

getUserByUsername

GCubeUser getUserByUsername(String username)
                     throws UserManagementSystemException,
UserRetrievalFault

Parameters:

username - the username of the user you want to get

Returns:

the instance of the user

Throws:

UserManagementSystemException

UserRetrievalFault

getUserByScreenName

@Deprecated
GCubeUser getUserByScreenName(String username)
                       throws UserManagementSystemException,
UserRetrievalFault

Deprecated.

use getUserByUsername

Parameters:

username -

Returns:

Throws:

UserManagementSystemException

UserRetrievalFault

getUserByEmail

GCubeUser getUserByEmail(String email)
                  throws UserManagementSystemException,
UserRetrievalFault

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

GCubeUser getUserById(long userId)
               throws UserManagementSystemException,
UserRetrievalFault

Parameters:

userId - the LR UserId

Returns:

the instance of the user

Throws:

UserManagementSystemException

UserRetrievalFault

getUserId

long getUserId(String username)
        throws UserManagementSystemException,
UserRetrievalFault

Parameters:

username - the LR screenname

Returns:

the LR userId associated to this screenname

Throws:

UserManagementSystemException

UserRetrievalFault

getUserProfessionalBackground

String getUserProfessionalBackground(long userId)
                              throws UserManagementSystemException,
UserRetrievalFault

Parameters:

userId - the LR UserId

Returns:

the user professional background

Throws:

UserManagementSystemException

UserRetrievalFault

setUserProfessionalBackground

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

Save the user professional background

Parameters:

userId -

summary -

Throws:

UserManagementSystemException - if a system exception occurs

UserRetrievalFault - if the user does not exist

listUsers

List<GCubeUser> listUsers()
                   throws UserManagementSystemException

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

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

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.

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

int getUsersCount()
           throws UserManagementSystemException

Returns the number of total users.

Returns:

the number of users

Throws:

UserManagementSystemException

listUsers

List<GCubeUser> listUsers(boolean indexed)
                   throws UserManagementSystemException

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

searchUsersByGroup

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

Parameters:

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

groupId -

Returns:

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

Throws:

GroupRetrievalFault - if the group does not exist

UserRetrievalFault - if the user does not exist

listUsersByGroup

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

Parameters:

groupId - the LR groupId

Returns:

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

listUsersByGroup

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

Parameters:

groupId - the LR groupId

Returns:

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

getGroupUsersCount

int getGroupUsersCount(long groupId)
                throws GroupRetrievalFault

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

Returns:

the number of users in the group (VRE).

Throws:

GroupRetrievalFault

listUsersByGlobalRole

List<GCubeUser> listUsersByGlobalRole(long roleId)

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

Parameters:

roleId -

Returns:

listUsersByGroup

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

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

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

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

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

Parameters:

scopeGroupId - the liferay groupid number of the current Site

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

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

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

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

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

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

GCubeMembershipRequest getMembershipRequestsById(long membershipRequestId)

Parameters:

membershipRequestId - the id of the request

Returns:

an istance of GCubeMembershipRequest

getMembershipRequests

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

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

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

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

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

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

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

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

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

rejects a membership request

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

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

Parameters:

groupId - the LR groupId

Returns:

the list of GCubeUser with their GCubeRole given the LR GroupId

Throws:

GroupRetrievalFault

UserManagementSystemException

UserRetrievalFault

listUsersByGroupAndRole

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

Parameters:

groupId - the LR groupId

roleId - the LR roleId

Returns:

the list of GCubeUser having group and role that matches

Throws:

GroupRetrievalFault - if the group does not exist

UserManagementSystemException

UserRetrievalFault

RoleRetrievalFault

listUserIdsByGroupAndRole

long[] listUserIdsByGroupAndRole(long groupId,
 long roleId)

Parameters:

groupId -

roleId -

Returns:

the list of userId having group and role that matches

listUsersByTeam

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

/**

Parameters:

teamId - the LR teamId

Returns:

the list of GCubeUser having teamId that matches

Throws:

TeamRetrievalFault - if the team does not exist

UserManagementSystemException

UserRetrievalFault

assignUserToGroup

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

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

Parameters:

groupId - LR groupId

userId - LR userId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

UserManagementPortalException

dismissUserFromGroup

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

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

Parameters:

groupId - LR groupId

userId - LR userId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

listUnregisteredUsersByGroup

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

Parameters:

groupId - LR groupId

Returns:

all the users of the portal not belonging to the groupId

Throws:

UserManagementSystemException

GroupRetrievalFault

UserRetrievalFault

isPasswordChanged

boolean isPasswordChanged(String email)

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

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

boolean userExistsByEmail(String email)

Check if a user with such email exists.

Parameters:

email -

Returns:

true on success, false otherwise

getFullNameFromEmail

String getFullNameFromEmail(String email)

Returns the user's full name given his email

Parameters:

email -

Returns:

null on failure

deleteUserByEMail

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

Delete a user given his mail

Parameters:

email -

Throws:

UserManagementSystemException

UserManagementPortalException

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getUserAvatarBytes

byte[] getUserAvatarBytes(String screenName)

Retrieve user's avatar as bytes

getUserOpenId

String getUserOpenId(String screenName)

Retrieve user's openId field

updateContactInformation

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

Update screenName user's contact information

Parameters:

screenName -

mySpacesn - used for linkedin contact info

twittersn -

facebooksn -

skypesn -

jabbersn -

aimsn -

Returns:

true on success, false otherwise

updateJobTitle

boolean updateJobTitle(long userId,
 String theJob)

Parameters:

userId -

theJob - the job headline

Returns:

true if ok

readCustomAttr

Serializable readCustomAttr(long userId,
 String attributeKey)
                     throws UserRetrievalFault

Parameters:

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

Returns:

the attributeKey value if existing, null otherwise

Throws:

UserRetrievalFault

saveCustomAttr

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

Parameters:

userId -

attributeKey - the name of the attribute you want to save

value - the value

Throws:

UserRetrievalFault

getUserIdsByGroup

List<Long> getUserIdsByGroup(long groupId)

Retrieve the list of user identifiers by group id.

Returns: