Class ResourcePermissionServiceImpl

Object
com.liferay.portal.kernel.service.BaseServiceImpl
com.liferay.portal.service.base.ResourcePermissionServiceBaseImpl
com.liferay.portal.service.impl.ResourcePermissionServiceImpl
All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.ResourcePermissionService

public class ResourcePermissionServiceImpl extends ResourcePermissionServiceBaseImpl
Provides the remote service for adding, granting, and revoking resource permissions. Its methods include permission checks.

Before attempting to read any of the documentation for this class, first read ResourcePermissionImpl for an explanation of scoping.

Author:
Brian Wing Shun Chan
  • Constructor Details

    • ResourcePermissionServiceImpl

      public ResourcePermissionServiceImpl()
  • Method Details

    • addResourcePermission

      public void addResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) throws com.liferay.portal.kernel.exception.PortalException
      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:
      com.liferay.portal.kernel.exception.PortalException
    • removeResourcePermission

      public void removeResourcePermission(long groupId, long companyId, String name, int scope, String primKey, long roleId, String actionId) throws com.liferay.portal.kernel.exception.PortalException
      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:
      com.liferay.portal.kernel.exception.PortalException
    • removeResourcePermissions

      public void removeResourcePermissions(long groupId, long companyId, String name, int scope, long roleId, String actionId) throws com.liferay.portal.kernel.exception.PortalException
      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:
      com.liferay.portal.kernel.exception.PortalException
    • setIndividualResourcePermissions

      public void setIndividualResourcePermissions(long groupId, long companyId, String name, String primKey, long roleId, String[] actionIds) throws com.liferay.portal.kernel.exception.PortalException
      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:
      com.liferay.portal.kernel.exception.PortalException
    • setIndividualResourcePermissions

      public void setIndividualResourcePermissions(long groupId, long companyId, String name, String primKey, Map<Long,String[]> roleIdsToActionIds) throws com.liferay.portal.kernel.exception.PortalException
      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
      roleIdsToActionIds - a map of role IDs to action IDs of the actions
      Throws:
      com.liferay.portal.kernel.exception.PortalException