com.liferay.portal.service
Interface PermissionService

All Superinterfaces:

BaseService

All Known Implementing Classes:

PermissionServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PermissionService
extends BaseService

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.

See Also:

PermissionServiceUtil, PermissionServiceBaseImpl, com.liferay.portal.service.impl.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.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

checkPermission

void checkPermission(long groupId,
                     long resourceId)
                     throws PortalException,
                            SystemException

Checks to see if the group has permission to the resource.

Parameters:

groupId - the primary key of the group

resourceId - the primary key of the resource

Throws:

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 occurred

checkPermission

void checkPermission(long groupId,
                     String name,
                     long primKey)
                     throws PortalException,
                            SystemException

Checks to see if the group has permission to the service.

Parameters:

groupId - the primary key of the group

name - the service name

primKey - the primary key of the service

Throws:

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

checkPermission

void checkPermission(long groupId,
                     String name,
                     String primKey)
                     throws PortalException,
                            SystemException

Checks to see if the group has permission to the service.

Parameters:

groupId - the primary key of the group

name - the service name

primKey - the primary key of the service

Throws:

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

hasGroupPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupPermission(long groupId,
                                                                    String actionId,
                                                                    long resourceId)
                           throws SystemException

Returns true if the group has permission to perform the action on the resource.

Parameters:

groupId - the primary key of the group

actionId - the action's ID

resourceId - the primary key of the resource

Returns:

true if the group has permission to perform the action on the resource; false otherwise

Throws:

SystemException - if a system exception occurred

hasUserPermission

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermission(long userId,
                                                                   String actionId,
                                                                   long resourceId)
                          throws SystemException

Returns true if the user has permission to perform the action on the resource.

Parameters:

userId - the primary key of the user

actionId - the action's ID

resourceId - the primary key of the resource

Returns:

true if the user has permission to perform the action on the resource; false otherwise

Throws:

SystemException - if a system exception occurred

hasUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermissions(long userId,
                                                                    long groupId,
                                                                    List<Resource> resources,
                                                                    String actionId,
                                                                    PermissionCheckerBag permissionCheckerBag)
                           throws PortalException,
                                  SystemException

Returns 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.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group containing the resource

resources - representations of the resource at each scope level returned by AdvancedPermissionChecker.getResources( long, long, String, String, String)

actionId - the action's ID

permissionCheckerBag - the permission checker bag

Returns:

true if the user has permission to perform the action on the resources; false otherwise

Throws:

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 occurred

setGroupPermissions

void setGroupPermissions(long groupId,
                         String[] actionIds,
                         long resourceId)
                         throws PortalException,
                                SystemException

Sets the group's permissions to perform the actions on the resource, replacing the group's existing permissions on the resource.

Parameters:

groupId - the primary key of the group

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

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 occurred

setGroupPermissions

void setGroupPermissions(String className,
                         String classPK,
                         long groupId,
                         String[] actionIds,
                         long resourceId)
                         throws PortalException,
                                SystemException

Sets the entity's group permissions to perform the actions on the resource, replacing the entity's existing group permissions on the resource. Only Organization and UserGroup class entities are supported.

Parameters:

className - the class name of an organization or user group

classPK - the primary key of the class

groupId - the primary key of the group

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

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 occurred

setIndividualPermissions

void setIndividualPermissions(long groupId,
                              long companyId,
                              Map<Long,String[]> roleIdsToActionIds,
                              long resourceId)
                              throws PortalException,
                                     SystemException

Sets the permissions of each role to perform respective actions on the resource, replacing the existing permissions of each role on the resource.

Parameters:

groupId - the primary key of the group

companyId - the primary key of the company

roleIdsToActionIds - the map of roles to their new actions on the resource

resourceId - the primary key of the resource

Throws:

PortalException - if the group did not have permission to the resource

SystemException - if a system exception occurred

setOrgGroupPermissions

void setOrgGroupPermissions(long organizationId,
                            long groupId,
                            String[] actionIds,
                            long resourceId)
                            throws PortalException,
                                   SystemException

Sets the organization permission to perform the actions on the resource for a particular group, replacing the organization's existing permissions on the resource.

Parameters:

organizationId - the primary key of the organization

groupId - the primary key of the group in which to scope the permissions

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

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 occurred

setRolePermission

void setRolePermission(long roleId,
                       long groupId,
                       String name,
                       int scope,
                       String primKey,
                       String actionId)
                       throws PortalException,
                              SystemException

Sets the role's permissions to perform the action on the named resource, replacing the role's existing permissions on the resource.

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

name - the resource name

scope - the resource scope

primKey - the resource primKey

actionId - the action's ID

Throws:

PortalException - if the group did not have permission to the role or if the scope was ResourceConstants.SCOPE_INDIVIDUAL

SystemException - if a system exception occurred

setRolePermissions

void setRolePermissions(long roleId,
                        long groupId,
                        String[] actionIds,
                        long resourceId)
                        throws PortalException,
                               SystemException

Sets the role's permissions to perform the actions on the resource, replacing the role's existing permissions on the resource.

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

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 occurred

setUserPermissions

void setUserPermissions(long userId,
                        long groupId,
                        String[] actionIds,
                        long resourceId)
                        throws PortalException,
                               SystemException

Sets the user's permissions to perform the actions on the resource, replacing the user's existing permissions on the resource.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

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 occurred

unsetRolePermission

void unsetRolePermission(long roleId,
                         long groupId,
                         long permissionId)
                         throws PortalException,
                                SystemException

Removes the permission from the role.

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

permissionId - the primary key of the permission

Throws:

PortalException - if the group did not have permission to the role

SystemException - if a system exception occurred

unsetRolePermission

void unsetRolePermission(long roleId,
                         long groupId,
                         String name,
                         int scope,
                         String primKey,
                         String actionId)
                         throws PortalException,
                                SystemException

Removes the role's permissions to perform the action on the named resource with the scope and primKey.

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

name - the resource name

scope - the resource scope

primKey - the resource primKey

actionId - the action's ID

Throws:

PortalException - if the group did not have permission to the role

SystemException - if a system exception occurred

unsetRolePermissions

void unsetRolePermissions(long roleId,
                          long groupId,
                          String name,
                          int scope,
                          String actionId)
                          throws PortalException,
                                 SystemException

Removes the role's permissions to perform the action on the named resource.

Parameters:

roleId - the primary key of the role

groupId - the primary key of the group

name - the resource name

scope - the resource scope

actionId - the action's ID

Throws:

PortalException - if the group did not have permission to the role

SystemException - if a system exception occurred

unsetUserPermissions

void unsetUserPermissions(long userId,
                          long groupId,
                          String[] actionIds,
                          long resourceId)
                          throws PortalException,
                                 SystemException

Removes the user's permissions to perform the actions on the resource.

Parameters:

userId - the primary key of the user

groupId - the primary key of the group

actionIds - the primary keys of the actions

resourceId - the primary key of the resource

Throws:

PortalException - if the group did not have permission to the resource

SystemException - if a system exception occurred