|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.PermissionLocalServiceUtil
public class PermissionLocalServiceUtil
The utility for the permission local service. This utility wraps PermissionLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
PermissionLocalService
,
PermissionLocalServiceBaseImpl
,
PermissionLocalServiceImpl
Constructor Summary | |
---|---|
PermissionLocalServiceUtil()
|
Method Summary | |
---|---|
static void |
addGroupPermission(long groupId,
long permissionId)
|
static void |
addGroupPermission(long groupId,
Permission permission)
|
static void |
addGroupPermissions(long groupId,
List<Permission> Permissions)
|
static void |
addGroupPermissions(long groupId,
long[] permissionIds)
|
static Permission |
addPermission(long companyId,
String actionId,
long resourceId)
Adds a permission to perform the action on the resource. |
static Permission |
addPermission(Permission permission)
Adds the permission to the database. |
static List<Permission> |
addPermissions(long companyId,
List<String> actionIds,
long resourceId)
Adds permissions to perform the actions on the resource. |
static List<Permission> |
addPermissions(long companyId,
String name,
long resourceId,
boolean portletActions)
Adds permissions to perform either the portlet resource actions or model resource actions on the resource. |
static void |
addRolePermission(long roleId,
long permissionId)
|
static void |
addRolePermission(long roleId,
Permission permission)
|
static void |
addRolePermissions(long roleId,
List<Permission> Permissions)
|
static void |
addRolePermissions(long roleId,
long[] permissionIds)
|
static void |
addUserPermission(long userId,
long permissionId)
|
static void |
addUserPermission(long userId,
Permission permission)
|
static void |
addUserPermissions(long userId,
List<Permission> Permissions)
|
static void |
addUserPermissions(long userId,
long[] permissionIds)
|
static void |
addUserPermissions(long userId,
String[] actionIds,
long resourceId)
Adds user permissions to perform the actions on the resource. |
static void |
checkPermissions(String name,
List<String> actionIds)
Checks to see if the actions are permitted on the named resource. |
static void |
clearGroupPermissions(long groupId)
|
static void |
clearRolePermissions(long roleId)
|
static void |
clearUserPermissions(long userId)
|
static Permission |
createPermission(long permissionId)
Creates a new permission with the primary key. |
static void |
deleteGroupPermission(long groupId,
long permissionId)
|
static void |
deleteGroupPermission(long groupId,
Permission permission)
|
static void |
deleteGroupPermissions(long groupId,
List<Permission> Permissions)
|
static void |
deleteGroupPermissions(long groupId,
long[] permissionIds)
|
static Permission |
deletePermission(long permissionId)
Deletes the permission with the primary key from the database. |
static Permission |
deletePermission(Permission permission)
Deletes the permission from the database. |
static void |
deleteRolePermission(long roleId,
long permissionId)
|
static void |
deleteRolePermission(long roleId,
Permission permission)
|
static void |
deleteRolePermissions(long roleId,
List<Permission> Permissions)
|
static void |
deleteRolePermissions(long roleId,
long[] permissionIds)
|
static void |
deleteUserPermission(long userId,
long permissionId)
|
static void |
deleteUserPermission(long userId,
Permission permission)
|
static void |
deleteUserPermissions(long userId,
List<Permission> Permissions)
|
static void |
deleteUserPermissions(long userId,
long[] permissionIds)
|
static DynamicQuery |
dynamicQuery()
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
static Permission |
fetchPermission(long permissionId)
|
static List<String> |
getActions(List<Permission> permissions)
Returns the IDs of all the actions belonging to the permissions. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static List<Permission> |
getGroupPermissions(long groupId)
|
static List<Permission> |
getGroupPermissions(long groupId,
int start,
int end)
|
static List<Permission> |
getGroupPermissions(long groupId,
int start,
int end,
OrderByComparator orderByComparator)
|
static List<Permission> |
getGroupPermissions(long groupId,
long resourceId)
Returns all the group's permissions on the resource. |
static List<Permission> |
getGroupPermissions(long groupId,
long companyId,
String name,
int scope,
String primKey)
Returns all the group's permissions on the named resource with the scope and primKey. |
static int |
getGroupPermissionsCount(long groupId)
|
static long |
getLatestPermissionId()
Returns the primary key of the latest permission created. |
static List<Permission> |
getOrgGroupPermissions(long organizationId,
long groupId,
long resourceId)
Returns all the permissions of the organization's group with respect to the resource. |
static Permission |
getPermission(long permissionId)
Returns the permission with the primary key. |
static List<Permission> |
getPermissions(int start,
int end)
Returns a range of all the permissions. |
static List<Permission> |
getPermissions(long companyId,
String[] actionIds,
long resourceId)
Returns all the permissions to perform the actions on the resource, creating new permissions for any permissions not found. |
static int |
getPermissionsCount()
Returns the number of permissions. |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static List<Permission> |
getRolePermissions(long roleId)
|
static List<Permission> |
getRolePermissions(long roleId,
int[] scopes)
|
static List<Permission> |
getRolePermissions(long roleId,
int start,
int end)
|
static List<Permission> |
getRolePermissions(long roleId,
int start,
int end,
OrderByComparator orderByComparator)
|
static List<Permission> |
getRolePermissions(long roleId,
long resourceId)
Returns all the role's permissions on the resource. |
static int |
getRolePermissionsCount(long roleId)
|
static PermissionLocalService |
getService()
|
static List<Permission> |
getUserPermissions(long userId)
|
static List<Permission> |
getUserPermissions(long userId,
int start,
int end)
|
static List<Permission> |
getUserPermissions(long userId,
int start,
int end,
OrderByComparator orderByComparator)
|
static List<Permission> |
getUserPermissions(long userId,
long resourceId)
Returns all the user's permissions on the resource. |
static List<Permission> |
getUserPermissions(long userId,
long companyId,
String name,
int scope,
String primKey)
Returns all the user's permissions on the named resource with the scope and primKey. |
static int |
getUserPermissionsCount(long userId)
|
static boolean |
hasGroupPermission(long groupId,
long permissionId)
|
static boolean |
hasGroupPermission(long groupId,
String actionId,
long resourceId)
Returns true if the group has permission to perform the
action on the resource. |
static boolean |
hasGroupPermissions(long groupId)
|
static boolean |
hasRolePermission(long roleId,
long permissionId)
|
static boolean |
hasRolePermission(long roleId,
long companyId,
String name,
int scope,
String actionId)
Returns true if the role has permission to perform the
action on the named resource with the scope. |
static boolean |
hasRolePermission(long roleId,
long companyId,
String name,
int scope,
String primKey,
String actionId)
Returns true if the role has permission to perform the
action on the named resource with the scope and primKey. |
static boolean |
hasRolePermissions(long roleId)
|
static boolean |
hasUserPermission(long userId,
long permissionId)
|
static boolean |
hasUserPermission(long userId,
String actionId,
long resourceId)
Returns true if the user has permission to perform the
action on the resource. |
static boolean |
hasUserPermissions(long userId)
|
static 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. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
static void |
setContainerResourcePermissions(String name,
String roleName,
String actionId)
Sets the container wide permissions of either the role or the default user of each company to perform the actions on the named resource. |
static void |
setGroupPermissions(long groupId,
long[] permissionIds)
|
static 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. |
static 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. |
static void |
setOrgGroupPermissions(long organizationId,
long groupId,
String[] actionIds,
long resourceId)
Sets the organization's group permissions to perform the actions on the resource, replacing the organization's existing group permissions on the resource. |
static void |
setRolePermission(long roleId,
long companyId,
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. |
static void |
setRolePermissions(long roleId,
long[] permissionIds)
|
static void |
setRolePermissions(long roleId,
long companyId,
String name,
int scope,
String primKey,
String[] actionIds)
Sets the role's permissions to perform the actions on the named resource, replacing the role's existing permission for each of these actions on the resource. |
static void |
setRolePermissions(long roleId,
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. |
static void |
setRolesPermissions(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. |
static void |
setRolesPermissions(long companyId,
Map<Long,String[]> roleIdsToActionIds,
String name,
int scope,
String primKey)
Sets the permissions of each role to perform respective actions on the named resource, replacing the existing permissions of each role on the resource. |
void |
setService(PermissionLocalService service)
Deprecated. |
static void |
setUserPermissions(long userId,
long[] permissionIds)
|
static void |
setUserPermissions(long userId,
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. |
static void |
unsetRolePermission(long roleId,
long permissionId)
Removes the permission from the role. |
static void |
unsetRolePermission(long roleId,
long companyId,
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. |
static void |
unsetRolePermissions(long roleId,
long companyId,
String name,
int scope,
String actionId)
Removes the role's permissions to perform the action on the named resource. |
static void |
unsetUserPermissions(long userId,
String[] actionIds,
long resourceId)
Removes the user's permissions to perform the actions on the resource. |
static Permission |
updatePermission(Permission permission)
Updates the permission in the database or adds it if it does not yet exist. |
static Permission |
updatePermission(Permission permission,
boolean merge)
Updates the permission in the database or adds it if it does not yet exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PermissionLocalServiceUtil()
Method Detail |
---|
public static Permission addPermission(Permission permission) throws SystemException
permission
- the permission
SystemException
- if a system exception occurredpublic static Permission createPermission(long permissionId)
permissionId
- the primary key for the new permission
public static Permission deletePermission(long permissionId) throws PortalException, SystemException
permissionId
- the primary key of the permission
PortalException
- if a permission with the primary key could not be found
SystemException
- if a system exception occurredpublic static Permission deletePermission(Permission permission) throws SystemException
permission
- the permission
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static Permission fetchPermission(long permissionId) throws SystemException
SystemException
public static Permission getPermission(long permissionId) throws PortalException, SystemException
permissionId
- the primary key of the permission
PortalException
- if a permission with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public static List<Permission> getPermissions(int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
start
- the lower bound of the range of permissionsend
- the upper bound of the range of permissions (not inclusive)
SystemException
- if a system exception occurredpublic static int getPermissionsCount() throws SystemException
SystemException
- if a system exception occurredpublic static Permission updatePermission(Permission permission) throws SystemException
permission
- the permission
SystemException
- if a system exception occurredpublic static Permission updatePermission(Permission permission, boolean merge) throws SystemException
permission
- the permissionmerge
- whether to merge the permission with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic static void addGroupPermission(long groupId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupPermission(long groupId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupPermissions(long groupId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addGroupPermissions(long groupId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static void clearGroupPermissions(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupPermission(long groupId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupPermission(long groupId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupPermissions(long groupId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteGroupPermissions(long groupId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getGroupPermissions(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getGroupPermissions(long groupId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getGroupPermissions(long groupId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getGroupPermissionsCount(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasGroupPermission(long groupId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasGroupPermissions(long groupId) throws SystemException
SystemException
- if a system exception occurredpublic static void setGroupPermissions(long groupId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addRolePermission(long roleId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void addRolePermission(long roleId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void addRolePermissions(long roleId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addRolePermissions(long roleId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static void clearRolePermissions(long roleId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteRolePermission(long roleId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteRolePermission(long roleId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteRolePermissions(long roleId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteRolePermissions(long roleId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getRolePermissions(long roleId) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getRolePermissions(long roleId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getRolePermissions(long roleId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getRolePermissionsCount(long roleId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasRolePermission(long roleId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasRolePermissions(long roleId) throws SystemException
SystemException
- if a system exception occurredpublic static void setRolePermissions(long roleId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserPermission(long userId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserPermission(long userId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserPermissions(long userId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void addUserPermissions(long userId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static void clearUserPermissions(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserPermission(long userId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserPermission(long userId, Permission permission) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserPermissions(long userId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static void deleteUserPermissions(long userId, List<Permission> Permissions) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getUserPermissions(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getUserPermissions(long userId, int start, int end) throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getUserPermissions(long userId, int start, int end, OrderByComparator orderByComparator) throws SystemException
SystemException
- if a system exception occurredpublic static int getUserPermissionsCount(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasUserPermission(long userId, long permissionId) throws SystemException
SystemException
- if a system exception occurredpublic static boolean hasUserPermissions(long userId) throws SystemException
SystemException
- if a system exception occurredpublic static void setUserPermissions(long userId, long[] permissionIds) throws SystemException
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static Permission addPermission(long companyId, String actionId, long resourceId) throws SystemException
This method will retrieve the permission of the company, action, and resource with the primary keys. The method creates the permission if it fails to retrieve it.
companyId
- the primary key of the companyactionId
- the action's IDresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> addPermissions(long companyId, List<String> actionIds, long resourceId) throws SystemException
This method will retrieve the permissions of the company, actions, and resource with the primary keys. The method creates any permissions it fails to retrieve.
companyId
- the primary key of the companyactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> addPermissions(long companyId, String name, long resourceId, boolean portletActions) throws SystemException
This method will retrieve the permissions of the company, actions, and resource with the primary keys. The method creates any permissions it fails to retrieve.
companyId
- the primary key of the companyname
- the resource nameresourceId
- the primary key of the resourceportletActions
- whether to retrieve the action primary keys from
the portlet or the model resource
SystemException
- if a system exception occurredpublic static void addUserPermissions(long userId, String[] actionIds, long resourceId) throws PortalException, SystemException
userId
- the primary key of the useractionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if a user with the primary key could not be found
SystemException
- if a system exception occurredpublic static void checkPermissions(String name, List<String> actionIds) throws PortalException, SystemException
name
- the resource nameactionIds
- the primary keys of the actions
PortalException
- if the resource company or name could not be
found or were invalid
SystemException
- if a system exception occurredpublic static List<String> getActions(List<Permission> permissions)
permissions
- the permissions
public static List<Permission> getGroupPermissions(long groupId, long resourceId) throws SystemException
groupId
- the primary key of the groupresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> getGroupPermissions(long groupId, long companyId, String name, int scope, String primKey) throws SystemException
groupId
- the primary key of the groupcompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKey
SystemException
- if a system exception occurredpublic static long getLatestPermissionId() throws SystemException
SystemException
- if a system exception occurredpublic static List<Permission> getOrgGroupPermissions(long organizationId, long groupId, long resourceId) throws SystemException
organizationId
- the primary key of the organizationgroupId
- the primary key of the groupresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> getPermissions(long companyId, String[] actionIds, long resourceId) throws SystemException
companyId
- the primary key of the companyactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
SystemException
- if a system exception occurredaddPermission(long, String, long)
public static List<Permission> getRolePermissions(long roleId, int[] scopes) throws SystemException
SystemException
public static List<Permission> getRolePermissions(long roleId, long resourceId) throws SystemException
roleId
- the primary key of the roleresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> getUserPermissions(long userId, long resourceId) throws SystemException
userId
- the primary key of the userresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static List<Permission> getUserPermissions(long userId, long companyId, String name, int scope, String primKey) throws SystemException
userId
- the primary key of the usercompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKey
SystemException
- if a system exception occurredpublic static 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 occurredpublic static boolean hasRolePermission(long roleId, long companyId, String name, int scope, String actionId) throws SystemException
true
if the role has permission to perform the
action on the named resource with the scope.
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeactionId
- the action's ID
true
if the role has permission to perform the
action on the named resource with the scope; false
otherwise
SystemException
- if a system exception occurredpublic static boolean hasRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId) throws SystemException
true
if the role has permission to perform the
action on the named resource with the scope and primKey.
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionId
- the action's ID
true
if the role has permission to perform the
action on the named resource with the scope and primKey;
false
otherwise
SystemException
- if a system exception occurredpublic static 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 occurredpublic static 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 occurredpublic static void setContainerResourcePermissions(String name, String roleName, String actionId) throws PortalException, SystemException
name
- the resource nameroleName
- the role name. Supported role names include RoleConstants.ORGANIZATION_USER
, RoleConstants.OWNER
, and RoleConstants.SITE_MEMBER
.actionId
- the action's ID
PortalException
- if a matching role could not be found or if a
default user for the company could not be found
SystemException
- if a system exception occurredpublic static void 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
SystemException
- if a system exception occurredpublic static void 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 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 occurredpublic static void 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 an organization with the primary key could not
be found
SystemException
- if a system exception occurredpublic static void setRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId) throws PortalException, SystemException
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionId
- the action's ID
PortalException
- if the scope was ResourceConstants.SCOPE_INDIVIDUAL
SystemException
- if a system exception occurredpublic static void setRolePermissions(long roleId, long companyId, String name, int scope, String primKey, String[] actionIds) throws PortalException, SystemException
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionIds
- the primary keys of the actions
PortalException
- if the scope was ResourceConstants.SCOPE_INDIVIDUAL
SystemException
- if a system exception occurredpublic static void setRolePermissions(long roleId, String[] actionIds, long resourceId) throws PortalException, SystemException
roleId
- the primary key of the roleactionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if a role with the primary key could not be found
SystemException
- if a system exception occurredpublic static void setRolesPermissions(long companyId, Map<Long,String[]> roleIdsToActionIds, long resourceId) throws SystemException
companyId
- the primary key of the companyroleIdsToActionIds
- the map of roles to their new actions on the
resourceresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static void setRolesPermissions(long companyId, Map<Long,String[]> roleIdsToActionIds, String name, int scope, String primKey) throws SystemException
companyId
- the primary key of the companyroleIdsToActionIds
- the map of roles to their new actions on the
resourcename
- the resource namescope
- the resource scopeprimKey
- the resource primKey
SystemException
- if a system exception occurredpublic static void setUserPermissions(long userId, String[] actionIds, long resourceId) throws PortalException, SystemException
userId
- the primary key of the useractionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
PortalException
- if a user with the primary key could not be found
SystemException
- if a system exception occurredpublic static void unsetRolePermission(long roleId, long permissionId) throws SystemException
roleId
- the primary key of the rolepermissionId
- the primary key of the permission
SystemException
- if a system exception occurredpublic static void unsetRolePermission(long roleId, long companyId, String name, int scope, String primKey, String actionId) throws SystemException
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeprimKey
- the resource primKeyactionId
- the action's ID
SystemException
- if a system exception occurredpublic static void unsetRolePermissions(long roleId, long companyId, String name, int scope, String actionId) throws SystemException
roleId
- the primary key of the rolecompanyId
- the primary key of the companyname
- the resource namescope
- the resource scopeactionId
- the action's ID
SystemException
- if a system exception occurredpublic static void unsetUserPermissions(long userId, String[] actionIds, long resourceId) throws SystemException
userId
- the primary key of the useractionIds
- the primary keys of the actionsresourceId
- the primary key of the resource
SystemException
- if a system exception occurredpublic static PermissionLocalService getService()
public void setService(PermissionLocalService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |