Class ResourceLocalServiceWrapper
Object
com.liferay.portal.kernel.service.ResourceLocalServiceWrapper
- All Implemented Interfaces:
BaseLocalService,ResourceLocalService,ServiceWrapper<ResourceLocalService>
public class ResourceLocalServiceWrapper
extends Object
implements ResourceLocalService, ServiceWrapper<ResourceLocalService>
Provides a wrapper for
ResourceLocalService.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddModelResources(long companyId, long groupId, long userId, String name, long primKey, ModelPermissions modelPermissions) voidaddModelResources(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.voidaddModelResources(long companyId, long groupId, long userId, String name, String primKey, ModelPermissions modelPermissions) voidaddModelResources(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.voidaddModelResources(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.voidaddResources(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.voidaddResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, ServiceContext serviceContext) voidaddResources(long companyId, long groupId, long userId, String name, String[] primKeys, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) voidaddResources(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.voidaddResources(long companyId, long groupId, String name, boolean portletActions) Adds resources for the entity with the name.voidcopyModelResources(long companyId, String name, long sourcePrimKey, long targetPrimKey) voiddeleteResource(long companyId, String name, int scope, long primKey) Deletes the resource matching the primary key at the scope.voiddeleteResource(long companyId, String name, int scope, String primKey) Deletes the resource matching the primary key at the scope.voiddeleteResource(AuditedModel auditedModel, int scope) Deletes the resource associated with the model at the scope.Returns the OSGi service identifier.getResource(long companyId, String name, int scope, String primKey) Returns a new resource with the name and primary key at the scope.booleanhasUserPermissions(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds) Returnstrueif the roles have permission to perform the action on the resources.voidremoveResource(long companyId, String name, int scope, String primKey, long roleId, String actionId) voidsetWrappedService(ResourceLocalService resourceLocalService) voidupdateModelResources(AuditedModel auditedModel, ServiceContext serviceContext) Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.voidupdateResources(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.voidupdateResources(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.voidupdateResources(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.voidupdateResources(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.voidupdateResources(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
-
ResourceLocalServiceWrapper
public ResourceLocalServiceWrapper() -
ResourceLocalServiceWrapper
-
-
Method Details
-
addModelResources
public 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
- Specified by:
addModelResourcesin interfaceResourceLocalService- 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 void addModelResources(long companyId, long groupId, long userId, String name, long primKey, ModelPermissions modelPermissions) throws PortalException - Specified by:
addModelResourcesin interfaceResourceLocalService- Throws:
PortalException
-
addModelResources
public 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.- Specified by:
addModelResourcesin interfaceResourceLocalService- 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, optionally0if no instance existsgroupPermissions- the group permissions to be appliedguestPermissions- the guest permissions to be applied- Throws:
PortalException
-
addModelResources
public void addModelResources(long companyId, long groupId, long userId, String name, String primKey, ModelPermissions modelPermissions) throws PortalException - Specified by:
addModelResourcesin interfaceResourceLocalService- Throws:
PortalException
-
addModelResources
public 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.- Specified by:
addModelResourcesin interfaceResourceLocalService- 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 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.- Specified by:
addResourcesin interfaceResourceLocalService- 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, optionally0if 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 void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, ServiceContext serviceContext) throws PortalException - Specified by:
addResourcesin interfaceResourceLocalService- Throws:
PortalException
-
addResources
public 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.- Specified by:
addResourcesin interfaceResourceLocalService- 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 void addResources(long companyId, long groupId, long userId, String name, String[] primKeys, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException - Specified by:
addResourcesin interfaceResourceLocalService- Throws:
PortalException
-
addResources
public 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.- Specified by:
addResourcesin interfaceResourceLocalService- 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 void copyModelResources(long companyId, String name, long sourcePrimKey, long targetPrimKey) throws PortalException - Specified by:
copyModelResourcesin interfaceResourceLocalService- Throws:
PortalException
-
deleteResource
Deletes the resource associated with the model at the scope.- Specified by:
deleteResourcein interfaceResourceLocalService- Parameters:
auditedModel- the model associated with the resourcescope- the scope of the resource. For more information seeResourceConstants.- Throws:
PortalException
-
deleteResource
public void deleteResource(long companyId, String name, int scope, long primKey) throws PortalException Deletes the resource matching the primary key at the scope.- Specified by:
deleteResourcein interfaceResourceLocalService- 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 void deleteResource(long companyId, String name, int scope, String primKey) throws PortalException Deletes the resource matching the primary key at the scope.- Specified by:
deleteResourcein interfaceResourceLocalService- 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.- Specified by:
getOSGiServiceIdentifierin interfaceResourceLocalService- Returns:
- the OSGi service identifier
-
getResource
Returns a new resource with the name and primary key at the scope.- Specified by:
getResourcein interfaceResourceLocalService- 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 boolean hasUserPermissions(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds) throws PortalException Returnstrueif the roles have permission to perform the action on the resources.- Specified by:
hasUserPermissionsin interfaceResourceLocalService- 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:
trueif the roles have permission to perform the action on the resources;falseotherwise- Throws:
PortalException
-
removeResource
public void removeResource(long companyId, String name, int scope, String primKey, long roleId, String actionId) throws PortalException - Specified by:
removeResourcein interfaceResourceLocalService- Throws:
PortalException
-
updateModelResources
public 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.- Specified by:
updateModelResourcesin interfaceResourceLocalService- Parameters:
auditedModel- the model associated with the resourcesserviceContext- the service context to be applied. Can set group and guest permissions.- Throws:
PortalException
-
updateResources
public 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.- Specified by:
updateResourcesin interfaceResourceLocalService- 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 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.- Specified by:
updateResourcesin interfaceResourceLocalService- 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 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.- Specified by:
updateResourcesin interfaceResourceLocalService- 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 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.- Specified by:
updateResourcesin interfaceResourceLocalService- 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 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.- Specified by:
updateResourcesin interfaceResourceLocalService- 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
-
getWrappedService
- Specified by:
getWrappedServicein interfaceServiceWrapper<ResourceLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfaceServiceWrapper<ResourceLocalService>
-