|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.ResourcePermissionLocalServiceUtil
@ProviderType public class ResourcePermissionLocalServiceUtil
Provides the local service utility for ResourcePermission. This utility wraps
ResourcePermissionLocalServiceImpl and is the
primary access point for service operations in application layer code running
on the local server. 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.
ResourcePermissionLocalService,
ResourcePermissionLocalServiceBaseImpl,
ResourcePermissionLocalServiceImpl| Constructor Summary | |
|---|---|
ResourcePermissionLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static void |
addResourcePermission(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 ResourcePermission |
addResourcePermission(ResourcePermission resourcePermission)
Adds the resource permission to the database. |
|
static void |
addResourcePermissions(String resourceName,
String roleName,
int scope,
long resourceActionBitwiseValue)
Grants the role permissions at the scope to perform the actions on all resources of the type. |
|
static ResourcePermission |
createResourcePermission(long resourcePermissionId)
Creates a new resource permission with the primary key. |
|
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel)
|
|
static ResourcePermission |
deleteResourcePermission(long resourcePermissionId)
Deletes the resource permission with the primary key from the database. |
|
static ResourcePermission |
deleteResourcePermission(ResourcePermission resourcePermission)
Deletes the resource permission from the database. |
|
static void |
deleteResourcePermissions(long companyId,
String name,
int scope,
long primKey)
Deletes all resource permissions at the scope to resources of the type. |
|
static void |
deleteResourcePermissions(long companyId,
String name,
int scope,
String primKey)
Deletes all resource permissions at the scope to resources of the type. |
|
static DynamicQuery |
dynamicQuery()
|
|
static
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> 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 matching the dynamic query. |
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query. |
|
static ResourcePermission |
fetchResourcePermission(long resourcePermissionId)
|
|
static ResourcePermission |
fetchResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId)
|
|
static ActionableDynamicQuery |
getActionableDynamicQuery()
|
|
static Map<Long,Set<String>> |
getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
Collection<String> actionIds)
|
|
static Map<Long,Set<String>> |
getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
Collection<String> actionIds)
Deprecated. As of 7.0.0, replaced by getAvailableResourcePermissionActionIds(long, String, int,
String, Collection) |
|
static List<String> |
getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
long roleId,
Collection<String> actionIds)
Returns the intersection of action IDs the role has permission at the scope to perform on resources of the type. |
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery()
|
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
|
static ResourcePermission |
getResourcePermission(long resourcePermissionId)
Returns the resource permission with the primary key. |
|
static ResourcePermission |
getResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId)
Returns the resource permission for the role at the scope to perform the actions on resources of the type. |
|
static List<ResourcePermission> |
getResourcePermissions(int start,
int end)
Returns a range of all the resource permissions. |
|
static List<ResourcePermission> |
getResourcePermissions(long companyId,
String name,
int scope,
String primKey)
Returns all the resource permissions at the scope of the type. |
|
static int |
getResourcePermissionsCount()
Returns the number of resource permissions. |
|
static int |
getResourcePermissionsCount(long companyId,
String name,
int scope,
String primKey)
Returns the number of resource permissions at the scope of the type. |
|
static List<ResourcePermission> |
getResourceResourcePermissions(long companyId,
long groupId,
String name,
String primKey)
Returns the resource permissions that apply to the resource. |
|
static List<ResourcePermission> |
getRoleResourcePermissions(long roleId)
Returns all the resource permissions for the role. |
|
static List<ResourcePermission> |
getRoleResourcePermissions(long roleId,
int[] scopes,
int start,
int end)
Returns a range of all the resource permissions for the role at the scopes. |
|
static List<Role> |
getRoles(long companyId,
String name,
int scope,
String primKey,
String actionId)
|
|
static List<ResourcePermission> |
getScopeResourcePermissions(int[] scopes)
Returns all the resource permissions where scope = any ?. |
|
static ResourcePermissionLocalService |
getService()
|
|
static boolean |
hasActionId(ResourcePermission resourcePermission,
ResourceAction resourceAction)
Returns true if the resource permission grants permission to
perform the resource action. |
|
static boolean |
hasResourcePermission(List<Resource> resources,
long[] roleIds,
String actionId)
Returns true if the roles have permission at the scope to
perform the action on the resources. |
|
static boolean |
hasResourcePermission(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
String actionId)
Returns true if the roles have permission at the scope to
perform the action on resources of the type. |
|
static boolean |
hasResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId,
String actionId)
Returns true if the role has permission at the scope to
perform the action on resources of the type. |
|
static boolean[] |
hasResourcePermissions(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
String actionId)
Deprecated. As of 7.0.0, replaced by #getRoles(long, String, int,
String, String |
|
static boolean |
hasScopeResourcePermission(long companyId,
String name,
int scope,
long roleId,
String actionId)
Returns true if the role has permission at the scope to
perform the action on the resource. |
|
static void |
mergePermissions(long fromRoleId,
long toRoleId)
Reassigns all the resource permissions from the source role to the destination role, and deletes the source role. |
|
static void |
reassignPermissions(long resourcePermissionId,
long toRoleId)
Grants the role default permissions to all the resources of the type and at the scope stored in the resource permission, deletes the resource permission, and deletes the resource permission's role if it has no permissions remaining. |
|
static void |
removeResourcePermission(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 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 |
setOwnerResourcePermissions(long companyId,
String name,
int scope,
String primKey,
long roleId,
long ownerId,
String[] actionIds)
Updates the role's permissions at the scope, setting the actions that can be performed on resources of the type, also setting the owner of any newly created resource permissions. |
|
static void |
setResourcePermissions(long companyId,
String name,
int scope,
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 |
setResourcePermissions(long companyId,
String name,
int scope,
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. |
|
static ResourcePermission |
updateResourcePermission(ResourcePermission resourcePermission)
Updates the resource 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 ResourcePermissionLocalServiceUtil()
| Method Detail |
|---|
public static void addResourcePermission(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.
companyId - 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
PortalExceptionpublic static ResourcePermission addResourcePermission(ResourcePermission resourcePermission)
resourcePermission - the resource permission
public static void addResourcePermissions(String resourceName,
String roleName,
int scope,
long resourceActionBitwiseValue)
This method should only be used to add default permissions to existing resources en masse during upgrades or while verifying permissions. For example, this method could be used to grant site members individual scope permissions to view all blog posts.
resourceName - the resource's name, which can be either a class name
or a portlet IDroleName - the role's namescope - the scoperesourceActionBitwiseValue - the bitwise IDs of the actionspublic static ResourcePermission createResourcePermission(long resourcePermissionId)
resourcePermissionId - the primary key for the new resource permission
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalExceptionpublic static ResourcePermission deleteResourcePermission(ResourcePermission resourcePermission)
resourcePermission - the resource permission
public static ResourcePermission deleteResourcePermission(long resourcePermissionId)
throws PortalException
resourcePermissionId - the primary key of the resource permission
PortalException - if a resource permission with the primary key could not be found
public static void deleteResourcePermissions(long companyId,
String name,
int scope,
long primKey)
throws PortalException
removeResourcePermission methods, as its purpose is very
different. This method should only be used for deleting resource
permissions that refer to a resource when that resource is deleted. For
example this method could be used to delete all individual scope
permissions to a blog post when it is deleted.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
companyId - 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 key
PortalException
public static void deleteResourcePermissions(long companyId,
String name,
int scope,
String primKey)
throws PortalException
removeResourcePermission methods, as its purpose is very
different. This method should only be used for deleting resource
permissions that refer to a resource when that resource is deleted. For
example this method could be used to delete all individual scope
permissions to a blog post when it is deleted.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
companyId - 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 key
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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)
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static ResourcePermission fetchResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId)
public static ResourcePermission fetchResourcePermission(long resourcePermissionId)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
Collection<String> actionIds)
public static List<String> getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
long roleId,
Collection<String> actionIds)
throws PortalException
companyId - he 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 roleactionIds - the action IDs
PortalException
@Deprecated
public static Map<Long,Set<String>> getAvailableResourcePermissionActionIds(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
Collection<String> actionIds)
getAvailableResourcePermissionActionIds(long, String, int,
String, Collection)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static ResourcePermission getResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId)
throws PortalException
companyId - 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 role
PortalException
public static ResourcePermission getResourcePermission(long resourcePermissionId)
throws PortalException
resourcePermissionId - the primary key of the resource permission
PortalException - if a resource permission with the primary key could not be found
public static List<ResourcePermission> getResourcePermissions(long companyId,
String name,
int scope,
String primKey)
companyId - 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 key
public static List<ResourcePermission> getResourcePermissions(int start,
int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ResourcePermissionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start - the lower bound of the range of resource permissionsend - the upper bound of the range of resource permissions (not inclusive)
public static int getResourcePermissionsCount()
public static int getResourcePermissionsCount(long companyId,
String name,
int scope,
String primKey)
companyId - 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 key
public static List<ResourcePermission> getResourceResourcePermissions(long companyId,
long groupId,
String name,
String primKey)
companyId - the primary key of the resource's companygroupId - the primary key of the resource's groupname - the resource's name, which can be either a class name or a
portlet IDprimKey - the primary key of the resource
public static List<ResourcePermission> getRoleResourcePermissions(long roleId)
roleId - the primary key of the role
public static List<ResourcePermission> getRoleResourcePermissions(long roleId,
int[] scopes,
int start,
int end)
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.
roleId - the primary key of the rolescopes - the scopesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public static List<Role> getRoles(long companyId,
String name,
int scope,
String primKey,
String actionId)
throws PortalException
PortalExceptionpublic static List<ResourcePermission> getScopeResourcePermissions(int[] scopes)
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.
scopes - the scopes
public static boolean hasActionId(ResourcePermission resourcePermission,
ResourceAction resourceAction)
true if the resource permission grants permission to
perform the resource action. Note that this method does not ensure that
the resource permission refers to the same type of resource as the
resource action.
resourcePermission - the resource permissionresourceAction - the resource action
true if the resource permission grants permission to
perform the resource action
public static boolean hasResourcePermission(long companyId,
String name,
int scope,
String primKey,
long roleId,
String actionId)
throws PortalException
true if the role has permission at the scope to
perform the action on resources of the type.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
companyId - 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
true if the role has permission to perform the
action on the resource; false otherwise
PortalException
public static boolean hasResourcePermission(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
String actionId)
throws PortalException
true if the roles have permission at the scope to
perform the action on resources of the type.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
companyId - 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 keyroleIds - the primary keys of the rolesactionId - the action ID
true if any one of the roles has permission to
perform the action on the resource; false otherwise
PortalException
public static boolean hasResourcePermission(List<Resource> resources,
long[] roleIds,
String actionId)
throws PortalException
true if the roles have permission at the scope to
perform the action on the resources.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
resources - the resourcesroleIds - the primary keys of the rolesactionId - the action ID
true if any one of the roles has permission to
perform the action on any one of the resources;
false otherwise
PortalException
@Deprecated
public static boolean[] hasResourcePermissions(long companyId,
String name,
int scope,
String primKey,
long[] roleIds,
String actionId)
throws PortalException
#getRoles(long, String, int,
String, String
PortalException
public static boolean hasScopeResourcePermission(long companyId,
String name,
int scope,
long roleId,
String actionId)
throws PortalException
true if the role has permission at the scope to
perform the action on the resource.
Depending on the scope, the value of primKey will have
different meanings. For more information, see ResourcePermissionImpl.
companyId - 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
true if the role has permission to perform the
action on the resource; false otherwise
PortalException
public static void mergePermissions(long fromRoleId,
long toRoleId)
throws PortalException
fromRoleId - the primary key of the source roletoRoleId - the primary key of the destination role
PortalException
public static void reassignPermissions(long resourcePermissionId,
long toRoleId)
throws PortalException
resourcePermissionId - the primary key of the resource permissiontoRoleId - the primary key of the role
PortalException
public static void removeResourcePermission(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.
companyId - 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
PortalException
public static void removeResourcePermissions(long companyId,
String name,
int scope,
long roleId,
String actionId)
throws PortalException
companyId - 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
PortalException
public static void setOwnerResourcePermissions(long companyId,
String name,
int scope,
String primKey,
long roleId,
long ownerId,
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.
companyId - 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 roleownerId - the primary key of the owner (generally the user that
created the resource)actionIds - the action IDs of the actions
PortalException
public static void setResourcePermissions(long companyId,
String name,
int scope,
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.
companyId - 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 roleactionIds - the action IDs of the actions
PortalException
public static void setResourcePermissions(long companyId,
String name,
int scope,
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.
companyId - 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 keyroleIdsToActionIds - a map of role IDs to action IDs of the actions
PortalExceptionpublic static ResourcePermission updateResourcePermission(ResourcePermission resourcePermission)
resourcePermission - the resource permission
public static ResourcePermissionLocalService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||