com.liferay.portal.service.http
Class UserServiceSoap
java.lang.Object
com.liferay.portal.service.http.UserServiceSoap
public class UserServiceSoap
- extends Object
This class provides a SOAP 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 is difficult for SOAP to
support certain types.
ServiceBuilder follows certain rules in translating the methods. For example,
if the method in the service utility returns a List
, that
is translated to an array of UserSoap
.
If the method in the service utility returns a
User
, that is translated to a
UserSoap
. Methods that SOAP cannot
safely wire are skipped.
The benefits of using the SOAP utility is that it is cross platform
compatible. SOAP allows different languages like Java, .NET, C++, PHP, and
even Perl, to call the generated services. One drawback of SOAP is that it is
slow because it needs to serialize all calls into a text format (XML).
You can see a list of services at
http://localhost:8080/tunnel-web/secure/axis. Set the property
tunnel.servlet.hosts.allowed in portal.properties to configure
security.
The SOAP utility is only generated for remote services.
- See Also:
UserServiceHttp
,
UserSoap
,
UserServiceUtil
- ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.
Method Summary |
static void |
addGroupUsers(long groupId,
long[] userIds)
|
static void |
addOrganizationUsers(long organizationId,
long[] userIds)
|
static void |
addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
|
static void |
addRoleUsers(long roleId,
long[] userIds)
|
static void |
addTeamUsers(long teamId,
long[] userIds)
|
static UserSoap |
addUser(long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
String 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,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
PhoneSoap[] phones,
WebsiteSoap[] websites,
AnnouncementsDeliverySoap[] announcementsDelivers,
ServiceContext serviceContext)
|
static UserSoap |
addUser(long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
String 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 void |
addUserGroupUsers(long userGroupId,
long[] userIds)
|
static void |
deletePortrait(long userId)
|
static void |
deleteRoleUser(long roleId,
long userId)
|
static void |
deleteUser(long userId)
|
static long |
getDefaultUserId(long companyId)
|
static long[] |
getGroupUserIds(long groupId)
|
static long[] |
getOrganizationUserIds(long organizationId)
|
static long[] |
getRoleUserIds(long roleId)
|
static UserSoap |
getUserByEmailAddress(long companyId,
String emailAddress)
|
static UserSoap |
getUserById(long userId)
|
static UserSoap |
getUserByScreenName(long companyId,
String screenName)
|
static long |
getUserIdByEmailAddress(long companyId,
String emailAddress)
|
static long |
getUserIdByScreenName(long companyId,
String screenName)
|
static boolean |
hasGroupUser(long groupId,
long userId)
|
static boolean |
hasRoleUser(long roleId,
long userId)
|
static boolean |
hasRoleUser(long companyId,
String name,
long userId,
boolean inherited)
|
static void |
setRoleUsers(long roleId,
long[] userIds)
|
static void |
setUserGroupUsers(long userGroupId,
long[] userIds)
|
static void |
unsetGroupUsers(long groupId,
long[] userIds)
|
static void |
unsetOrganizationUsers(long organizationId,
long[] userIds)
|
static void |
unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
|
static void |
unsetRoleUsers(long roleId,
long[] userIds)
|
static void |
unsetTeamUsers(long teamId,
long[] userIds)
|
static void |
unsetUserGroupUsers(long userGroupId,
long[] userIds)
|
static UserSoap |
updateActive(long userId,
boolean active)
|
static UserSoap |
updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
|
static void |
updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
|
static UserSoap |
updateLockout(long userId,
boolean lockout)
|
static void |
updateOpenId(long userId,
String openId)
|
static void |
updateOrganizations(long userId,
long[] organizationIds)
|
static UserSoap |
updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
|
static void |
updatePortrait(long userId,
byte[] bytes)
|
static void |
updateReminderQuery(long userId,
String question,
String answer)
|
static void |
updateScreenName(long userId,
String screenName)
|
static UserSoap |
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,
UserGroupRoleSoap[] userGroupRoles,
long[] userGroupIds,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
PhoneSoap[] phones,
WebsiteSoap[] websites,
AnnouncementsDeliverySoap[] announcementsDelivers,
ServiceContext serviceContext)
|
static UserSoap |
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,
UserGroupRoleSoap[] userGroupRoles,
long[] userGroupIds,
ServiceContext serviceContext)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
UserServiceSoap
public UserServiceSoap()
addGroupUsers
public static void addGroupUsers(long groupId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addOrganizationUsers
public static void addOrganizationUsers(long organizationId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addPasswordPolicyUsers
public static void addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addRoleUsers
public static void addRoleUsers(long roleId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addTeamUsers
public static void addTeamUsers(long teamId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addUserGroupUsers
public static void addUserGroupUsers(long userGroupId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
addUser
public static UserSoap addUser(long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
String 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 RemoteException
- Throws:
RemoteException
addUser
public static UserSoap addUser(long companyId,
boolean autoPassword,
String password1,
String password2,
boolean autoScreenName,
String screenName,
String emailAddress,
long facebookId,
String openId,
String 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,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
PhoneSoap[] phones,
WebsiteSoap[] websites,
AnnouncementsDeliverySoap[] announcementsDelivers,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
deletePortrait
public static void deletePortrait(long userId)
throws RemoteException
- Throws:
RemoteException
deleteRoleUser
public static void deleteRoleUser(long roleId,
long userId)
throws RemoteException
- Throws:
RemoteException
deleteUser
public static void deleteUser(long userId)
throws RemoteException
- Throws:
RemoteException
getDefaultUserId
public static long getDefaultUserId(long companyId)
throws RemoteException
- Throws:
RemoteException
getGroupUserIds
public static long[] getGroupUserIds(long groupId)
throws RemoteException
- Throws:
RemoteException
getOrganizationUserIds
public static long[] getOrganizationUserIds(long organizationId)
throws RemoteException
- Throws:
RemoteException
getRoleUserIds
public static long[] getRoleUserIds(long roleId)
throws RemoteException
- Throws:
RemoteException
getUserByEmailAddress
public static UserSoap getUserByEmailAddress(long companyId,
String emailAddress)
throws RemoteException
- Throws:
RemoteException
getUserById
public static UserSoap getUserById(long userId)
throws RemoteException
- Throws:
RemoteException
getUserByScreenName
public static UserSoap getUserByScreenName(long companyId,
String screenName)
throws RemoteException
- Throws:
RemoteException
getUserIdByEmailAddress
public static long getUserIdByEmailAddress(long companyId,
String emailAddress)
throws RemoteException
- Throws:
RemoteException
getUserIdByScreenName
public static long getUserIdByScreenName(long companyId,
String screenName)
throws RemoteException
- Throws:
RemoteException
hasGroupUser
public static boolean hasGroupUser(long groupId,
long userId)
throws RemoteException
- Throws:
RemoteException
hasRoleUser
public static boolean hasRoleUser(long roleId,
long userId)
throws RemoteException
- Throws:
RemoteException
hasRoleUser
public static boolean hasRoleUser(long companyId,
String name,
long userId,
boolean inherited)
throws RemoteException
- Throws:
RemoteException
setRoleUsers
public static void setRoleUsers(long roleId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
setUserGroupUsers
public static void setUserGroupUsers(long userGroupId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetGroupUsers
public static void unsetGroupUsers(long groupId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetOrganizationUsers
public static void unsetOrganizationUsers(long organizationId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetPasswordPolicyUsers
public static void unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetRoleUsers
public static void unsetRoleUsers(long roleId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetTeamUsers
public static void unsetTeamUsers(long teamId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
unsetUserGroupUsers
public static void unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws RemoteException
- Throws:
RemoteException
updateActive
public static UserSoap updateActive(long userId,
boolean active)
throws RemoteException
- Throws:
RemoteException
updateAgreedToTermsOfUse
public static UserSoap updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
throws RemoteException
- Throws:
RemoteException
updateEmailAddress
public static void updateEmailAddress(long userId,
String password,
String emailAddress1,
String emailAddress2)
throws RemoteException
- Throws:
RemoteException
updateLockout
public static UserSoap updateLockout(long userId,
boolean lockout)
throws RemoteException
- Throws:
RemoteException
updateOpenId
public static void updateOpenId(long userId,
String openId)
throws RemoteException
- Throws:
RemoteException
updateOrganizations
public static void updateOrganizations(long userId,
long[] organizationIds)
throws RemoteException
- Throws:
RemoteException
updatePassword
public static UserSoap updatePassword(long userId,
String password1,
String password2,
boolean passwordReset)
throws RemoteException
- Throws:
RemoteException
updatePortrait
public static void updatePortrait(long userId,
byte[] bytes)
throws RemoteException
- Throws:
RemoteException
updateReminderQuery
public static void updateReminderQuery(long userId,
String question,
String answer)
throws RemoteException
- Throws:
RemoteException
updateScreenName
public static void updateScreenName(long userId,
String screenName)
throws RemoteException
- Throws:
RemoteException
updateUser
public static UserSoap 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,
UserGroupRoleSoap[] userGroupRoles,
long[] userGroupIds,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
updateUser
public static UserSoap 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,
UserGroupRoleSoap[] userGroupRoles,
long[] userGroupIds,
AddressSoap[] addresses,
EmailAddressSoap[] emailAddresses,
PhoneSoap[] phones,
WebsiteSoap[] websites,
AnnouncementsDeliverySoap[] announcementsDelivers,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException