com.liferay.portal.service.http
Class UserServiceHttp

java.lang.Object
  extended bycom.liferay.portal.service.http.UserServiceHttp

public class UserServiceHttp
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a HTTP utility for the com.liferay.portal.service.UserServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional com.liferay.portal.security.auth.HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
HttpPrincipal, UserServiceUtil, UserServiceSoap

Constructor Summary
UserServiceHttp()
           
 
Method Summary
static void addGroupUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds)
           
static void addPasswordPolicyUsers(HttpPrincipal httpPrincipal, long passwordPolicyId, long[] userIds)
           
static void addRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)
           
static com.liferay.portal.model.User addUser(HttpPrincipal httpPrincipal, long companyId, boolean autoPassword, java.lang.String password1, java.lang.String password2, boolean autoScreenName, java.lang.String screenName, java.lang.String emailAddress, java.util.Locale locale, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String jobTitle, long organizationId, long locationId, boolean sendEmail)
           
static void addUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)
           
static void deleteRoleUser(HttpPrincipal httpPrincipal, long roleId, long userId)
           
static void deleteUser(HttpPrincipal httpPrincipal, long userId)
           
static long getDefaultUserId(HttpPrincipal httpPrincipal, long companyId)
           
static java.util.List getGroupUsers(HttpPrincipal httpPrincipal, long groupId)
           
static java.util.List getRoleUsers(HttpPrincipal httpPrincipal, long roleId)
           
static com.liferay.portal.model.User getUserByEmailAddress(HttpPrincipal httpPrincipal, long companyId, java.lang.String emailAddress)
           
static com.liferay.portal.model.User getUserById(HttpPrincipal httpPrincipal, long userId)
           
static com.liferay.portal.model.User getUserByScreenName(HttpPrincipal httpPrincipal, long companyId, java.lang.String screenName)
           
static boolean hasGroupUser(HttpPrincipal httpPrincipal, long groupId, long userId)
           
static boolean hasRoleUser(HttpPrincipal httpPrincipal, long roleId, long userId)
           
static void setGroupUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds)
           
static void setRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)
           
static void setUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)
           
static void unsetGroupUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds)
           
static void unsetPasswordPolicyUsers(HttpPrincipal httpPrincipal, long passwordPolicyId, long[] userIds)
           
static void unsetRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)
           
static void unsetUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)
           
static com.liferay.portal.model.User updateActive(HttpPrincipal httpPrincipal, long userId, boolean active)
           
static com.liferay.portal.model.User updateAgreedToTermsOfUse(HttpPrincipal httpPrincipal, long userId, boolean agreedToTermsOfUse)
           
static com.liferay.portal.model.User updateLockout(HttpPrincipal httpPrincipal, long userId, boolean lockout)
           
static void updateOrganizations(HttpPrincipal httpPrincipal, long userId, long organizationId, long locationId)
           
static com.liferay.portal.model.User updatePassword(HttpPrincipal httpPrincipal, long userId, java.lang.String password1, java.lang.String password2, boolean passwordReset)
           
static void updatePortrait(HttpPrincipal httpPrincipal, long userId, byte[] bytes)
           
static com.liferay.portal.model.User updateUser(HttpPrincipal httpPrincipal, long userId, java.lang.String password, java.lang.String screenName, java.lang.String emailAddress, java.lang.String languageId, java.lang.String timeZoneId, java.lang.String greeting, java.lang.String comments, java.lang.String firstName, java.lang.String middleName, java.lang.String lastName, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, java.lang.String smsSn, java.lang.String aimSn, java.lang.String icqSn, java.lang.String jabberSn, java.lang.String msnSn, java.lang.String skypeSn, java.lang.String ymSn, java.lang.String jobTitle, long organizationId, long locationId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserServiceHttp

public UserServiceHttp()
Method Detail

addGroupUsers

public static void addGroupUsers(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long[] userIds)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addPasswordPolicyUsers

public static void addPasswordPolicyUsers(HttpPrincipal httpPrincipal,
                                          long passwordPolicyId,
                                          long[] userIds)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addRoleUsers

public static void addRoleUsers(HttpPrincipal httpPrincipal,
                                long roleId,
                                long[] userIds)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addUserGroupUsers

public static void addUserGroupUsers(HttpPrincipal httpPrincipal,
                                     long userGroupId,
                                     long[] userIds)
                              throws com.liferay.portal.SystemException,
                                     com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addUser

public static com.liferay.portal.model.User addUser(HttpPrincipal httpPrincipal,
                                                    long companyId,
                                                    boolean autoPassword,
                                                    java.lang.String password1,
                                                    java.lang.String password2,
                                                    boolean autoScreenName,
                                                    java.lang.String screenName,
                                                    java.lang.String emailAddress,
                                                    java.util.Locale locale,
                                                    java.lang.String firstName,
                                                    java.lang.String middleName,
                                                    java.lang.String lastName,
                                                    int prefixId,
                                                    int suffixId,
                                                    boolean male,
                                                    int birthdayMonth,
                                                    int birthdayDay,
                                                    int birthdayYear,
                                                    java.lang.String jobTitle,
                                                    long organizationId,
                                                    long locationId,
                                                    boolean sendEmail)
                                             throws com.liferay.portal.SystemException,
                                                    com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteRoleUser

public static void deleteRoleUser(HttpPrincipal httpPrincipal,
                                  long roleId,
                                  long userId)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteUser

public static void deleteUser(HttpPrincipal httpPrincipal,
                              long userId)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getDefaultUserId

public static long getDefaultUserId(HttpPrincipal httpPrincipal,
                                    long companyId)
                             throws com.liferay.portal.SystemException,
                                    com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getGroupUsers

public static java.util.List getGroupUsers(HttpPrincipal httpPrincipal,
                                           long groupId)
                                    throws com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getRoleUsers

public static java.util.List getRoleUsers(HttpPrincipal httpPrincipal,
                                          long roleId)
                                   throws com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getUserByEmailAddress

public static com.liferay.portal.model.User getUserByEmailAddress(HttpPrincipal httpPrincipal,
                                                                  long companyId,
                                                                  java.lang.String emailAddress)
                                                           throws com.liferay.portal.SystemException,
                                                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getUserById

public static com.liferay.portal.model.User getUserById(HttpPrincipal httpPrincipal,
                                                        long userId)
                                                 throws com.liferay.portal.SystemException,
                                                        com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getUserByScreenName

public static com.liferay.portal.model.User getUserByScreenName(HttpPrincipal httpPrincipal,
                                                                long companyId,
                                                                java.lang.String screenName)
                                                         throws com.liferay.portal.SystemException,
                                                                com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasGroupUser

public static boolean hasGroupUser(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long userId)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasRoleUser

public static boolean hasRoleUser(HttpPrincipal httpPrincipal,
                                  long roleId,
                                  long userId)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

setGroupUsers

public static void setGroupUsers(HttpPrincipal httpPrincipal,
                                 long groupId,
                                 long[] userIds)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

setRoleUsers

public static void setRoleUsers(HttpPrincipal httpPrincipal,
                                long roleId,
                                long[] userIds)
                         throws com.liferay.portal.SystemException,
                                com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

setUserGroupUsers

public static void setUserGroupUsers(HttpPrincipal httpPrincipal,
                                     long userGroupId,
                                     long[] userIds)
                              throws com.liferay.portal.SystemException,
                                     com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetGroupUsers

public static void unsetGroupUsers(HttpPrincipal httpPrincipal,
                                   long groupId,
                                   long[] userIds)
                            throws com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetPasswordPolicyUsers

public static void unsetPasswordPolicyUsers(HttpPrincipal httpPrincipal,
                                            long passwordPolicyId,
                                            long[] userIds)
                                     throws com.liferay.portal.SystemException,
                                            com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetRoleUsers

public static void unsetRoleUsers(HttpPrincipal httpPrincipal,
                                  long roleId,
                                  long[] userIds)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetUserGroupUsers

public static void unsetUserGroupUsers(HttpPrincipal httpPrincipal,
                                       long userGroupId,
                                       long[] userIds)
                                throws com.liferay.portal.SystemException,
                                       com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateActive

public static com.liferay.portal.model.User updateActive(HttpPrincipal httpPrincipal,
                                                         long userId,
                                                         boolean active)
                                                  throws com.liferay.portal.SystemException,
                                                         com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateAgreedToTermsOfUse

public static com.liferay.portal.model.User updateAgreedToTermsOfUse(HttpPrincipal httpPrincipal,
                                                                     long userId,
                                                                     boolean agreedToTermsOfUse)
                                                              throws com.liferay.portal.SystemException,
                                                                     com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateLockout

public static com.liferay.portal.model.User updateLockout(HttpPrincipal httpPrincipal,
                                                          long userId,
                                                          boolean lockout)
                                                   throws com.liferay.portal.SystemException,
                                                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateOrganizations

public static void updateOrganizations(HttpPrincipal httpPrincipal,
                                       long userId,
                                       long organizationId,
                                       long locationId)
                                throws com.liferay.portal.SystemException,
                                       com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updatePassword

public static com.liferay.portal.model.User updatePassword(HttpPrincipal httpPrincipal,
                                                           long userId,
                                                           java.lang.String password1,
                                                           java.lang.String password2,
                                                           boolean passwordReset)
                                                    throws com.liferay.portal.SystemException,
                                                           com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updatePortrait

public static void updatePortrait(HttpPrincipal httpPrincipal,
                                  long userId,
                                  byte[] bytes)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateUser

public static com.liferay.portal.model.User updateUser(HttpPrincipal httpPrincipal,
                                                       long userId,
                                                       java.lang.String password,
                                                       java.lang.String screenName,
                                                       java.lang.String emailAddress,
                                                       java.lang.String languageId,
                                                       java.lang.String timeZoneId,
                                                       java.lang.String greeting,
                                                       java.lang.String comments,
                                                       java.lang.String firstName,
                                                       java.lang.String middleName,
                                                       java.lang.String lastName,
                                                       int prefixId,
                                                       int suffixId,
                                                       boolean male,
                                                       int birthdayMonth,
                                                       int birthdayDay,
                                                       int birthdayYear,
                                                       java.lang.String smsSn,
                                                       java.lang.String aimSn,
                                                       java.lang.String icqSn,
                                                       java.lang.String jabberSn,
                                                       java.lang.String msnSn,
                                                       java.lang.String skypeSn,
                                                       java.lang.String ymSn,
                                                       java.lang.String jobTitle,
                                                       long organizationId,
                                                       long locationId)
                                                throws com.liferay.portal.SystemException,
                                                       com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException