|
Liferay 6.2-ce-ga4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portal.service.base.UserLocalServiceBaseImpl
com.liferay.portal.service.impl.UserLocalServiceImpl
public class UserLocalServiceImpl
Provides the local service for accessing, adding, authenticating, deleting, and updating users.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
UserLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
User |
addDefaultAdminUser(long companyId,
String screenName,
String emailAddress,
Locale locale,
String firstName,
String middleName,
String lastName)
Adds a default admin user for the company. |
void |
addDefaultGroups(long userId)
Adds the user to the default groups, unless the user is already in these groups. |
void |
addDefaultRoles(long userId)
Adds the user to the default roles, unless the user already has these roles. |
protected void |
addDefaultRolesAndTeams(long groupId,
long[] userIds)
|
void |
addDefaultUserGroups(long userId)
Adds the user to the default user groups, unless the user is already in these user groups. |
void |
addGroupUsers(long groupId,
long[] userIds)
Adds the users to the group. |
void |
addOrganizationUsers(long organizationId,
long[] userIds)
Adds the users to the organization. |
void |
addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
Assigns the password policy to the users, removing any other currently assigned password policies. |
void |
addRoleUsers(long roleId,
long[] userIds)
Adds the users to the role. |
void |
addTeamUsers(long teamId,
long[] userIds)
Adds the users to the team. |
User |
addUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user. |
void |
addUserGroupUsers(long userGroupId,
long[] userIds)
Adds the users to the user group. |
User |
addUserWithWorkflow(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
Adds a user with workflow. |
protected int |
authenticate(long companyId,
String login,
String password,
String authType,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
Attempts to authenticate the user by their login and password, while using the AuthPipeline. |
int |
authenticateByEmailAddress(long companyId,
String emailAddress,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
Attempts to authenticate the user by their email address and password, while using the AuthPipeline. |
int |
authenticateByScreenName(long companyId,
String screenName,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
Attempts to authenticate the user by their screen name and password, while using the AuthPipeline. |
int |
authenticateByUserId(long companyId,
long userId,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
Attempts to authenticate the user by their primary key and password, while using the AuthPipeline. |
long |
authenticateForBasic(long companyId,
String authType,
String login,
String password)
Attempts to authenticate the user using HTTP basic access authentication, without using the AuthPipeline. |
long |
authenticateForDigest(long companyId,
String username,
String realm,
String nonce,
String method,
String uri,
String response)
Attempts to authenticate the user using HTTP digest access authentication, without using the AuthPipeline. |
boolean |
authenticateForJAAS(long userId,
String encPassword)
Attempts to authenticate the user using JAAS credentials, without using the AuthPipeline. |
void |
checkLockout(User user)
Checks if the user is currently locked out based on the password policy, and performs maintenance on the user's lockout and failed login data. |
void |
checkLoginFailure(User user)
Adds a failed login attempt to the user and updates the user's last failed login date. |
void |
checkLoginFailureByEmailAddress(long companyId,
String emailAddress)
Adds a failed login attempt to the user with the email address and updates the user's last failed login date. |
void |
checkLoginFailureById(long userId)
Adds a failed login attempt to the user and updates the user's last failed login date. |
void |
checkLoginFailureByScreenName(long companyId,
String screenName)
Adds a failed login attempt to the user with the screen name and updates the user's last failed login date. |
void |
checkPasswordExpired(User user)
Checks if the user's password is expired based on the password policy, and performs maintenance on the user's grace login and password reset data. |
void |
clearOrganizationUsers(long organizationId)
Removes all the users from the organization. |
void |
clearUserGroupUsers(long userGroupId)
Removes all the users from the user group. |
void |
completeUserRegistration(User user,
ServiceContext serviceContext)
Completes the user's registration by generating a password and sending the confirmation email. |
KeyValuePair |
decryptUserId(long companyId,
String name,
String password)
Decrypts the user's primary key and password from their encrypted forms. |
void |
deletePortrait(long userId)
Deletes the user's portrait image. |
void |
deleteRoleUser(long roleId,
long userId)
Removes the user from the role. |
User |
deleteUser(long userId)
Deletes the user. |
User |
deleteUser(User user)
Deletes the user. |
void |
deleteUserGroupUser(long userGroupId,
long userId)
Removes the user from the user group. |
String |
encryptUserId(String name)
Encrypts the primary key of the user. |
User |
fetchUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address. |
User |
fetchUserByFacebookId(long companyId,
long facebookId)
Returns the user with the Facebook ID. |
User |
fetchUserById(long userId)
Returns the user with the primary key. |
User |
fetchUserByOpenId(long companyId,
String openId)
Returns the user with the OpenID. |
User |
fetchUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name. |
protected Date |
getBirthday(int birthdayMonth,
int birthdayDay,
int birthdayYear)
|
List<User> |
getCompanyUsers(long companyId,
int start,
int end)
Returns a range of all the users belonging to the company. |
int |
getCompanyUsersCount(long companyId)
Returns the number of users belonging to the company. |
User |
getDefaultUser(long companyId)
Returns the default user for the company. |
long |
getDefaultUserId(long companyId)
Returns the primary key of the default user for the company. |
long[] |
getGroupUserIds(long groupId)
Returns the primary keys of all the users belonging to the group. |
int |
getGroupUsersCount(long groupId,
int status)
Returns the number of users with the status belonging to the group. |
List<User> |
getInheritedRoleUsers(long roleId,
int start,
int end,
OrderByComparator obc)
|
protected String |
getLogin(String login)
|
List<User> |
getNoAnnouncementsDeliveries(String type)
Returns all the users who have not had any announcements of the type delivered, excluding the default user. |
List<User> |
getNoContacts()
Returns all the users who do not have any contacts. |
List<User> |
getNoGroups()
Returns all the users who do not belong to any groups, excluding the default user. |
long[] |
getOrganizationUserIds(long organizationId)
Returns the primary keys of all the users belonging to the organization. |
int |
getOrganizationUsersCount(long organizationId,
int status)
Returns the number of users with the status belonging to the organization. |
long[] |
getRoleUserIds(long roleId)
Returns the primary keys of all the users belonging to the role. |
int |
getRoleUsersCount(long roleId,
int status)
Returns the number of users with the status belonging to the role. |
List<User> |
getSocialUsers(long userId,
int type,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users with a social relation of the type with the user. |
List<User> |
getSocialUsers(long userId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users with a social relation with the user. |
List<User> |
getSocialUsers(long userId1,
long userId2,
int type,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users with a mutual social relation of the type with both of the given users. |
List<User> |
getSocialUsers(long userId1,
long userId2,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users with a mutual social relation with both of the given users. |
int |
getSocialUsersCount(long userId)
Returns the number of users with a social relation with the user. |
int |
getSocialUsersCount(long userId,
int type)
Returns the number of users with a social relation of the type with the user. |
int |
getSocialUsersCount(long userId1,
long userId2)
Returns the number of users with a mutual social relation with both of the given users. |
int |
getSocialUsersCount(long userId1,
long userId2,
int type)
Returns the number of users with a mutual social relation of the type with both of the given users. |
User |
getUserByContactId(long contactId)
Returns the user with the contact ID. |
User |
getUserByEmailAddress(long companyId,
String emailAddress)
Returns the user with the email address. |
User |
getUserByFacebookId(long companyId,
long facebookId)
Returns the user with the Facebook ID. |
User |
getUserById(long userId)
Returns the user with the primary key. |
User |
getUserById(long companyId,
long userId)
Returns the user with the primary key from the company. |
User |
getUserByOpenId(long companyId,
String openId)
Returns the user with the OpenID. |
User |
getUserByPortraitId(long portraitId)
Returns the user with the portrait ID. |
User |
getUserByScreenName(long companyId,
String screenName)
Returns the user with the screen name. |
User |
getUserByUuid(String uuid)
Deprecated. As of 6.2.0, replaced by getUserByUuidAndCompanyId(String, long) |
User |
getUserByUuidAndCompanyId(String uuid,
long companyId)
Returns the user with the UUID. |
int |
getUserGroupUsersCount(long userGroupId,
int status)
Returns the number of users with the status belonging to the user group. |
long |
getUserIdByEmailAddress(long companyId,
String emailAddress)
Returns the primary key of the user with the email address. |
long |
getUserIdByScreenName(long companyId,
String screenName)
Returns the primary key of the user with the screen name. |
protected long[] |
getUserIds(List<User> users)
|
boolean |
hasPasswordPolicyUser(long passwordPolicyId,
long userId)
Returns true if the password policy has been assigned to the
user. |
boolean |
hasRoleUser(long companyId,
String name,
long userId,
boolean inherited)
Returns true if the user has the role with the name,
optionally through inheritance. |
boolean |
isPasswordExpired(User user)
Returns true if the user's password is expired. |
boolean |
isPasswordExpiringSoon(User user)
Returns true if the password policy is configured to warn
the user that his password is expiring and the remaining time until
expiration is equal or less than the configured warning time. |
User |
loadGetDefaultUser(long companyId)
Returns the default user for the company. |
protected void |
reindex(User user)
|
List<User> |
search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users who match the keywords and status, without using the indexer. |
Hits |
search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
Returns an ordered range of all the users who match the keywords and status, using the indexer. |
List<User> |
search(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, without using the indexer. |
Hits |
search(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
Returns an ordered range of all the users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them, using the indexer. |
protected Hits |
search(long companyId,
String firstName,
String middleName,
String lastName,
String fullName,
String screenName,
String emailAddress,
String street,
String city,
String zip,
String region,
String country,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
|
int |
searchCount(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params)
Returns the number of users who match the keywords and status. |
int |
searchCount(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch)
Returns the number of users with the status, and whose first name, middle name, last name, screen name, and email address match the keywords specified for them. |
protected void |
sendEmail(User user,
String password,
ServiceContext serviceContext)
|
void |
sendEmailAddressVerification(User user,
String emailAddress,
ServiceContext serviceContext)
Sends an email address verification to the user. |
void |
sendPassword(long companyId,
String emailAddress,
String fromName,
String fromAddress,
String subject,
String body,
ServiceContext serviceContext)
Sends the password email to the user with the email address. |
protected void |
setEmailAddress(User user,
String password,
String firstName,
String middleName,
String lastName,
String emailAddress)
|
void |
setRoleUsers(long roleId,
long[] userIds)
Sets the users in the role, removing and adding users to the role as necessary. |
void |
setUserGroupUsers(long userGroupId,
long[] userIds)
Sets the users in the user group, removing and adding users to the user group as necessary. |
void |
unsetGroupTeamsUsers(long groupId,
long[] userIds)
Removes the users from the teams of a group. |
void |
unsetGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
Removes the users from the group. |
void |
unsetOrganizationUsers(long organizationId,
long[] userIds)
Removes the users from the organization. |
void |
unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
Removes the users from the password policy. |
void |
unsetRoleUsers(long roleId,
List<User> users)
Removes the users from the role. |
void |
unsetRoleUsers(long roleId,
long[] userIds)
Removes the users from the role. |
void |
unsetTeamUsers(long teamId,
long[] userIds)
Removes the users from the team. |
void |
unsetUserGroupUsers(long userGroupId,
long[] userIds)
Removes the users from the user group. |
User |
updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
Updates whether the user has agreed to the terms of use. |
void |
updateAsset(long userId,
User user,
long[] assetCategoryIds,
String[] assetTagNames)
Updates the user's asset with the new asset categories and tag names, removing and adding asset categories and tag names as necessary. |
User |
updateCreateDate(long userId,
Date createDate)
Updates the user's creation date. |
User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
Updates the user's email address. |
User |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2,
ServiceContext serviceContext)
Updates the user's email address or sends verification email. |
User |
updateEmailAddressVerified(long userId,
boolean emailAddressVerified)
Updates whether the user has verified email address. |
User |
updateFacebookId(long userId,
long facebookId)
Updates the user's Facebook ID. |
void |
updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext)
Sets the groups the user is in, removing and adding groups as necessary. |
protected void |
updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext,
boolean indexingEnabled)
|
User |
updateIncompleteUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
boolean updateUserInformation,
boolean sendEmail,
ServiceContext serviceContext)
Updates a user account that was automatically created when a guest user participated in an action (e.g. posting a comment) and only provided his name and email address. |
User |
updateJobTitle(long userId,
String jobTitle)
Updates the user's job title. |
User |
updateLastLogin(long userId,
String loginIP)
Updates the user's last login with the current time and the IP address. |
User |
updateLockout(User user,
boolean lockout)
Updates whether the user is locked out from logging in. |
User |
updateLockoutByEmailAddress(long companyId,
String emailAddress,
boolean lockout)
Updates whether the user is locked out from logging in. |
User |
updateLockoutById(long userId,
boolean lockout)
Updates whether the user is locked out from logging in. |
User |
updateLockoutByScreenName(long companyId,
String screenName,
boolean lockout)
Updates whether the user is locked out from logging in. |
User |
updateModifiedDate(long userId,
Date modifiedDate)
Updates the user's modified date. |
User |
updateOpenId(long userId,
String openId)
Updates the user's OpenID. |
protected void |
updateOrganizations(long userId,
long[] newOrganizationIds,
boolean indexingEnabled)
|
void |
updateOrganizations(long userId,
long[] newOrganizationIds,
ServiceContext serviceContext)
Sets the organizations that the user is in, removing and adding organizations as necessary. |
User |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
Updates the user's password without tracking or validation of the change. |
User |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset,
boolean silentUpdate)
Updates the user's password, optionally with tracking and validation of the change. |
User |
updatePasswordManually(long userId,
String password,
boolean passwordEncrypted,
boolean passwordReset,
Date passwordModifiedDate)
Updates the user's password with manually input information. |
User |
updatePasswordReset(long userId,
boolean passwordReset)
Updates whether the user should be asked to reset their password the next time they login. |
User |
updatePortrait(long userId,
byte[] bytes)
Updates the user's portrait image. |
User |
updateReminderQuery(long userId,
String question,
String answer)
Updates the user's password reset question and answer. |
User |
updateScreenName(long userId,
String screenName)
Updates the user's screen name. |
User |
updateStatus(long userId,
int status)
Deprecated. As of 7.0.0, replaced by updateStatus(long, int,
ServiceContext) |
User |
updateStatus(long userId,
int status,
ServiceContext serviceContext)
Updates the user's workflow status. |
User |
updateUser(long userId,
String oldPassword,
String newPassword1,
String newPassword2,
boolean passwordReset,
String reminderQueryQuestion,
String reminderQueryAnswer,
String screenName,
String emailAddress,
long facebookId,
String openId,
String languageId,
String timeZoneId,
String greeting,
String comments,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String smsSn,
String aimSn,
String facebookSn,
String icqSn,
String jabberSn,
String msnSn,
String mySpaceSn,
String skypeSn,
String twitterSn,
String ymSn,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
List<UserGroupRole> userGroupRoles,
long[] userGroupIds,
ServiceContext serviceContext)
Updates the user. |
protected void |
updateUserGroupRoles(User user,
long[] groupIds,
long[] organizationIds,
List<UserGroupRole> userGroupRoles,
List<UserGroupRole> previousUserGroupRoles)
|
protected void |
validate(long companyId,
long userId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
String openId,
String firstName,
String middleName,
String lastName,
long[] organizationIds)
|
protected void |
validate(long userId,
String screenName,
String emailAddress,
String openId,
String firstName,
String middleName,
String lastName,
String smsSn)
|
protected void |
validateCompanyMaxUsers(long companyId)
|
protected void |
validateEmailAddress(long companyId,
String emailAddress)
|
protected void |
validateEmailAddress(User user,
String emailAddress1,
String emailAddress2)
|
protected void |
validateFullName(long companyId,
String firstName,
String middleName,
String lastName)
|
protected void |
validateOpenId(long companyId,
long userId,
String openId)
|
protected void |
validatePassword(long companyId,
long userId,
String password1,
String password2)
|
protected void |
validateReminderQuery(String question,
String answer)
|
protected void |
validateScreenName(long companyId,
long userId,
String screenName)
|
void |
verifyEmailAddress(String ticketKey)
Verifies the email address of the ticket. |
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLayoutURL, getLayoutURL |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UserLocalServiceImpl()
| Method Detail |
|---|
public User addDefaultAdminUser(long companyId,
String screenName,
String emailAddress,
Locale locale,
String firstName,
String middleName,
String lastName)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen nameemailAddress - the user's email addresslocale - the user's localefirstName - the user's first namemiddleName - the user's middle namelastName - the user's last name
PortalException - n if a portal exception occurred
SystemException - if a system exception occurred
public void addDefaultGroups(long userId)
throws PortalException,
SystemException
portal.properties with the key
admin.default.group.names.
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void addDefaultRoles(long userId)
throws PortalException,
SystemException
portal.properties with the key
admin.default.role.names.
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void addDefaultUserGroups(long userId)
throws PortalException,
SystemException
portal.properties with the property
admin.default.user.group.names.
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void addGroupUsers(long groupId,
long[] userIds)
throws PortalException,
SystemException
addGroupUsers in interface UserLocalServiceaddGroupUsers in class UserLocalServiceBaseImplgroupId - the primary key of the groupuserIds - the primary keys of the users
PortalException - if a group or user with the primary key could not
be found
SystemException - if a system exception occurred
public void addOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException,
SystemException
addOrganizationUsers in interface UserLocalServiceaddOrganizationUsers in class UserLocalServiceBaseImplorganizationId - the primary key of the organizationuserIds - the primary keys of the users
PortalException - if an organization or user with the primary key
could not be found
SystemException - if a system exception occurred
public void addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws SystemException
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the users
SystemException - if a system exception occurred
public void addRoleUsers(long roleId,
long[] userIds)
throws PortalException,
SystemException
addRoleUsers in interface UserLocalServiceaddRoleUsers in class UserLocalServiceBaseImplroleId - the primary key of the roleuserIds - the primary keys of the users
PortalException - if a role or user with the primary key could not
be found
SystemException - if a system exception occurred
public void addTeamUsers(long teamId,
long[] userIds)
throws PortalException,
SystemException
addTeamUsers in interface UserLocalServiceaddTeamUsers in class UserLocalServiceBaseImplteamId - the primary key of the teamuserIds - the primary keys of the users
PortalException - if a team or user with the primary key could not
be found
SystemException - if a system exception occurred
public User addUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
throws PortalException,
SystemException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
creatorUserId - the primary key of the creatorcompanyId - the primary key of the user's companyautoPassword - whether a password should be automatically generated
for the userpassword1 - the user's passwordpassword2 - the user's password confirmationautoScreenName - whether a screen name should be automatically
generated for the userscreenName - the user's screen nameemailAddress - the user's email addressfacebookId - the user's facebook IDopenId - the user's OpenIDlocale - the user's localefirstName - the user's first namemiddleName - the user's middle namelastName - the user's last nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user groupssendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
PortalException - if the user's information was invalid
SystemException - if a system exception occurred
public void addUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException,
SystemException
addUserGroupUsers in interface UserLocalServiceaddUserGroupUsers in class UserLocalServiceBaseImpluserGroupId - the primary key of the user groupuserIds - the primary keys of the users
PortalException - if a user group or user with the primary could
could not be found
SystemException - if a system exception occurred
public User addUserWithWorkflow(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
long[] userGroupIds,
boolean sendEmail,
ServiceContext serviceContext)
throws PortalException,
SystemException
This method handles the creation and bookkeeping of the user including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, etc.
creatorUserId - the primary key of the creatorcompanyId - the primary key of the user's companyautoPassword - whether a password should be automatically generated
for the userpassword1 - the user's passwordpassword2 - the user's password confirmationautoScreenName - whether a screen name should be automatically
generated for the userscreenName - the user's screen nameemailAddress - the user's email addressfacebookId - the user's facebook IDopenId - the user's OpenIDlocale - the user's localefirstName - the user's first namemiddleName - the user's middle namelastName - the user's last nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the roles this user possessesuserGroupIds - the primary keys of the user's user groupssendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
PortalException - if the user's information was invalid
SystemException - if a system exception occurred
public int authenticateByEmailAddress(long companyId,
String emailAddress,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException,
SystemException
companyId - the primary key of the user's companyemailAddress - the user's email addresspassword - the user's passwordheaderMap - the header map from the authentication requestparameterMap - the parameter map from the authentication requestresultsMap - the map of authentication results (may be nil). After
a succesful authentication the user's primary key will be placed
under the key userId.
Authenticator.FAILURE
indicating that the user's credentials are invalid, Authenticator.SUCCESS
indicating a successful login, or Authenticator.DNE indicating
that a user with that login does not exist.
PortalException - if emailAddress or
password was null
SystemException - if a system exception occurredAuthPipeline
public int authenticateByScreenName(long companyId,
String screenName,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen namepassword - the user's passwordheaderMap - the header map from the authentication requestparameterMap - the parameter map from the authentication requestresultsMap - the map of authentication results (may be nil). After
a succesful authentication the user's primary key will be placed
under the key userId.
Authenticator.FAILURE
indicating that the user's credentials are invalid, Authenticator.SUCCESS
indicating a successful login, or Authenticator.DNE indicating
that a user with that login does not exist.
PortalException - if screenName or
password was null
SystemException - if a system exception occurredAuthPipeline
public int authenticateByUserId(long companyId,
long userId,
String password,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException,
SystemException
companyId - the primary key of the user's companyuserId - the user's primary keypassword - the user's passwordheaderMap - the header map from the authentication requestparameterMap - the parameter map from the authentication requestresultsMap - the map of authentication results (may be nil). After
a succesful authentication the user's primary key will be placed
under the key userId.
Authenticator.FAILURE
indicating that the user's credentials are invalid, Authenticator.SUCCESS
indicating a successful login, or Authenticator.DNE indicating
that a user with that login does not exist.
PortalException - if userId or password
was null
SystemException - if a system exception occurredAuthPipeline
@Transactional(propagation=SUPPORTS,
readOnly=true)
public long authenticateForBasic(long companyId,
String authType,
String login,
String password)
throws PortalException,
SystemException
tunnel-web.
Authentication type specifies what login contains.The valid
values are:
CompanyConstants.AUTH_TYPE_EA - login is the
user's email address
CompanyConstants.AUTH_TYPE_SN - login is the
user's screen name
CompanyConstants.AUTH_TYPE_ID - login is the
user's primary key
companyId - the primary key of the user's companyauthType - the type of authentication to performlogin - either the user's email address, screen name, or primary
key depending on the value of authTypepassword - the user's password
Authenticator.FAILURE
indicating that the user's credentials are invalid, Authenticator.SUCCESS
indicating a successful login, or Authenticator.DNE indicating
that a user with that login does not exist.
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
public long authenticateForDigest(long companyId,
String username,
String realm,
String nonce,
String method,
String uri,
String response)
throws PortalException,
SystemException
tunnel-web.
companyId - the primary key of the user's companyusername - either the user's email address, screen name, or primary
keyrealm - unusednonce - the number used oncemethod - the request methoduri - the request URIresponse - the authentication response hash
0 otherwise
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
public boolean authenticateForJAAS(long userId,
String encPassword)
userId - the primary key of the userencPassword - the encrypted password
true if authentication is successful;
false otherwise
public void checkLockout(User user)
throws PortalException,
SystemException
user - the user
PortalException - if the user was determined to still be locked out
SystemException - if a system exception occurred
public void checkLoginFailure(User user)
throws SystemException
user - the user
SystemException - if a system exception occurred
public void checkLoginFailureByEmailAddress(long companyId,
String emailAddress)
throws PortalException,
SystemException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException - if a user with the email address could not be
found
SystemException - if a system exception occurred
public void checkLoginFailureById(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void checkLoginFailureByScreenName(long companyId,
String screenName)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred
public void checkPasswordExpired(User user)
throws PortalException,
SystemException
user - the user
PortalException - if the user's password has expired and the grace
login limit has been exceeded
SystemException - if a system exception occurred
public void clearOrganizationUsers(long organizationId)
throws SystemException
clearOrganizationUsers in interface UserLocalServiceclearOrganizationUsers in class UserLocalServiceBaseImplorganizationId - the primary key of the organization
SystemException - if a system exception occurred
public void clearUserGroupUsers(long userGroupId)
throws SystemException
clearUserGroupUsers in interface UserLocalServiceclearUserGroupUsers in class UserLocalServiceBaseImpluserGroupId - the primary key of the user group
SystemException - if a system exception occurred
public void completeUserRegistration(User user,
ServiceContext serviceContext)
throws PortalException,
SystemException
user - the userserviceContext - the service context to be applied. You can specify
an unencrypted custom password for the user via attribute
passwordUnencrypted. You automatically generate a
password for the user by setting attribute
autoPassword to true. You can send a
confirmation email to the user by setting attribute
sendEmail to true.
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public KeyValuePair decryptUserId(long companyId,
String name,
String password)
throws PortalException,
SystemException
companyId - the primary key of the user's companyname - the encrypted primary key of the userpassword - the encrypted password of the user
PortalException - if a user with the primary key could not be found
or if the user's password was incorrect
SystemException - if a system exception occurred
public void deletePortrait(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
or if the user's portrait could not be found
SystemException - if a system exception occurred
public void deleteRoleUser(long roleId,
long userId)
throws PortalException,
SystemException
deleteRoleUser in interface UserLocalServicedeleteRoleUser in class UserLocalServiceBaseImplroleId - the primary key of the roleuserId - the primary key of the user
PortalException - if a role or user with the primary key could not
be found
SystemException - if a system exception occurred
public User deleteUser(long userId)
throws PortalException,
SystemException
deleteUser in interface UserLocalServicedeleteUser in class UserLocalServiceBaseImpluserId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User deleteUser(User user)
throws PortalException,
SystemException
deleteUser in interface UserLocalServicedeleteUser in class UserLocalServiceBaseImpluser - the user
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void deleteUserGroupUser(long userGroupId,
long userId)
throws PortalException,
SystemException
deleteUserGroupUser in interface UserLocalServicedeleteUserGroupUser in class UserLocalServiceBaseImpluserGroupId - the primary key of the user groupuserId - the primary key of the user
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
public String encryptUserId(String name)
throws PortalException,
SystemException
name - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User fetchUserByEmailAddress(long companyId,
String emailAddress)
throws SystemException
companyId - the primary key of the user's companyemailAddress - the user's email address
null if a user
with the email address could not be found
SystemException - if a system exception occurred
public User fetchUserByFacebookId(long companyId,
long facebookId)
throws SystemException
companyId - the primary key of the user's companyfacebookId - the user's Facebook ID
null if a user
with the Facebook ID could not be found
SystemException - if a system exception occurred
public User fetchUserById(long userId)
throws SystemException
userId - the primary key of the user
null if a user
with the primary key could not be found
SystemException - if a system exception occurred
public User fetchUserByOpenId(long companyId,
String openId)
throws SystemException
companyId - the primary key of the user's companyopenId - the user's OpenID
null if a user with the
OpenID could not be found
SystemException - if a system exception occurred
public User fetchUserByScreenName(long companyId,
String screenName)
throws SystemException
companyId - the primary key of the user's companyscreenName - the user's screen name
null if a user
with the screen name could not be found
SystemException - if a system exception occurred
public List<User> getCompanyUsers(long companyId,
int start,
int end)
throws SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the companystart - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)
SystemException - if a system exception occurred
public int getCompanyUsersCount(long companyId)
throws SystemException
companyId - the primary key of the company
SystemException - if a system exception occurred
@Skip
public User getDefaultUser(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the company
PortalException - if a default user for the company could not be
found
SystemException - if a system exception occurred
@Skip
public long getDefaultUserId(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the company
PortalException - if a default user for the company could not be
found
SystemException - if a system exception occurred
public long[] getGroupUserIds(long groupId)
throws SystemException
groupId - the primary key of the group
SystemException - if a system exception occurred
public int getGroupUsersCount(long groupId,
int status)
throws PortalException,
SystemException
groupId - the primary key of the groupstatus - the workflow status
PortalException - if a group with the primary key could not be
found
SystemException - if a system exception occurred
public List<User> getInheritedRoleUsers(long roleId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
PortalException
SystemException
public List<User> getNoAnnouncementsDeliveries(String type)
throws SystemException
type - the type of announcement
SystemException - if a system exception occurred
public List<User> getNoContacts()
throws SystemException
SystemException - if a system exception occurred
public List<User> getNoGroups()
throws SystemException
SystemException - if a system exception occurred
public long[] getOrganizationUserIds(long organizationId)
throws SystemException
organizationId - the primary key of the organization
SystemException - if a system exception occurred
public int getOrganizationUsersCount(long organizationId,
int status)
throws PortalException,
SystemException
organizationId - the primary key of the organizationstatus - the workflow status
PortalException - if an organization with the primary key could not
be found
SystemException - if a system exception occurred
public long[] getRoleUserIds(long roleId)
throws SystemException
roleId - the primary key of the role
SystemException - if a system exception occurred
public int getRoleUsersCount(long roleId,
int status)
throws PortalException,
SystemException
roleId - the primary key of the rolestatus - the workflow status
PortalException - if an role with the primary key could not be
found
SystemException - if a system exception occurred
public List<User> getSocialUsers(long userId,
int type,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId - the primary key of the usertype - the type of social relation. The possible types can be found
in SocialRelationConstants.start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public List<User> getSocialUsers(long userId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId - the primary key of the userstart - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public List<User> getSocialUsers(long userId1,
long userId2,
int type,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId1 - the primary key of the first useruserId2 - the primary key of the second usertype - the type of social relation. The possible types can be found
in SocialRelationConstants.start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public List<User> getSocialUsers(long userId1,
long userId2,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId1 - the primary key of the first useruserId2 - the primary key of the second userstart - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public int getSocialUsersCount(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public int getSocialUsersCount(long userId,
int type)
throws PortalException,
SystemException
userId - the primary key of the usertype - the type of social relation. The possible types can be found
in SocialRelationConstants.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public int getSocialUsersCount(long userId1,
long userId2)
throws PortalException,
SystemException
userId1 - the primary key of the first useruserId2 - the primary key of the second user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public int getSocialUsersCount(long userId1,
long userId2,
int type)
throws PortalException,
SystemException
userId1 - the primary key of the first useruserId2 - the primary key of the second usertype - the type of social relation. The possible types can be found
in SocialRelationConstants.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User getUserByContactId(long contactId)
throws PortalException,
SystemException
contactId - the user's contact ID
PortalException - if a user with the contact ID could not be found
SystemException - if a system exception occurred
public User getUserByEmailAddress(long companyId,
String emailAddress)
throws PortalException,
SystemException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException - if a user with the email address could not be
found
SystemException - if a system exception occurred
public User getUserByFacebookId(long companyId,
long facebookId)
throws PortalException,
SystemException
companyId - the primary key of the user's companyfacebookId - the user's Facebook ID
PortalException - if a user with the Facebook ID could not be found
SystemException - if a system exception occurred
public User getUserById(long userId)
throws PortalException,
SystemException
userId - the primary key of the user
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User getUserById(long companyId,
long userId)
throws PortalException,
SystemException
companyId - the primary key of the user's companyuserId - the primary key of the user
PortalException - if a user with the primary key from the company
could not be found
SystemException - if a system exception occurred
public User getUserByOpenId(long companyId,
String openId)
throws PortalException,
SystemException
companyId - the primary key of the user's companyopenId - the user's OpenID
PortalException - if a user with the OpenID could not be found
SystemException - if a system exception occurred
public User getUserByPortraitId(long portraitId)
throws PortalException,
SystemException
portraitId - the user's portrait ID
PortalException - if a user with the portrait ID could not be found
SystemException - if a system exception occurred
public User getUserByScreenName(long companyId,
String screenName)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred
public User getUserByUuid(String uuid)
throws PortalException,
SystemException
getUserByUuidAndCompanyId(String, long)
uuid - the user's UUID
PortalException - if a user with the UUID could not be found
SystemException - if a system exception occurred
public User getUserByUuidAndCompanyId(String uuid,
long companyId)
throws PortalException,
SystemException
getUserByUuidAndCompanyId in interface UserLocalServicegetUserByUuidAndCompanyId in class UserLocalServiceBaseImpluuid - the user's UUIDcompanyId - the primary key of the user's company
PortalException - if a user with the UUID could not be found
SystemException - if a system exception occurred
public int getUserGroupUsersCount(long userGroupId,
int status)
throws PortalException,
SystemException
userGroupId - the primary key of the user groupstatus - the workflow status
PortalException - if a user group with the primary key could not be
found
SystemException - if a system exception occurred
public long getUserIdByEmailAddress(long companyId,
String emailAddress)
throws PortalException,
SystemException
companyId - the primary key of the user's companyemailAddress - the user's email address
PortalException - if a user with the email address could not be
found
SystemException - if a system exception occurred
public long getUserIdByScreenName(long companyId,
String screenName)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen name
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred
public boolean hasPasswordPolicyUser(long passwordPolicyId,
long userId)
throws SystemException
true if the password policy has been assigned to the
user.
passwordPolicyId - the primary key of the password policyuserId - the primary key of the user
true if the password policy is assigned to the user;
false otherwise
SystemException - if a system exception occurred
public boolean hasRoleUser(long companyId,
String name,
long userId,
boolean inherited)
throws PortalException,
SystemException
true if the user has the role with the name,
optionally through inheritance.
companyId - the primary key of the role's companyname - the name of the role (must be a regular role, not an
organization, site or provider role)userId - the primary key of the userinherited - whether to include roles inherited from organizations,
sites, etc.
true if the user has the role; false
otherwise
PortalException - if a role with the name could not be found
SystemException - if a system exception occurred
public boolean isPasswordExpired(User user)
throws PortalException,
SystemException
true if the user's password is expired.
user - the user
true if the user's password is expired;
false otherwise
PortalException - if the password policy for the user could not be
found
SystemException - if a system exception occurred
public boolean isPasswordExpiringSoon(User user)
throws PortalException,
SystemException
true if the password policy is configured to warn
the user that his password is expiring and the remaining time until
expiration is equal or less than the configured warning time.
user - the user
true if the user's password is expiring soon;
false otherwise
PortalException - if the password policy for the user could not be
found
SystemException - if a system exception occurred
public User loadGetDefaultUser(long companyId)
throws PortalException,
SystemException
companyId - the primary key of the company
PortalException - if the user could not be found
SystemException - if a system exception occurred
public List<User> search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
OrderByComparator obc)
throws SystemException
search(long, String, int, LinkedHashMap, int, int, Sort)
instead of this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the user's companykeywords - the keywords (space separated), which may occur in the
user's first name, middle name, last name, screen name, or email
addressstatus - the workflow statusparams - the finder parameters (optionally null). For
more information see UserFinder.start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
SystemException - if a system exception occurredUserFinder
public Hits search(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
throws SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the user's companykeywords - the keywords (space separated), which may occur in the
user's first name, middle name, last name, screen name, or email
addressstatus - the workflow statusparams - the indexer parameters (optionally null). For
more information see UserIndexer.start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)sort - the field and direction to sort by (optionally
null)
SystemException - if a system exception occurredUserIndexer
public List<User> search(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
OrderByComparator obc)
throws SystemException
search(long, String,
String, String, String, String, int, LinkedHashMap, boolean, int, int,
Sort) instead of this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the user's companyfirstName - the first name keywords (space separated)middleName - the middle name keywordslastName - the last name keywordsscreenName - the screen name keywordsemailAddress - the email address keywordsstatus - the workflow statusparams - the finder parameters (optionally null). For
more information see UserFinder.andSearch - whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)obc - the comparator to order the users by (optionally
null)
SystemException - if a system exception occurredUserFinder
public Hits search(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
throws SystemException
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
companyId - the primary key of the user's companyfirstName - the first name keywords (space separated)middleName - the middle name keywordslastName - the last name keywordsscreenName - the screen name keywordsemailAddress - the email address keywordsstatus - the workflow statusparams - the indexer parameters (optionally null). For
more information see UserIndexer.andSearch - whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".start - the lower bound of the range of usersend - the upper bound of the range of users (not inclusive)sort - the field and direction to sort by (optionally
null)
SystemException - if a system exception occurredUserIndexer
public int searchCount(long companyId,
String keywords,
int status,
LinkedHashMap<String,Object> params)
throws SystemException
companyId - the primary key of the user's companykeywords - the keywords (space separated), which may occur in the
user's first name, middle name, last name, screen name, or email
addressstatus - the workflow statusparams - the finder parameters (optionally null). For
more information see UserFinder.
SystemException - if a system exception occurred
public int searchCount(long companyId,
String firstName,
String middleName,
String lastName,
String screenName,
String emailAddress,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch)
throws SystemException
companyId - the primary key of the user's companyfirstName - the first name keywords (space separated)middleName - the middle name keywordslastName - the last name keywordsscreenName - the screen name keywordsemailAddress - the email address keywordsstatus - the workflow statusparams - the finder parameters (optionally null). For
more information see UserFinder.andSearch - whether every field must match its keywords, or just
one field. For example, "users with the first name 'bob' and
last name 'smith'" vs "users with the first name 'bob'
or the last name 'smith'".
SystemException - if a system exception occurred
public void sendEmailAddressVerification(User user,
String emailAddress,
ServiceContext serviceContext)
throws PortalException,
SystemException
user - the verification email recipientemailAddress - the recipient's email addressserviceContext - the service context to be applied. Must set the
portal URL, main path, primary key of the layout, remote address,
remote host, and agent for the user.
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void sendPassword(long companyId,
String emailAddress,
String fromName,
String fromAddress,
String subject,
String body,
ServiceContext serviceContext)
throws PortalException,
SystemException
portal.properties with the
admin.email.password keys.
companyId - the primary key of the user's companyemailAddress - the user's email addressfromName - the name of the individual that the email should be fromfromAddress - the address of the individual that the email should
be fromsubject - the email subject. If null, the subject
specified in portal.properties will be used.body - the email body. If null, the body specified in
portal.properties will be used.serviceContext - the service context to be applied
PortalException - if a user with the email address could not be
found
SystemException - if a system exception occurred
public void setRoleUsers(long roleId,
long[] userIds)
throws PortalException,
SystemException
setRoleUsers in interface UserLocalServicesetRoleUsers in class UserLocalServiceBaseImplroleId - the primary key of the roleuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void setUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException,
SystemException
setUserGroupUsers in interface UserLocalServicesetUserGroupUsers in class UserLocalServiceBaseImpluserGroupId - the primary key of the user groupuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetGroupTeamsUsers(long groupId,
long[] userIds)
throws PortalException,
SystemException
groupId - the primary key of the groupuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetGroupUsers(long groupId,
long[] userIds,
ServiceContext serviceContext)
throws PortalException,
SystemException
groupId - the primary key of the groupuserIds - the primary keys of the usersserviceContext - the service context to be applied (optionally
null)
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetOrganizationUsers(long organizationId,
long[] userIds)
throws PortalException,
SystemException
organizationId - the primary key of the organizationuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws SystemException
passwordPolicyId - the primary key of the password policyuserIds - the primary keys of the users
SystemException - if a system exception occurred
public void unsetRoleUsers(long roleId,
List<User> users)
throws PortalException,
SystemException
roleId - the primary key of the roleusers - the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetRoleUsers(long roleId,
long[] userIds)
throws PortalException,
SystemException
roleId - the primary key of the roleuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetTeamUsers(long teamId,
long[] userIds)
throws PortalException,
SystemException
teamId - the primary key of the teamuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public void unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws PortalException,
SystemException
userGroupId - the primary key of the user groupuserIds - the primary keys of the users
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public User updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
throws PortalException,
SystemException
userId - the primary key of the useragreedToTermsOfUse - whether the user has agreet to the terms of
use
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void updateAsset(long userId,
User user,
long[] assetCategoryIds,
String[] assetTagNames)
throws PortalException,
SystemException
userId - the primary key of the useruser - ID the primary key of the userassetCategoryIds - the primary key's of the new asset categoriesassetTagNames - the new asset tag names
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateCreateDate(long userId,
Date createDate)
throws PortalException,
SystemException
userId - the primary key of the usercreateDate - the new creation date
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
throws PortalException,
SystemException
userId - the primary key of the userpassword - the user's passwordemailAddress1 - the user's new email addressemailAddress2 - the user's new email address confirmation
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2,
ServiceContext serviceContext)
throws PortalException,
SystemException
userId - the primary key of the userpassword - the user's passwordemailAddress1 - the user's new email addressemailAddress2 - the user's new email address confirmationserviceContext - the service context to be applied. Must set the
portal URL, main path, primary key of the layout, remote address,
remote host, and agent for the user.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateEmailAddressVerified(long userId,
boolean emailAddressVerified)
throws PortalException,
SystemException
userId - the primary key of the useremailAddressVerified - whether the user has verified email address
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateFacebookId(long userId,
long facebookId)
throws PortalException,
SystemException
userId - the primary key of the userfacebookId - the user's new Facebook ID
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext)
throws PortalException,
SystemException
userId - the primary key of the usernewGroupIds - the primary keys of the groupsserviceContext - the service context to be applied (optionally
null)
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public User updateIncompleteUser(long creatorUserId,
long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
Locale locale,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String jobTitle,
boolean updateUserInformation,
boolean sendEmail,
ServiceContext serviceContext)
throws PortalException,
SystemException
creatorUserId - the primary key of the creatorcompanyId - the primary key of the user's companyautoPassword - whether a password should be automatically generated
for the userpassword1 - the user's passwordpassword2 - the user's password confirmationautoScreenName - whether a screen name should be automatically
generated for the userscreenName - the user's screen nameemailAddress - the user's email addressfacebookId - the user's facebook IDopenId - the user's OpenIDlocale - the user's localefirstName - the user's first namemiddleName - the user's middle namelastName - the user's last nameprefixId - the user's name prefix IDsuffixId - the user's name suffix IDmale - whether the user is malebirthdayMonth - the user's birthday month (0-based, meaning 0 for
January)birthdayDay - the user's birthday daybirthdayYear - the user's birthday yearjobTitle - the user's job titleupdateUserInformation - whether to update the user's informationsendEmail - whether to send the user an email notification about
their new accountserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user.
PortalException - if the user's information was invalid
SystemException - if a system exception occurred
public User updateJobTitle(long userId,
String jobTitle)
throws PortalException,
SystemException
userId - the primary key of the userjobTitle - the user's job title
PortalException - if a user with the primary key could not be found
or if a contact could not be found matching the user's contact ID
SystemException - if a system exception occurred
public User updateLastLogin(long userId,
String loginIP)
throws PortalException,
SystemException
userId - the primary key of the userloginIP - the IP address the user logged in from
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateLockout(User user,
boolean lockout)
throws PortalException,
SystemException
user - the userlockout - whether the user is locked out
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public User updateLockoutByEmailAddress(long companyId,
String emailAddress,
boolean lockout)
throws PortalException,
SystemException
companyId - the primary key of the user's companyemailAddress - the user's email addresslockout - whether the user is locked out
PortalException - if a user with the email address could not be
found
SystemException - if a system exception occurred
public User updateLockoutById(long userId,
boolean lockout)
throws PortalException,
SystemException
userId - the primary key of the userlockout - whether the user is locked out
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateLockoutByScreenName(long companyId,
String screenName,
boolean lockout)
throws PortalException,
SystemException
companyId - the primary key of the user's companyscreenName - the user's screen namelockout - whether the user is locked out
PortalException - if a user with the screen name could not be found
SystemException - if a system exception occurred
public User updateModifiedDate(long userId,
Date modifiedDate)
throws PortalException,
SystemException
userId - the primary key of the usermodifiedDate - the new modified date
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateOpenId(long userId,
String openId)
throws PortalException,
SystemException
userId - the primary key of the useropenId - the new OpenID
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public void updateOrganizations(long userId,
long[] newOrganizationIds,
ServiceContext serviceContext)
throws PortalException,
SystemException
userId - the primary key of the usernewOrganizationIds - the primary keys of the organizationsserviceContext - the service context to be applied. Must set
whether user indexing is enabled.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
throws PortalException,
SystemException
userId - the primary key of the userpassword1 - the user's new passwordpassword2 - the user's new password confirmationpasswordReset - whether the user should be asked to reset their
password the next time they log in
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updatePassword(long userId,
String password1,
String password2,
boolean passwordReset,
boolean silentUpdate)
throws PortalException,
SystemException
userId - the primary key of the userpassword1 - the user's new passwordpassword2 - the user's new password confirmationpasswordReset - whether the user should be asked to reset their
password the next time they loginsilentUpdate - whether the password should be updated without being
tracked, or validated. Primarily used for password imports.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updatePasswordManually(long userId,
String password,
boolean passwordEncrypted,
boolean passwordReset,
Date passwordModifiedDate)
throws PortalException,
SystemException
userId - the primary key of the userpassword - the user's new passwordpasswordEncrypted - the user's new encrypted passwordpasswordReset - whether the user should be asked to reset their
password the next time they loginpasswordModifiedDate - the new password modified date
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updatePasswordReset(long userId,
boolean passwordReset)
throws PortalException,
SystemException
userId - the primary key of the userpasswordReset - whether the user should be asked to reset their
password the next time they login
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updatePortrait(long userId,
byte[] bytes)
throws PortalException,
SystemException
userId - the primary key of the userbytes - the new portrait image data
PortalException - if a user with the primary key could not be found
or if the new portrait was invalid
SystemException - if a system exception occurred
public User updateReminderQuery(long userId,
String question,
String answer)
throws PortalException,
SystemException
userId - the primary key of the userquestion - the user's new password reset questionanswer - the user's new password reset answer
PortalException - if a user with the primary key could not be found
or if the new question or answer were invalid
SystemException - if a system exception occurred
public User updateScreenName(long userId,
String screenName)
throws PortalException,
SystemException
userId - the primary key of the userscreenName - the user's new screen name
PortalException - if a user with the primary key could not be found
or if the new screen name was invalid
SystemException - if a system exception occurred
@Deprecated
public User updateStatus(long userId,
int status)
throws PortalException,
SystemException
updateStatus(long, int,
ServiceContext)
userId - the primary key of the userstatus - the user's new workflow status
PortalException - if a user with the primary key could not be
found
SystemException - if a system exception occurred
public User updateStatus(long userId,
int status,
ServiceContext serviceContext)
throws PortalException,
SystemException
userId - the primary key of the userstatus - the user's new workflow statusserviceContext - the service context to be applied. You can specify
an unencrypted custom password (used by an LDAP listener) for the
user via attribute passwordUnencrypted.
PortalException - if a user with the primary key could not be found
SystemException - if a system exception occurred
public User updateUser(long userId,
String oldPassword,
String newPassword1,
String newPassword2,
boolean passwordReset,
String reminderQueryQuestion,
String reminderQueryAnswer,
String screenName,
String emailAddress,
long facebookId,
String openId,
String languageId,
String timeZoneId,
String greeting,
String comments,
String firstName,
String middleName,
String lastName,
int prefixId,
int suffixId,
boolean male,
int birthdayMonth,
int birthdayDay,
int birthdayYear,
String smsSn,
String aimSn,
String facebookSn,
String icqSn,
String jabberSn,
String msnSn,
String mySpaceSn,
String skypeSn,
String twitterSn,
String ymSn,
String jobTitle,
long[] groupIds,
long[] organizationIds,
long[] roleIds,
List<UserGroupRole> userGroupRoles,
long[] userGroupIds,
ServiceContext serviceContext)
throws PortalException,
SystemException
userId - the primary key of the useroldPassword - the user's old passwordnewPassword1 - the user's new password (optionally
null)newPassword2 - the user's new password confirmation (optionally
null)passwordReset - whether the user should be asked to reset their
password the next time they loginreminderQueryQuestion - the user's new password reset questionreminderQueryAnswer - the user's new password reset answerscreenName - the user's new screen nameemailAddress - the user's new email addressfacebookId - the user's new Facebook IDopenId - the user's new OpenIDlanguageId - the user's new language IDtimeZoneId - the user's new time zone IDgreeting - the user's new greetingcomments - the user's new commentsfirstName - the user's new first namemiddleName - the user's new middle namelastName - the user's new last nameprefixId - the user's new name prefix IDsuffixId - the user's new name suffix IDmale - whether user is malebirthdayMonth - the user's new birthday month (0-based, meaning 0
for January)birthdayDay - the user's new birthday daybirthdayYear - the user's birthday yearsmsSn - the user's new SMS screen nameaimSn - the user's new AIM screen namefacebookSn - the user's new Facebook screen nameicqSn - the user's new ICQ screen namejabberSn - the user's new Jabber screen namemsnSn - the user's new MSN screen namemySpaceSn - the user's new MySpace screen nameskypeSn - the user's new Skype screen nametwitterSn - the user's new Twitter screen nameymSn - the user's new Yahoo! Messenger screen namejobTitle - the user's new job titlegroupIds - the primary keys of the user's groupsorganizationIds - the primary keys of the user's organizationsroleIds - the primary keys of the user's rolesuserGroupRoles - the user user's group rolesuserGroupIds - the primary keys of the user's user groupsserviceContext - the service context to be applied (optionally
null). Can set the UUID (with the uuid
attribute), asset category IDs, asset tag names, and expando
bridge attributes for the user.
PortalException - if a user with the primary key could not be found
or if the new information was invalid
SystemException - if a system exception occurred
public void verifyEmailAddress(String ticketKey)
throws PortalException,
SystemException
ticketKey - the ticket key
PortalException - if a ticket matching the ticket key could not be
found, if the ticket has expired, if the ticket is an email
address ticket, or if the email address is invalid
SystemException - if a system exception occurred
protected void addDefaultRolesAndTeams(long groupId,
long[] userIds)
throws PortalException,
SystemException
PortalException
SystemException
protected int authenticate(long companyId,
String login,
String password,
String authType,
Map<String,String[]> headerMap,
Map<String,String[]> parameterMap,
Map<String,Object> resultsMap)
throws PortalException,
SystemException
Authentication type specifies what login contains.The valid
values are:
CompanyConstants.AUTH_TYPE_EA - login is the
user's email address
CompanyConstants.AUTH_TYPE_SN - login is the
user's screen name
CompanyConstants.AUTH_TYPE_ID - login is the
user's primary key
companyId - the primary key of the user's companylogin - either the user's email address, screen name, or primary
key depending on the value of authTypepassword - the user's passwordauthType - the type of authentication to performheaderMap - the header map from the authentication requestparameterMap - the parameter map from the authentication requestresultsMap - the map of authentication results (may be nil). After
a succesful authentication the user's primary key will be placed
under the key userId.
Authenticator.FAILURE
indicating that the user's credentials are invalid, Authenticator.SUCCESS
indicating a successful login, or Authenticator.DNE indicating
that a user with that login does not exist.
PortalException - if login or password
was null
SystemException - if a system exception occurredAuthPipeline
protected Date getBirthday(int birthdayMonth,
int birthdayDay,
int birthdayYear)
throws PortalException
PortalExceptionprotected String getLogin(String login)
protected long[] getUserIds(List<User> users)
protected void reindex(User user)
protected Hits search(long companyId,
String firstName,
String middleName,
String lastName,
String fullName,
String screenName,
String emailAddress,
String street,
String city,
String zip,
String region,
String country,
int status,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
throws SystemException
SystemException
protected void sendEmail(User user,
String password,
ServiceContext serviceContext)
throws SystemException
SystemException
protected void setEmailAddress(User user,
String password,
String firstName,
String middleName,
String lastName,
String emailAddress)
throws PortalException,
SystemException
PortalException
SystemException
protected void updateGroups(long userId,
long[] newGroupIds,
ServiceContext serviceContext,
boolean indexingEnabled)
throws PortalException,
SystemException
PortalException
SystemException
protected void updateOrganizations(long userId,
long[] newOrganizationIds,
boolean indexingEnabled)
throws PortalException,
SystemException
PortalException
SystemException
protected void updateUserGroupRoles(User user,
long[] groupIds,
long[] organizationIds,
List<UserGroupRole> userGroupRoles,
List<UserGroupRole> previousUserGroupRoles)
throws PortalException,
SystemException
PortalException
SystemException
protected void validate(long companyId,
long userId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
String openId,
String firstName,
String middleName,
String lastName,
long[] organizationIds)
throws PortalException,
SystemException
PortalException
SystemException
protected void validate(long userId,
String screenName,
String emailAddress,
String openId,
String firstName,
String middleName,
String lastName,
String smsSn)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateCompanyMaxUsers(long companyId)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateEmailAddress(long companyId,
String emailAddress)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateEmailAddress(User user,
String emailAddress1,
String emailAddress2)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateFullName(long companyId,
String firstName,
String middleName,
String lastName)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateOpenId(long companyId,
long userId,
String openId)
throws PortalException,
SystemException
PortalException
SystemException
protected void validatePassword(long companyId,
long userId,
String password1,
String password2)
throws PortalException,
SystemException
PortalException
SystemException
protected void validateReminderQuery(String question,
String answer)
throws PortalException
PortalException
protected void validateScreenName(long companyId,
long userId,
String screenName)
throws PortalException,
SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||