com.liferay.portal.service.http
Class RoleServiceSoap

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

public class RoleServiceSoap
extends java.lang.Object

This class provides a SOAP utility for the RoleServiceUtil 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 RoleSoap. If the method in the service utility returns a Role, that is translated to a RoleSoap. 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/api/secure/axis. Set the property axis.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:

RoleServiceHttp, RoleSoap, RoleServiceUtil

Generated:

Constructor Summary

RoleServiceSoap()

Method Summary

static void	addUserRoles(long userId, long[] roleIds) Adds the roles to the user.
static void	deleteRole(long roleId) Deletes the role with the primary key and its associated permissions.
static com.liferay.portal.model.RoleSoap[]	getGroupRoles(long groupId) Returns all the roles associated with the group.
static com.liferay.portal.model.RoleSoap	getRole(long roleId) Returns the role with the primary key.
static com.liferay.portal.model.RoleSoap	getRole(long companyId, java.lang.String name) Returns the role with the name in the company.
static com.liferay.portal.model.RoleSoap[]	getUserGroupGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
static com.liferay.portal.model.RoleSoap[]	getUserGroupRoles(long userId, long groupId) Returns all the user's roles within the user group.
static com.liferay.portal.model.RoleSoap[]	getUserRelatedRoles(long userId, com.liferay.portal.model.GroupSoap[] groups) Returns the union of all the user's roles within the groups.
static com.liferay.portal.model.RoleSoap[]	getUserRoles(long userId) Returns all the roles associated with the user.
static boolean	hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited) Returns true if the user is associated with the named regular role.
static boolean	hasUserRoles(long userId, long companyId, java.lang.String[] names, boolean inherited) Returns true if the user has any one of the named regular roles.
static void	unsetUserRoles(long userId, long[] roleIds) Removes the matching roles associated with the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoleServiceSoap

public RoleServiceSoap()

Method Detail

addUserRoles

public static void addUserRoles(long userId,
                                long[] roleIds)
                         throws java.rmi.RemoteException

Adds the roles to the user. The user is reindexed after the roles are added.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException - if a user with the primary key could not be found or if the user did not have permission to assign members to one of the roles

SystemException - if a system exception occurred

java.rmi.RemoteException

deleteRole

public static void deleteRole(long roleId)
                       throws java.rmi.RemoteException

Deletes the role with the primary key and its associated permissions.

Parameters:

roleId - the primary key of the role

Throws:

PortalException - if the user did not have permission to delete the role, if a role with the primary key could not be found, if the role is a default system role, or if the role's resource could not be found

SystemException - if a system exception occurred

java.rmi.RemoteException

getGroupRoles

public static com.liferay.portal.model.RoleSoap[] getGroupRoles(long groupId)
                                                         throws java.rmi.RemoteException

Returns all the roles associated with the group.

Parameters:

groupId - the primary key of the group

Returns:

the roles associated with the group

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

java.rmi.RemoteException

getRole

public static com.liferay.portal.model.RoleSoap getRole(long roleId)
                                                 throws java.rmi.RemoteException

Returns the role with the primary key.

Parameters:

roleId - the primary key of the role

Returns:

the role with the primary key

Throws:

PortalException - if a role with the primary key could not be found or if the user did not have permission to view the role

SystemException - if a system exception occurred

java.rmi.RemoteException

getRole

public static com.liferay.portal.model.RoleSoap getRole(long companyId,
                                                        java.lang.String name)
                                                 throws java.rmi.RemoteException

Returns the role with the name in the company.

The method searches the system roles map first for default roles. If a role with the name is not found, then the method will query the database.

Parameters:

companyId - the primary key of the company

name - the role's name

Returns:

the role with the name

Throws:

PortalException - if a role with the name could not be found in the company or if the user did not have permission to view the role

SystemException - if a system exception occurred

java.rmi.RemoteException

getUserGroupGroupRoles

public static com.liferay.portal.model.RoleSoap[] getUserGroupGroupRoles(long userId,
                                                                         long groupId)
                                                                  throws java.rmi.RemoteException

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

java.rmi.RemoteException

getUserGroupRoles

public static com.liferay.portal.model.RoleSoap[] getUserGroupRoles(long userId,
                                                                    long groupId)
                                                             throws java.rmi.RemoteException

Returns all the user's roles within the user group.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

Returns:

the user's roles within the user group

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

java.rmi.RemoteException

getUserRelatedRoles

public static com.liferay.portal.model.RoleSoap[] getUserRelatedRoles(long userId,
                                                                      com.liferay.portal.model.GroupSoap[] groups)
                                                               throws java.rmi.RemoteException

Returns the union of all the user's roles within the groups.

Parameters:

userId - the primary key of the user

groups - the groups (optionally null)

Returns:

the union of all the user's roles within the groups

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

java.rmi.RemoteException

getUserRoles

public static com.liferay.portal.model.RoleSoap[] getUserRoles(long userId)
                                                        throws java.rmi.RemoteException

Returns all the roles associated with the user.

Parameters:

userId - the primary key of the user

Returns:

the roles associated with the user

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

java.rmi.RemoteException

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  java.lang.String name,
                                  boolean inherited)
                           throws java.rmi.RemoteException

Returns true if the user is associated with the named regular role.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

name - the name of the role

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user is associated with the regular role; false otherwise

Throws:

PortalException - if a role with the name could not be found in the company or if a default user for the company could not be found

SystemException - if a system exception occurred

java.rmi.RemoteException

hasUserRoles

public static boolean hasUserRoles(long userId,
                                   long companyId,
                                   java.lang.String[] names,
                                   boolean inherited)
                            throws java.rmi.RemoteException

Returns true if the user has any one of the named regular roles.

Parameters:

userId - the primary key of the user

companyId - the primary key of the company

names - the names of the roles

inherited - whether to include the user's inherited roles in the search

Returns:

true if the user has any one of the regular roles; false otherwise

Throws:

PortalException - if any one of the roles with the names could not be found in the company or if the default user for the company could not be found

SystemException - if a system exception occurred

java.rmi.RemoteException

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws java.rmi.RemoteException

Removes the matching roles associated with the user. The user is reindexed after the roles are removed.

Parameters:

userId - the primary key of the user

roleIds - the primary keys of the roles

Throws:

PortalException - if a user with the primary key could not be found, if the user did not have permission to remove members from a role, or if a role with any one of the primary keys could not be found

SystemException - if a system exception occurred

java.rmi.RemoteException