@ProviderType
public class ResourcePermissionServiceUtil
extends Object
ResourcePermissionServiceImpl and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.ResourcePermissionService,
ResourcePermissionServiceBaseImpl,
ResourcePermissionServiceImpl| Constructor and Description |
|---|
ResourcePermissionServiceUtil() |
| 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 String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static ResourcePermissionService |
getService() |
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.
|
static 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.
|
public static void addResourcePermission(long groupId,
long companyId,
String name,
int scope,
String primKey,
long roleId,
String actionId)
throws PortalException
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.
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 IDPortalExceptionpublic static String getOSGiServiceIdentifier()
public static void removeResourcePermission(long groupId,
long companyId,
String name,
int scope,
String primKey,
long roleId,
String actionId)
throws PortalException
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
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 IDPortalExceptionpublic static void removeResourcePermissions(long groupId,
long companyId,
String name,
int scope,
long roleId,
String actionId)
throws PortalException
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 IDPortalExceptionpublic static void setIndividualResourcePermissions(long groupId,
long companyId,
String name,
String primKey,
long roleId,
String[] actionIds)
throws PortalException
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.
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 actionsPortalExceptionpublic static void setIndividualResourcePermissions(long groupId,
long companyId,
String name,
String primKey,
Map<Long,String[]> roleIdsToActionIds)
throws PortalException
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.
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 actionsPortalExceptionpublic static ResourcePermissionService getService()