|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.BaseLocalServiceImpl com.liferay.portal.service.base.ResourceLocalServiceBaseImpl com.liferay.portal.service.impl.ResourceLocalServiceImpl
public class ResourceLocalServiceImpl
Provides the local service for accessing, adding, and updating resources.
Permissions in Liferay are defined for resource/action pairs. Some resources, known as portlet resources, define actions that the end-user can perform with respect to a portlet window. Other resources, known as model resources, define actions that the end-user can perform with respect to the service/persistence layer.
On creating an entity instance, you should create resources for it. The
following example demonstrates adding resources for an instance of a model
entity named SomeWidget
. The IDs of the actions permitted for
the group and guests are passed in from the service context.
resourceLocalService.addModelResources(
SomeWidget.getCompanyId(), SomeWidget.getGroupId(), userId,
SomeWidget.class.getName(), SomeWidget.getPrimaryKey(),
serviceContext.getGroupPermissions, serviceContext.getGuestPermissions);
Just prior to deleting an entity instance, you should delete its resource at
the individual scope. The following example demonstrates deleting a resource
associated with the SomeWidget
model entity at the scope
individual scope.
resourceLocalService.deleteResource(
SomeWidget.getCompanyId(), SomeWidget.class.getName(),
ResourceConstants.SCOPE_INDIVIDUAL, SomeWidget.getPrimaryKey());
Field Summary |
---|
Constructor Summary | |
---|---|
ResourceLocalServiceImpl()
|
Method Summary | |
---|---|
protected void |
addGroupPermissions(long companyId,
long groupId,
long userId,
String name,
Resource resource,
boolean portletActions,
PermissionedModel permissionedModel)
|
protected void |
addGroupPermissions(long groupId,
Resource resource,
String[] actionIds)
|
protected void |
addGroupPermissionsBlocks(long groupId,
Resource resource,
List<String> actionIds,
PermissionedModel permissionedModel)
|
protected void |
addGuestPermissions(long companyId,
long groupId,
long userId,
String name,
Resource resource,
boolean portletActions,
PermissionedModel permissionedModel)
|
protected void |
addGuestPermissions(long companyId,
Resource resource,
String[] actionIds)
|
protected void |
addGuestPermissionsBlocks(long companyId,
long groupId,
Resource resource,
List<String> actionIds,
PermissionedModel permissionedModel)
|
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. |
protected void |
addModelResources(long companyId,
long groupId,
long userId,
Resource resource,
String[] groupPermissions,
String[] guestPermissions,
PermissionedModel permissionedModel)
|
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. |
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. |
protected void |
addModelResources(long companyId,
long groupId,
long userId,
String name,
String primKey,
String[] groupPermissions,
String[] guestPermissions,
PermissionedModel permissionedModel)
|
protected void |
addResources(long companyId,
long groupId,
long userId,
Resource resource,
boolean portletActions,
PermissionedModel permissionedModel)
|
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. |
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. |
protected void |
addResources(long companyId,
long groupId,
long userId,
String name,
String primKey,
boolean portletActions,
boolean addGroupPermissions,
boolean addGuestPermissions,
PermissionedModel permissionedModel)
|
void |
addResources(long companyId,
long groupId,
String name,
boolean portletActions)
Adds resources for the entity with the name. |
void |
deleteResource(AuditedModel auditedModel,
int scope)
Deletes the resource associated with the model at the scope. |
void |
deleteResource(long companyId,
String name,
int scope,
long primKey)
Deletes the resource matching the primary key at the scope. |
void |
deleteResource(long companyId,
String name,
int scope,
String primKey)
Deletes the resource matching the primary key at the scope. |
protected void |
deleteResource(long companyId,
String name,
int scope,
String primKey,
PermissionedModel permissionedModel)
|
protected void |
filterOwnerActions(String name,
List<String> actionIds)
|
protected long |
getGroupId(AuditedModel auditedModel)
|
protected PermissionedModel |
getPermissionedModel(AuditedModel auditedModel)
|
Resource |
getResource(long companyId,
String name,
int scope,
String primKey)
Returns a new resource with the name and primary key at the scope. |
boolean |
hasUserPermissions(long userId,
long resourceId,
List<Resource> resources,
String actionId,
long[] roleIds)
Returns true if the roles have permission to perform the
action on the resources. |
protected void |
logHasUserPermissions(long userId,
long resourceId,
String actionId,
org.apache.commons.lang.time.StopWatch stopWatch,
int block)
|
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. |
protected void |
updateResourceBlocks(long companyId,
long groupId,
Resource resource,
String[] groupPermissions,
String[] guestPermissions,
PermissionedModel permissionedModel)
|
protected void |
updateResourcePermissions(long companyId,
long groupId,
Resource resource,
String[] groupPermissions,
String[] guestPermissions)
|
protected void |
updateResourcePermissions(long companyId,
String name,
int scope,
String primKey,
String newPrimKey)
|
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. |
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. |
protected void |
updateResources(long companyId,
long groupId,
String name,
String primKey,
String[] groupPermissions,
String[] guestPermissions,
PermissionedModel permissionedModel)
|
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. |
protected void |
validate(String name,
boolean portletActions)
|
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
---|
getClassLoader, getLayoutURL, getLayoutURL |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ResourceLocalServiceImpl()
Method Detail |
---|
public void addModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException, SystemException
ServiceContext.setAddGroupPermissions(
boolean)
and ServiceContext.setAddGuestPermissions(
boolean)
.
ServiceContext.setDeriveDefaultPermissions(
boolean)
.
ServiceContext.setGroupPermissions(String[])
and ServiceContext.setGuestPermissions(String[])
.
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.
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic void addModelResources(long companyId, long groupId, long userId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
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, optionally
0
if no instance existsgroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic void addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
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
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
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, optionally
0
if no instance existsportletActions
- whether to associate portlet actions with the
resourceaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic void addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
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
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic void addResources(long companyId, long groupId, String name, boolean portletActions) throws PortalException, SystemException
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
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic void deleteResource(AuditedModel auditedModel, int scope) throws PortalException, SystemException
auditedModel
- the model associated with the resourcescope
- the scope of the resource. For more information see ResourceConstants
.
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void deleteResource(long companyId, String name, int scope, long primKey) throws PortalException, SystemException
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 see ResourceConstants
.primKey
- the primary key of the resource instance
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void deleteResource(long companyId, String name, int scope, String primKey) throws PortalException, SystemException
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 see ResourceConstants
.primKey
- the primary key string of the resource instance
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic Resource getResource(long companyId, String name, int scope, String primKey)
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 see ResourceConstants
.primKey
- the primary key string of the resource
public boolean hasUserPermissions(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds) throws PortalException, SystemException
true
if the roles have permission to perform the
action on the resources.
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
true
if the roles have permission to perform the
action on the resources;false
otherwise
PortalException
- if any one of the roles with the primary keys
could not be found or if a resource action with the action ID
could not be found
SystemException
- if a system exception occurredpublic void updateModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException, SystemException
auditedModel
- the model associated with the resourcesserviceContext
- the service context to be applied. Can set group
and guest permissions.
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void updateResources(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
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
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void updateResources(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
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
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void updateResources(long companyId, String name, int scope, String primKey, String newPrimKey) throws SystemException
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 see ResourceConstants
.primKey
- the primary key string of the resource instancenewPrimKey
- the new primary key string of the resource
SystemException
- if a system exception occurredprotected void addGroupPermissions(long companyId, long groupId, long userId, String name, Resource resource, boolean portletActions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addGroupPermissions(long groupId, Resource resource, String[] actionIds) throws PortalException, SystemException
PortalException
SystemException
protected void addGroupPermissionsBlocks(long groupId, Resource resource, List<String> actionIds, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addGuestPermissions(long companyId, long groupId, long userId, String name, Resource resource, boolean portletActions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addGuestPermissions(long companyId, Resource resource, String[] actionIds) throws PortalException, SystemException
PortalException
SystemException
protected void addGuestPermissionsBlocks(long companyId, long groupId, Resource resource, List<String> actionIds, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addModelResources(long companyId, long groupId, long userId, Resource resource, String[] groupPermissions, String[] guestPermissions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addResources(long companyId, long groupId, long userId, Resource resource, boolean portletActions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void deleteResource(long companyId, String name, int scope, String primKey, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void filterOwnerActions(String name, List<String> actionIds)
protected long getGroupId(AuditedModel auditedModel)
protected PermissionedModel getPermissionedModel(AuditedModel auditedModel)
protected void logHasUserPermissions(long userId, long resourceId, String actionId, org.apache.commons.lang.time.StopWatch stopWatch, int block)
protected void updateResourceBlocks(long companyId, long groupId, Resource resource, String[] groupPermissions, String[] guestPermissions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void updateResourcePermissions(long companyId, long groupId, Resource resource, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
PortalException
SystemException
protected void updateResourcePermissions(long companyId, String name, int scope, String primKey, String newPrimKey) throws SystemException
SystemException
protected void updateResources(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions, PermissionedModel permissionedModel) throws PortalException, SystemException
PortalException
SystemException
protected void validate(String name, boolean portletActions) throws PortalException
PortalException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |