com.liferay.portal.service.http

Class ResourcePermissionServiceSoap

Object

com.liferay.portal.service.http.ResourcePermissionServiceSoap

public class ResourcePermissionServiceSoap
extends Object

Provides the SOAP utility for the ResourcePermissionServiceUtil service utility. The static methods of this class call 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.kernel.model.ResourcePermissionSoap. If the method in the service utility returns a com.liferay.portal.kernel.model.ResourcePermission, that is translated to a com.liferay.portal.kernel.model.ResourcePermissionSoap. 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/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:

ResourcePermissionServiceHttp

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ResourcePermissionServiceSoap()

Method Summary

Modifier and Type	Method and Description
static void	addResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) Grants the role permission at the scope to perform the action on resources of the type.
static void	removeResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) Revokes permission at the scope from the role to perform the action on resources of the type.
static void	removeResourcePermissions(long groupId, long companyId, String name, int scope, long roleId, String actionId) Revokes all permissions at the scope from the role to perform the action on resources of the type.
static void	setIndividualResourcePermissions(long groupId, long companyId, String name, String primKey, long roleId, String[] actionIds) Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type.

Methods inherited from class Object

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

Constructor Detail

ResourcePermissionServiceSoap

public ResourcePermissionServiceSoap()

Method Detail

addResourcePermission

public static void addResourcePermission(long groupId,
                                         long companyId,
                                         String name,
                                         int scope,
                                         String primKey,
                                         long roleId,
                                         String actionId)
                                  throws RemoteException

Grants the role permission at the scope to perform the action on resources of the type. Existing actions are retained.

This method cannot be used to grant individual scope permissions, but is only intended for adding permissions at the company, group, and group-template scopes. For example, this method could be used to grant a company scope permission to edit message board posts.

If a company scope permission is granted to resources that the role already had group scope permissions to, the group scope permissions are deleted. Likewise, if a group scope permission is granted to resources that the role already had company scope permissions to, the company scope permissions are deleted. Be aware that this latter behavior can result in an overall reduction in permissions for the role.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope. This method only supports company, group, and group-template scope.

primKey - the primary key

roleId - the primary key of the role

actionId - the action ID

Throws:

RemoteException

removeResourcePermission

public static void removeResourcePermission(long groupId,
                                            long companyId,
                                            String name,
                                            int scope,
                                            String primKey,
                                            long roleId,
                                            String actionId)
                                     throws RemoteException

Revokes permission at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke a group scope permission to edit blog posts.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope

primKey - the primary key

roleId - the primary key of the role

actionId - the action ID

Throws:

RemoteException

removeResourcePermissions

public static void removeResourcePermissions(long groupId,
                                             long companyId,
                                             String name,
                                             int scope,
                                             long roleId,
                                             String actionId)
                                      throws RemoteException

Revokes all permissions at the scope from the role to perform the action on resources of the type. For example, this method could be used to revoke all individual scope permissions to edit blog posts from site members.

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

scope - the scope

roleId - the primary key of the role

actionId - the action ID

Throws:

RemoteException

setIndividualResourcePermissions

public static void setIndividualResourcePermissions(long groupId,
                                                    long companyId,
                                                    String name,
                                                    String primKey,
                                                    long roleId,
                                                    String[] actionIds)
                                             throws RemoteException

Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type. Existing actions are replaced.

This method can be used to set permissions at any scope, but it is generally only used at the individual scope. For example, it could be used to set the guest permissions on a blog post.

Depending on the scope, the value of primKey will have different meanings. For more information, see ResourcePermissionImpl.

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

name - the resource's name, which can be either a class name or a portlet ID

primKey - the primary key

roleId - the primary key of the role

actionIds - the action IDs of the actions

Throws:

RemoteException