UserServiceHttp (Liferay 6.1.2-ce-ga3 Internal API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service.http
Class UserServiceHttp

java.lang.Object
  com.liferay.portal.service.http.UserServiceHttp

public class UserServiceHttp
extends Object
extends Object

This class provides a HTTP utility for the 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 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.

See Also:: UserServiceSoap, HttpPrincipal, UserServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
`UserServiceHttp()`

Method Summary
`static void`	`addGroupUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds, ServiceContext serviceContext)`
`static void`	`addOrganizationUsers(HttpPrincipal httpPrincipal, long organizationId, long[] userIds)`
`static void`	`addPasswordPolicyUsers(HttpPrincipal httpPrincipal, long passwordPolicyId, long[] userIds)`
`static void`	`addRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)`
`static void`	`addTeamUsers(HttpPrincipal httpPrincipal, long teamId, long[] userIds)`
`static User`	addUser(HttpPrincipal httpPrincipal, 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)
`static User`	addUser(HttpPrincipal httpPrincipal, 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, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext)
`static void`	`addUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)`
`static User`	addUserWithWorkflow(HttpPrincipal httpPrincipal, 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)
`static User`	addUserWithWorkflow(HttpPrincipal httpPrincipal, 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, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, boolean sendEmail, ServiceContext serviceContext)
`static void`	`deletePortrait(HttpPrincipal httpPrincipal, long userId)`
`static void`	`deleteRoleUser(HttpPrincipal httpPrincipal, long roleId, long userId)`
`static void`	`deleteUser(HttpPrincipal httpPrincipal, long userId)`
`static List<User>`	`getCompanyUsers(HttpPrincipal httpPrincipal, long companyId, int start, int end)`
`static int`	`getCompanyUsersCount(HttpPrincipal httpPrincipal, long companyId)`
`static long`	`getDefaultUserId(HttpPrincipal httpPrincipal, long companyId)`
`static long[]`	`getGroupUserIds(HttpPrincipal httpPrincipal, long groupId)`
`static List<User>`	`getGroupUsers(HttpPrincipal httpPrincipal, long groupId)`
`static long[]`	`getOrganizationUserIds(HttpPrincipal httpPrincipal, long organizationId)`
`static List<User>`	`getOrganizationUsers(HttpPrincipal httpPrincipal, long organizationId)`
`static long[]`	`getRoleUserIds(HttpPrincipal httpPrincipal, long roleId)`
`static User`	`getUserByEmailAddress(HttpPrincipal httpPrincipal, long companyId, String emailAddress)`
`static User`	`getUserById(HttpPrincipal httpPrincipal, long userId)`
`static User`	`getUserByScreenName(HttpPrincipal httpPrincipal, long companyId, String screenName)`
`static List<User>`	`getUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId)`
`static long`	`getUserIdByEmailAddress(HttpPrincipal httpPrincipal, long companyId, String emailAddress)`
`static long`	`getUserIdByScreenName(HttpPrincipal httpPrincipal, long companyId, String screenName)`
`static boolean`	`hasGroupUser(HttpPrincipal httpPrincipal, long groupId, long userId)`
`static boolean`	`hasRoleUser(HttpPrincipal httpPrincipal, long roleId, long userId)`
`static boolean`	`hasRoleUser(HttpPrincipal httpPrincipal, long companyId, String name, long userId, boolean inherited)`
`static void`	`setRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)`
`static void`	`setUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)`
`static void`	`unsetGroupTeamsUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds)`
`static void`	`unsetGroupUsers(HttpPrincipal httpPrincipal, long groupId, long[] userIds, ServiceContext serviceContext)`
`static void`	`unsetOrganizationUsers(HttpPrincipal httpPrincipal, long organizationId, long[] userIds)`
`static void`	`unsetPasswordPolicyUsers(HttpPrincipal httpPrincipal, long passwordPolicyId, long[] userIds)`
`static void`	`unsetRoleUsers(HttpPrincipal httpPrincipal, long roleId, long[] userIds)`
`static void`	`unsetTeamUsers(HttpPrincipal httpPrincipal, long teamId, long[] userIds)`
`static void`	`unsetUserGroupUsers(HttpPrincipal httpPrincipal, long userGroupId, long[] userIds)`
`static User`	`updateAgreedToTermsOfUse(HttpPrincipal httpPrincipal, long userId, boolean agreedToTermsOfUse)`
`static User`	`updateEmailAddress(HttpPrincipal httpPrincipal, long userId, String password, String emailAddress1, String emailAddress2, ServiceContext serviceContext)`
`static User`	updateIncompleteUser(HttpPrincipal httpPrincipal, 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)
`static User`	`updateLockoutById(HttpPrincipal httpPrincipal, long userId, boolean lockout)`
`static User`	`updateOpenId(HttpPrincipal httpPrincipal, long userId, String openId)`
`static void`	`updateOrganizations(HttpPrincipal httpPrincipal, long userId, long[] organizationIds, ServiceContext serviceContext)`
`static User`	`updatePassword(HttpPrincipal httpPrincipal, long userId, String password1, String password2, boolean passwordReset)`
`static User`	`updatePortrait(HttpPrincipal httpPrincipal, long userId, byte[] bytes)`
`static User`	`updateReminderQuery(HttpPrincipal httpPrincipal, long userId, String question, String answer)`
`static User`	`updateScreenName(HttpPrincipal httpPrincipal, long userId, String screenName)`
`static User`	`updateStatus(HttpPrincipal httpPrincipal, long userId, int status)`
`static User`	updateUser(HttpPrincipal httpPrincipal, 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, List<Address> addresses, List<EmailAddress> emailAddresses, List<Phone> phones, List<Website> websites, List<AnnouncementsDelivery> announcementsDelivers, ServiceContext serviceContext)
`static User`	updateUser(HttpPrincipal httpPrincipal, 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)

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail