com.liferay.portal.service.http
Class UserServiceSoap
java.lang.Object
com.liferay.portal.service.http.UserServiceSoap
- public class UserServiceSoap
- 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 SOAP 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 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 java.util.List
, that
is translated to an array of com.liferay.portal.model.UserSoap
.
If the method in the service utility returns a com.liferay.portal.model.User
,
that is translated to a com.liferay.portal.model.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.
- Author:
- Brian Wing Shun Chan
- See Also:
UserServiceUtil
,
UserServiceHttp
,
com.liferay.portal.service.model.UserSoap
Method Summary |
static void |
addGroupUsers(long groupId,
long[] userIds)
|
static void |
addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
|
static void |
addRoleUsers(long roleId,
long[] userIds)
|
static com.liferay.portal.model.UserSoap |
addUser(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
java.lang.String 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(long userGroupId,
long[] userIds)
|
static void |
deleteRoleUser(long roleId,
long userId)
|
static void |
deleteUser(long userId)
|
static long |
getDefaultUserId(long companyId)
|
static com.liferay.portal.model.UserSoap[] |
getGroupUsers(long groupId)
|
static com.liferay.portal.model.UserSoap[] |
getRoleUsers(long roleId)
|
static com.liferay.portal.model.UserSoap |
getUserByEmailAddress(long companyId,
java.lang.String emailAddress)
|
static com.liferay.portal.model.UserSoap |
getUserById(long userId)
|
static com.liferay.portal.model.UserSoap |
getUserByScreenName(long companyId,
java.lang.String screenName)
|
static boolean |
hasGroupUser(long groupId,
long userId)
|
static boolean |
hasRoleUser(long roleId,
long userId)
|
static void |
setGroupUsers(long groupId,
long[] userIds)
|
static void |
setRoleUsers(long roleId,
long[] userIds)
|
static void |
setUserGroupUsers(long userGroupId,
long[] userIds)
|
static void |
unsetGroupUsers(long groupId,
long[] userIds)
|
static void |
unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
|
static void |
unsetRoleUsers(long roleId,
long[] userIds)
|
static void |
unsetUserGroupUsers(long userGroupId,
long[] userIds)
|
static com.liferay.portal.model.UserSoap |
updateActive(long userId,
boolean active)
|
static com.liferay.portal.model.UserSoap |
updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
|
static com.liferay.portal.model.UserSoap |
updateLockout(long userId,
boolean lockout)
|
static void |
updateOrganizations(long userId,
long organizationId,
long locationId)
|
static com.liferay.portal.model.UserSoap |
updatePassword(long userId,
java.lang.String password1,
java.lang.String password2,
boolean passwordReset)
|
static void |
updatePortrait(long userId,
byte[] bytes)
|
static com.liferay.portal.model.UserSoap |
updateUser(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 |
UserServiceSoap
public UserServiceSoap()
addGroupUsers
public static void addGroupUsers(long groupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
addPasswordPolicyUsers
public static void addPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
addRoleUsers
public static void addRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
addUserGroupUsers
public static void addUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
addUser
public static com.liferay.portal.model.UserSoap addUser(long companyId,
boolean autoPassword,
java.lang.String password1,
java.lang.String password2,
boolean autoScreenName,
java.lang.String screenName,
java.lang.String emailAddress,
java.lang.String 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 java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
deleteRoleUser
public static void deleteRoleUser(long roleId,
long userId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
deleteUser
public static void deleteUser(long userId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getDefaultUserId
public static long getDefaultUserId(long companyId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getGroupUsers
public static com.liferay.portal.model.UserSoap[] getGroupUsers(long groupId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getRoleUsers
public static com.liferay.portal.model.UserSoap[] getRoleUsers(long roleId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getUserByEmailAddress
public static com.liferay.portal.model.UserSoap getUserByEmailAddress(long companyId,
java.lang.String emailAddress)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getUserById
public static com.liferay.portal.model.UserSoap getUserById(long userId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
getUserByScreenName
public static com.liferay.portal.model.UserSoap getUserByScreenName(long companyId,
java.lang.String screenName)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
hasGroupUser
public static boolean hasGroupUser(long groupId,
long userId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
hasRoleUser
public static boolean hasRoleUser(long roleId,
long userId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
setGroupUsers
public static void setGroupUsers(long groupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
setRoleUsers
public static void setRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
setUserGroupUsers
public static void setUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
unsetGroupUsers
public static void unsetGroupUsers(long groupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
unsetPasswordPolicyUsers
public static void unsetPasswordPolicyUsers(long passwordPolicyId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
unsetRoleUsers
public static void unsetRoleUsers(long roleId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
unsetUserGroupUsers
public static void unsetUserGroupUsers(long userGroupId,
long[] userIds)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updateActive
public static com.liferay.portal.model.UserSoap updateActive(long userId,
boolean active)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updateAgreedToTermsOfUse
public static com.liferay.portal.model.UserSoap updateAgreedToTermsOfUse(long userId,
boolean agreedToTermsOfUse)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updateLockout
public static com.liferay.portal.model.UserSoap updateLockout(long userId,
boolean lockout)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updateOrganizations
public static void updateOrganizations(long userId,
long organizationId,
long locationId)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updatePassword
public static com.liferay.portal.model.UserSoap updatePassword(long userId,
java.lang.String password1,
java.lang.String password2,
boolean passwordReset)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updatePortrait
public static void updatePortrait(long userId,
byte[] bytes)
throws java.rmi.RemoteException
- Throws:
java.rmi.RemoteException
updateUser
public static com.liferay.portal.model.UserSoap updateUser(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 java.rmi.RemoteException
- Throws:
java.rmi.RemoteException