Registering Your Permissions in the Database

Implementing Permissions

Step 2 of 5

The last step introduced the concept of resources. Resources are data stored with your entities that define how they can be accessed. For example, when the configuration in your default.xml files is applied to your application’s entities in the database, resources are created. These resources are then used in conjunction with Liferay DXP’s permissions system to determine who can do what to the entities.

To use these resources, Liferay DXP must know about them. To do that you register the resources with the system, both in the database and with the running permissions system in the OSGi container.

Liferay DXP provides a complete API—integrated with Service Builder—for managing resources. This API is injected into your implementation classes automatically. To manage the resources, you need only call the API in the service’s add and delete methods. Follow these steps to do this in your application.

Registering Guestbook Resources

1. In your guestbook-service module, open GuestbookLocalServiceImpl.java from the com.liferay.docs.guestbook.service.impl package.

2. Just before the addGuestbook method’s return statement, add this code:

   resourceLocalService.addResources(user.getCompanyId(), groupId, userId,
       Guestbook.class.getName(), guestbookId, false, true, true);
   

   Note that the resourceLocalService object is already there, ready for you to use. This is one of several utilities that are injected automatically by Service Builder into the base class your implementation class extends. You’ll see the rest in the future.

   This code adds a resource to Liferay DXP’s database to correspond with your entity (note that the guestbookId is included in the call). The three booleans at the end are settings. The first is whether to add portlet action permissions. This should only be true if the permission is for a portlet resource. Since this permission is for a model resource (an entity), it’s false. The other two are settings for adding group and guest permissions. If you set these to true, you’ll add the default permissions you defined in the permissions configuration file (default.xml) in the previous step. Since you definitely want to do this, these booleans are set to true.

3. Next, go to the updateGuestbook method. Add a similar bit of code in between guestbookPersistence.update(guestbook); and the return statement:

   resourceLocalService.updateResources(serviceContext.getCompanyId(),
       serviceContext.getScopeGroupId(), 
       Guestbook.class.getName(), guestbookId,
       serviceContext.getModelPermissions());
   

4. Now you’ll do the same for deleteGuestbook. Add this code in between guestbook = deleteGuestbook(guestbook); and the return statement:

   resourceLocalService.deleteResource(serviceContext.getCompanyId(),
       Guestbook.class.getName(), ResourceConstants.SCOPE_INDIVIDUAL,
       guestbookId);
   

5. Hit [CTRL]+[SHIFT]+O to organize the imports and save the file.

Registering Guestbook Entry Resources

1. Now you’ll add resources for the GuestbookEntry entity. Open GuestbookEntryLocalServiceImpl.java from the same package. For addGuestbookEntry, add a line of code that adds resources for this entity, just before the return statement:

   resourceLocalService.addResources(user.getCompanyId(), groupId, userId,
       GuestbookEntry.class.getName(), entryId, false, true, true);
   

2. Find updateEntry and add its resource action, also just before the return statement:

   resourceLocalService.updateResources(
         user.getCompanyId(), serviceContext.getScopeGroupId(), 
         GuestbookEntry.class.getName(), entryId, 
         serviceContext.getModelPermissions());
   

3. For deleteGuestbookEntry, add this code just before the return statement and just after the call to guestbookEntryPersistence:

   resourceLocalService.deleteResource(
      entry.getCompanyId(), GuestbookEntry.class.getName(),
      ResourceConstants.SCOPE_INDIVIDUAL, entry.getEntryId());
   

4. Hit Ctrl-Shift-O to add imports and save the file.

That’s all it takes to add permissions resources to the database. Future entities added to the database are fully permissions-enabled. Note, however, that entities you’ve already added to your Guestbook application in the portal don’t have resources and thus can’t be protected by permissions. You’ll fix this later. Now you must register permissions with the permissions system, so it knows how to check for them.

« Defining PermissionsRegistering Permissions with the Container »