com.liferay.portal.service.http
Class RoleServiceSoap

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

public class RoleServiceSoap
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.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 java.util.List, that is translated to an array of com.liferay.portal.model.RoleSoap. If the method in the service utility returns a com.liferay.portal.model.Role, that is translated to a com.liferay.portal.model.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.

Author:
Brian Wing Shun Chan
See Also:
RoleSoap, RoleServiceUtil, RoleServiceHttp

Constructor Summary
RoleServiceSoap()
           
 
Method Summary
static com.liferay.portal.model.RoleSoap addRole(java.lang.String name, java.lang.String description, int type)
           
static void addUserRoles(long userId, long[] roleIds)
           
static void deleteRole(long roleId)
           
static com.liferay.portal.model.RoleSoap getGroupRole(long companyId, long groupId)
           
static com.liferay.portal.model.RoleSoap[] getGroupRoles(long groupId)
           
static com.liferay.portal.model.RoleSoap getRole(long roleId)
           
static com.liferay.portal.model.RoleSoap getRole(long companyId, java.lang.String name)
           
static com.liferay.portal.model.RoleSoap[] getUserGroupRoles(long userId, long groupId)
           
static com.liferay.portal.model.RoleSoap[] getUserRelatedRoles(long userId, com.liferay.portal.model.GroupSoap[] groups)
           
static com.liferay.portal.model.RoleSoap[] getUserRoles(long userId)
           
static boolean hasUserRole(long userId, long companyId, java.lang.String name, boolean inherited)
           
static boolean hasUserRoles(long userId, long companyId, java.lang.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

addRole

public static com.liferay.portal.model.RoleSoap addRole(java.lang.String name,
                                                        java.lang.String description,
                                                        int type)
                                                 throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

addUserRoles

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

deleteRole

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

getGroupRole

public static com.liferay.portal.model.RoleSoap getGroupRole(long companyId,
                                                             long groupId)
                                                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getGroupRoles

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

getRole

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

getRole

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

getUserGroupRoles

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

getUserRelatedRoles

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

getUserRoles

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

hasUserRole

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

hasUserRoles

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

unsetUserRoles

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