Class ResourceLocalServiceUtil
Object
com.liferay.portal.kernel.service.ResourceLocalServiceUtil
Provides the local service utility for Resource. This utility wraps
com.liferay.portal.service.impl.ResourceLocalServiceImpl
and
is an 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addModelResources
(long companyId, long groupId, long userId, String name, long primKey, ModelPermissions modelPermissions) static void
addModelResources
(long companyId, long groupId, long userId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) Adds resources for the model with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.static void
addModelResources
(long companyId, long groupId, long userId, String name, String primKey, ModelPermissions modelPermissions) static void
addModelResources
(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) Adds resources for the model with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.static void
addModelResources
(AuditedModel auditedModel, ServiceContext serviceContext) Adds resources for the model, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.static void
addResources
(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) Adds resources for the entity with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.static void
addResources
(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, ServiceContext serviceContext) static void
addResources
(long companyId, long groupId, long userId, String name, String[] primKeys, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) static void
addResources
(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) Adds resources for the entity with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.static void
addResources
(long companyId, long groupId, String name, boolean portletActions) Adds resources for the entity with the name.static void
copyModelResources
(long companyId, String name, long sourcePrimKey, long targetPrimKey) static void
deleteResource
(long companyId, String name, int scope, long primKey) Deletes the resource matching the primary key at the scope.static void
deleteResource
(long companyId, String name, int scope, String primKey) Deletes the resource matching the primary key at the scope.static void
deleteResource
(AuditedModel auditedModel, int scope) Deletes the resource associated with the model at the scope.static String
Returns the OSGi service identifier.static Resource
getResource
(long companyId, String name, int scope, String primKey) Returns a new resource with the name and primary key at the scope.static ResourceLocalService
static boolean
hasUserPermissions
(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds) Returnstrue
if the roles have permission to perform the action on the resources.static void
removeResource
(long companyId, String name, int scope, String primKey, long roleId, String actionId) static void
setService
(ResourceLocalService service) static void
updateModelResources
(AuditedModel auditedModel, ServiceContext serviceContext) Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.static void
updateResources
(long companyId, long groupId, String name, long primKey, ModelPermissions modelPermissions) Updates resources matching the group, name, and primary key at the individual scope, setting new permissions.static void
updateResources
(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) Updates resources matching the group, name, and primary key at the individual scope, setting new group and guest permissions.static void
updateResources
(long companyId, long groupId, String name, String primKey, ModelPermissions modelPermissions) Updates resources matching the group, name, and primary key string at the individual scope, setting new permissions.static void
updateResources
(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) Updates resources matching the group, name, and primary key string at the individual scope, setting new group and guest permissions.static void
updateResources
(long companyId, String name, int scope, String primKey, String newPrimKey) Updates resources matching the name, primary key string and scope, replacing the primary key of their resource permissions with the new primary key.
-
Constructor Details
-
ResourceLocalServiceUtil
public ResourceLocalServiceUtil()
-
-
Method Details
-
addModelResources
public static void addModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException Adds resources for the model, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.-
If the service context specifies that default group or default guest
permissions are to be added, then only default permissions are added. See
ServiceContext.setAddGroupPermissions(boolean)
andServiceContext.setAddGuestPermissions(boolean)
. -
Else ...
-
If the service context specifies to derive default permissions, then
default group and guest permissions are derived from the model and
added. See
ServiceContext.setDeriveDefaultPermissions(boolean)
. -
Lastly group and guest permissions from the service
context are applied. See
ServiceContext#setGroupPermissions(String[])
andServiceContext#setGuestPermissions(String[])
.
-
If the service context specifies to derive default permissions, then
default group and guest permissions are derived from the model and
added. See
- Parameters:
auditedModel
- the model to associate with the resourcesserviceContext
- the service context to apply. Can set whether to add the model's default group and guest permissions, set whether to derive default group and guest permissions from the model, set group permissions to apply, and set guest permissions to apply.- Throws:
PortalException
-
If the service context specifies that default group or default guest
permissions are to be added, then only default permissions are added. See
-
addModelResources
public static void addModelResources(long companyId, long groupId, long userId, String name, long primKey, ModelPermissions modelPermissions) throws PortalException - Throws:
PortalException
-
addModelResources
public static void addModelResources(long companyId, long groupId, long userId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException Adds resources for the model with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, typically the model's class nameprimKey
- the primary key of the model instance, optionally0
if no instance existsgroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied- Throws:
PortalException
-
addModelResources
public static void addModelResources(long companyId, long groupId, long userId, String name, String primKey, ModelPermissions modelPermissions) throws PortalException - Throws:
PortalException
-
addModelResources
public static void addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException Adds resources for the model with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, typically the model's class nameprimKey
- the primary key string of the model instance, optionally an empty string if no instance existsgroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied- Throws:
PortalException
-
addResources
public static void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException Adds resources for the entity with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key of the resource instance, optionally0
if no instance existsportletActions
- whether to associate portlet actions with the resourceaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
PortalException
-
addResources
public static void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addResources
public static void addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException Adds resources for the entity with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key string of the resource instance, optionally an empty string if no instance existsportletActions
- whether to associate portlet actions with the resourceaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
PortalException
-
addResources
public static void addResources(long companyId, long groupId, long userId, String name, String[] primKeys, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException - Throws:
PortalException
-
addResources
public static void addResources(long companyId, long groupId, String name, boolean portletActions) throws PortalException Adds resources for the entity with the name. Use this method if the user is unknown or irrelevant and there is no current entity instance.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseportletActions
- whether to associate portlet actions with the resource- Throws:
PortalException
-
copyModelResources
public static void copyModelResources(long companyId, String name, long sourcePrimKey, long targetPrimKey) throws PortalException - Throws:
PortalException
-
deleteResource
Deletes the resource associated with the model at the scope.- Parameters:
auditedModel
- the model associated with the resourcescope
- the scope of the resource. For more information seeResourceConstants
.- Throws:
PortalException
-
deleteResource
public static void deleteResource(long companyId, String name, int scope, long primKey) throws PortalException Deletes the resource matching the primary key at the scope.- Parameters:
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information seeResourceConstants
.primKey
- the primary key of the resource instance- Throws:
PortalException
-
deleteResource
public static void deleteResource(long companyId, String name, int scope, String primKey) throws PortalException Deletes the resource matching the primary key at the scope.- Parameters:
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information seeResourceConstants
.primKey
- the primary key string of the resource instance- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getResource
Returns a new resource with the name and primary key at the scope.- Parameters:
companyId
- the primary key of the portal instancename
- a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information seeResourceConstants
.primKey
- the primary key string of the resource- Returns:
- the new resource
-
hasUserPermissions
public static boolean hasUserPermissions(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds) throws PortalException Returnstrue
if the roles have permission to perform the action on the resources.- Parameters:
userId
- the primary key of the user performing the permission checkresourceId
- the primary key of the resource, typically the scope group ID representing the scope in which the permission check is being performedresources
- the resources for which permissions are to be checkedactionId
- the primary key of the action to be performed on the resourcesroleIds
- the primary keys of the roles- Returns:
true
if the roles have permission to perform the action on the resources;false
otherwise- Throws:
PortalException
-
removeResource
public static void removeResource(long companyId, String name, int scope, String primKey, long roleId, String actionId) throws PortalException - Throws:
PortalException
-
updateModelResources
public static void updateModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.- Parameters:
auditedModel
- the model associated with the resourcesserviceContext
- the service context to be applied. Can set group and guest permissions.- Throws:
PortalException
-
updateResources
public static void updateResources(long companyId, long groupId, String name, long primKey, ModelPermissions modelPermissions) throws PortalException Updates resources matching the group, name, and primary key at the individual scope, setting new permissions.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key of the resource instancemodelPermissions
- the model permissions to be applied- Throws:
PortalException
-
updateResources
public static void updateResources(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException Updates resources matching the group, name, and primary key at the individual scope, setting new group and guest permissions.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key of the resource instancegroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied- Throws:
PortalException
-
updateResources
public static void updateResources(long companyId, long groupId, String name, String primKey, ModelPermissions modelPermissions) throws PortalException Updates resources matching the group, name, and primary key string at the individual scope, setting new permissions.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key string of the resource instancemodelPermissions
- the model permissions to be applied- Throws:
PortalException
-
updateResources
public static void updateResources(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException Updates resources matching the group, name, and primary key string at the individual scope, setting new group and guest permissions.- Parameters:
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwiseprimKey
- the primary key string of the resource instancegroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied- Throws:
PortalException
-
updateResources
public static void updateResources(long companyId, String name, int scope, String primKey, String newPrimKey) Updates resources matching the name, primary key string and scope, replacing the primary key of their resource permissions with the new primary key.- Parameters:
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information seeResourceConstants
.primKey
- the primary key string of the resource instancenewPrimKey
- the new primary key string of the resource
-
getService
-
setService
-