Liferay 6.0.5

com.liferay.portal.service.http
Class RoleServiceSoap

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

public class RoleServiceSoap
extends 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/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:
RoleServiceHttp, RoleSoap, RoleServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
RoleServiceSoap()
           
 
Method Summary
static void addUserRoles(long userId, long[] roleIds)
           
static void deleteRole(long roleId)
           
static RoleSoap[] getGroupRoles(long groupId)
           
static RoleSoap getRole(long roleId)
           
static RoleSoap getRole(long companyId, String name)
           
static RoleSoap[] getUserGroupGroupRoles(long userId, long groupId)
           
static RoleSoap[] getUserGroupRoles(long userId, long groupId)
           
static RoleSoap[] getUserRelatedRoles(long userId, GroupSoap[] groups)
           
static RoleSoap[] getUserRoles(long userId)
           
static boolean hasUserRole(long userId, long companyId, String name, boolean inherited)
           
static boolean hasUserRoles(long userId, long companyId, String[] names, boolean inherited)
           
static void unsetUserRoles(long userId, long[] roleIds)
           
 
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 RemoteException
Throws:
RemoteException

deleteRole

public static void deleteRole(long roleId)
                       throws RemoteException
Throws:
RemoteException

getGroupRoles

public static RoleSoap[] getGroupRoles(long groupId)
                                throws RemoteException
Throws:
RemoteException

getRole

public static RoleSoap getRole(long roleId)
                        throws RemoteException
Throws:
RemoteException

getRole

public static RoleSoap getRole(long companyId,
                               String name)
                        throws RemoteException
Throws:
RemoteException

getUserGroupGroupRoles

public static RoleSoap[] getUserGroupGroupRoles(long userId,
                                                long groupId)
                                         throws RemoteException
Throws:
RemoteException

getUserGroupRoles

public static RoleSoap[] getUserGroupRoles(long userId,
                                           long groupId)
                                    throws RemoteException
Throws:
RemoteException

getUserRelatedRoles

public static RoleSoap[] getUserRelatedRoles(long userId,
                                             GroupSoap[] groups)
                                      throws RemoteException
Throws:
RemoteException

getUserRoles

public static RoleSoap[] getUserRoles(long userId)
                               throws RemoteException
Throws:
RemoteException

hasUserRole

public static boolean hasUserRole(long userId,
                                  long companyId,
                                  String name,
                                  boolean inherited)
                           throws RemoteException
Throws:
RemoteException

hasUserRoles

public static boolean hasUserRoles(long userId,
                                   long companyId,
                                   String[] names,
                                   boolean inherited)
                            throws RemoteException
Throws:
RemoteException

unsetUserRoles

public static void unsetUserRoles(long userId,
                                  long[] roleIds)
                           throws RemoteException
Throws:
RemoteException

Liferay 6.0.5