Class ResourcePermissionServiceImpl
- All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService
,com.liferay.portal.kernel.service.BaseService
,com.liferay.portal.kernel.service.ResourcePermissionService
Before attempting to read any of the documentation for this class, first read
ResourcePermissionImpl
for an
explanation of scoping.
- Author:
- Brian Wing Shun Chan
-
Field Summary
Fields inherited from class com.liferay.portal.service.base.ResourcePermissionServiceBaseImpl
counterLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService
Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.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.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.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.void
setIndividualResourcePermissions
(long groupId, long companyId, String name, String primKey, Map<Long, String[]> roleIdsToActionIds) Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type.Methods inherited from class com.liferay.portal.service.base.ResourcePermissionServiceBaseImpl
afterPropertiesSet, destroy, getCounterLocalService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, runSQL, setCounterLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService
Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId
-
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, seeResourcePermissionImpl
.- Parameters:
groupId
- the primary key of the groupcompanyId
- the primary key of the companyname
- the resource's name, which can be either a class name or a portlet IDscope
- the scope. This method only supports company, group, and group-template scope.primKey
- the primary keyroleId
- the primary key of the roleactionId
- 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, seeResourcePermissionImpl
.- Parameters:
groupId
- the primary key of the groupcompanyId
- the primary key of the companyname
- the resource's name, which can be either a class name or a portlet IDscope
- the scopeprimKey
- the primary keyroleId
- the primary key of the roleactionId
- 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 groupcompanyId
- the primary key of the companyname
- the resource's name, which can be either a class name or a portlet IDscope
- the scoperoleId
- the primary key of the roleactionId
- 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, seeResourcePermissionImpl
.- Parameters:
groupId
- the primary key of the groupcompanyId
- the primary key of the companyname
- the resource's name, which can be either a class name or a portlet IDprimKey
- the primary keyroleId
- the primary key of the roleactionIds
- 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.PortalExceptionUpdates 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, seeResourcePermissionImpl
.- Parameters:
groupId
- the primary key of the groupcompanyId
- the primary key of the companyname
- the resource's name, which can be either a class name or a portlet IDprimKey
- the primary keyroleIdsToActionIds
- a map of role IDs to action IDs of the actions- Throws:
com.liferay.portal.kernel.exception.PortalException
-