|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@JSONWebService @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface PermissionService
The interface for the permission remote service.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
PermissionServiceUtil
,
PermissionServiceBaseImpl
,
PermissionServiceImpl
Method Summary | |
---|---|
void |
checkPermission(long groupId,
long resourceId)
Checks to see if the group has permission to the resource. |
void |
checkPermission(long groupId,
String name,
long primKey)
Checks to see if the group has permission to the service. |
void |
checkPermission(long groupId,
String name,
String primKey)
Checks to see if the group has permission to the service. |
boolean |
hasGroupPermission(long groupId,
String actionId,
long resourceId)
Returns true if the group has permission to perform the
action on the resource. |
boolean |
hasUserPermission(long userId,
String actionId,
long resourceId)
Returns true if the user has permission to perform the
action on the resource. |
boolean |
hasUserPermissions(long userId,
long groupId,
List<Resource> resources,
String actionId,
PermissionCheckerBag permissionCheckerBag)
Returns true if the user has permission to perform the
action on the resources. |
void |
setGroupPermissions(long groupId,
String[] actionIds,
long resourceId)
Sets the group's permissions to perform the actions on the resource, replacing the group's existing permissions on the resource. |
void |
setGroupPermissions(String className,
String classPK,
long groupId,
String[] actionIds,
long resourceId)
Sets the entity's group permissions to perform the actions on the resource, replacing the entity's existing group permissions on the resource. |
void |
setIndividualPermissions(long groupId,
long companyId,
Map<Long,String[]> roleIdsToActionIds,
long resourceId)
Sets the permissions of each role to perform respective actions on the resource, replacing the existing permissions of each role on the resource. |
void |
setOrgGroupPermissions(long organizationId,
long groupId,
String[] actionIds,
long resourceId)
Sets the organization permission to perform the actions on the resource for a particular group, replacing the organization's existing permissions on the resource. |
void |
setRolePermission(long roleId,
long groupId,
String name,
int scope,
String primKey,
String actionId)
Sets the role's permissions to perform the action on the named resource, replacing the role's existing permissions on the resource. |
void |
setRolePermissions(long roleId,
long groupId,
String[] actionIds,
long resourceId)
Sets the role's permissions to perform the actions on the resource, replacing the role's existing permissions on the resource. |
void |
setUserPermissions(long userId,
long groupId,
String[] actionIds,
long resourceId)
Sets the user's permissions to perform the actions on the resource, replacing the user's existing permissions on the resource. |
void |
unsetRolePermission(long roleId,
long groupId,
long permissionId)
Removes the permission from the role. |
void |
unsetRolePermission(long roleId,
long groupId,
String name,
int scope,
String primKey,
String actionId)
Removes the role's permissions to perform the action on the named resource with the scope and primKey. |
void |
unsetRolePermissions(long roleId,
long groupId,
String name,
int scope,
String actionId)
Removes the role's permissions to perform the action on the named resource. |
void |
unsetUserPermissions(long userId,
long groupId,
String[] actionIds,
long resourceId)
Removes the user's permissions to perform the actions on the resource. |
Method Detail |
---|
void checkPermission(long groupId, long resourceId) throws PortalException, SystemException
groupId
- the primary key of the groupresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource, or if a group or resource with the primary key could
not be found or was invalid
SystemException
- if a system exception occurredvoid checkPermission(long groupId, String name, long primKey) throws PortalException, SystemException
groupId
- the primary key of the groupname
- the service nameprimKey
- the primary key of the service
PortalException
- if the group did not have permission to the
service, if a group with the primary key could not be found or if
the permission information was invalid
SystemException
- if a system exception occurredvoid checkPermission(long groupId, String name, String primKey) throws PortalException, SystemException
groupId
- the primary key of the groupname
- the service nameprimKey
- the primary key of the service
PortalException
- if the group did not have permission to the
service, if a group with the primary key could not be found or if
the permission information was invalid
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupPermission(long groupId, String actionId, long resourceId) throws SystemException
true
if the group has permission to perform the
action on the resource.
groupId
- the primary key of the groupactionId
- the action's IDresourceId
- the primary key of the resource
true
if the group has permission to perform the
action on the resource; false
otherwise
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserPermission(long userId, String actionId, long resourceId) throws SystemException
true
if the user has permission to perform the
action on the resource.
userId
- the primary key of the useractionId
- the action's IDresourceId
- the primary key of the resource
true
if the user has permission to perform the
action on the resource; false
otherwise
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserPermissions(long userId, long groupId, List<Resource> resources, String actionId, PermissionCheckerBag permissionCheckerBag) throws PortalException, SystemException
true
if the user has permission to perform the
action on the resources.
This method does not support resources managed by the resource block system.
userId
- the primary key of the usergroupId
- the primary key of the group containing the resourceresources
- representations of the resource at each scope level
returned by AdvancedPermissionChecker.getResources(
long, long, String, String, String)
actionId
- the action's IDpermissionCheckerBag
- the permission checker bag
true
if the user has permission to perform the
action on the resources; false
otherwise
PortalException
- if a resource action based on any one of the
resources and the action ID could not be found
SystemException
- if a system exception occurredvoid setGroupPermissions(long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
groupId
- the primary key of the groupactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if a group with the primary key could not be
found or if the group did not have permission to the resource
SystemException
- if a system exception occurredvoid setGroupPermissions(String className, String classPK, long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
Organization
and UserGroup
class entities are supported.
className
- the class name of an organization or user groupclassPK
- the primary key of the classgroupId
- the primary key of the groupactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource, if an entity with the class name and primary key could
not be found, or if the entity's associated group could not be
found
SystemException
- if a system exception occurredvoid setIndividualPermissions(long groupId, long companyId, Map<Long,String[]> roleIdsToActionIds, long resourceId) throws PortalException, SystemException
groupId
- the primary key of the groupcompanyId
- the primary key of the companyroleIdsToActionIds
- the map of roles to their new actions on the
resourceresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource
SystemException
- if a system exception occurredvoid setOrgGroupPermissions(long organizationId, long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
organizationId
- the primary key of the organizationgroupId
- the primary key of the group in which to scope the
permissionsactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource or if an organization with the primary key could not be
found
SystemException
- if a system exception occurredvoid setRolePermission(long roleId, long groupId, String name, int scope, String primKey, String actionId) throws PortalException, SystemException
roleId
- the primary key of the rolegroupId
- the primary key of the groupname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionId
- the action's ID
PortalException
- if the group did not have permission to the role
or if the scope was ResourceConstants.SCOPE_INDIVIDUAL
SystemException
- if a system exception occurredvoid setRolePermissions(long roleId, long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
roleId
- the primary key of the rolegroupId
- the primary key of the groupactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource or if a role with the primary key could not be found
SystemException
- if a system exception occurredvoid setUserPermissions(long userId, long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
userId
- the primary key of the usergroupId
- the primary key of the groupactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource or if a user with the primary key could not be found
SystemException
- if a system exception occurredvoid unsetRolePermission(long roleId, long groupId, long permissionId) throws PortalException, SystemException
roleId
- the primary key of the rolegroupId
- the primary key of the grouppermissionId
- the primary key of the permission
PortalException
- if the group did not have permission to the role
SystemException
- if a system exception occurredvoid unsetRolePermission(long roleId, long groupId, String name, int scope, String primKey, String actionId) throws PortalException, SystemException
roleId
- the primary key of the rolegroupId
- the primary key of the groupname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionId
- the action's ID
PortalException
- if the group did not have permission to the role
SystemException
- if a system exception occurredvoid unsetRolePermissions(long roleId, long groupId, String name, int scope, String actionId) throws PortalException, SystemException
roleId
- the primary key of the rolegroupId
- the primary key of the groupname
- the resource namescope
- the resource scopeactionId
- the action's ID
PortalException
- if the group did not have permission to the role
SystemException
- if a system exception occurredvoid unsetUserPermissions(long userId, long groupId, String[] actionIds, long resourceId) throws PortalException, SystemException
userId
- the primary key of the usergroupId
- the primary key of the groupactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if the group did not have permission to the
resource
SystemException
- if a system exception occurred
|
Liferay 6.1.10-ee-ga1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |