How to develop a Not Permission

1. What is the problem?
2. What is your idea of solving the problem?
3. What is the input needed for your plugin?
4. What is the output and expected outcome of your plugin?
5. Is there any resources/API that can be reused?
6. Prepare your development environment
7. Just code it!
8. Take a step further, share it or sell it

In this tutorial, you will be following the guideline of developing a plugin to develop your Not Permission plugin. Please also refer to the very first tutorial, How to develop a Bean Shell Hash Variable for more detailed steps.

1. What is the problem?

You want to configure the userview permissions or form permissions to not be in groups, departments, etc.

2. What is your idea of solving the problem?

You can develop a Userview Permission/ Form Permission Plugin to reverse the result of other permission plugins.

3. What is the input needed for your plugin?

To develop a Not Permission plugin, consider providing the following as input.

Permission: To configure a Permission plugin to get the result for reversing it.
Must be Logged In User: The result will only be valid if the user is also a logged-in user.

4. What is the output and expected outcome of your plugin?

The reverse value of the configured permission plugin.

5. Is there any resources/API that can be reused?

You can refer to How to develop a Gantt Chart UI Menu on how to reuse an existing plugin.

6. Prepare your development environment

You need to always have your Joget DX Source Code ready and built by following this guideline.

The following tutorial is prepared with a Macbook Pro and Joget Source Code version 8.0-Snapshot. Please refer to Guideline for Developing a Plugin for other platform commands.

Let's say your folder directory is as follows:

- Home
  - joget
    - plugins
    - jw-community

The plugins directory is the folder you will create and store all your plugins and the jw-community directory is where the Joget DX Source code is stored.

Run the following command to create a Apache Maven project in plugins directory.

cd joget/plugins/
~/joget/jw-community/wflow-plugin-archetype/create-plugin.sh org.joget.tutorial not_permission 8.0-Snapshot

Then, the shell script will ask you to key in a version for your plugin and ask you for confirmation before generating the Apache Maven project.

Define value for property 'version':  1.0-SNAPSHOT: : 8.0-Snapshot
[INFO] Using property: package = org.joget.tutorial
Confirm properties configuration:
groupId: org.joget.tutorial
artifactId: not_permission
version: 5.0.0
package: org.joget.tutorial
Y: : y

We should get the "BUILD SUCCESS" message shown in your terminal and a not_permission folder created in plugins folder.

Open the Apache Maven project with your IDE of choice. This tutorial uses NetBeans.

7. Just code it!

a. Extending the abstract class of a plugin type

Create a NotPermission class under the org.joget.tutorial package. Then, extend the class with the org.joget.apps.userview.model.UserviewPermission abstract class and implement org.joget.apps.form.model.FormPermission interface. Please refer to Userview Permission/ Form Permission Plugin.

b. Implement all the abstract methods

As usual, you have to implement all the abstract methods. You will use the AppPluginUtil.getMessage method to support i18n and use the MESSAGE_PATH constant variable for the message resource bundle directory.

Implementation of all basic abstract methods

package org.joget.tutorial;
  
import org.joget.apps.app.service.AppPluginUtil;
import org.joget.apps.app.service.AppUtil;
import org.joget.apps.form.model.FormPermission;
import org.joget.apps.userview.model.UserviewPermission;
  
public class NotPermission extends UserviewPermission implements FormPermission {
     
    private final static String MESSAGE_PATH = "messages/NotPermission";
  
    public String getName() {
        return "Not Permission";
    }
  
    public String getVersion() {
        return "5.0.0";
    }
  
    public String getDescription() {
        //support i18n
        return AppPluginUtil.getMessage("org.joget.tutorial.NotPermission.pluginDesc", getClassName(), MESSAGE_PATH);
    }
  
    public String getLabel() {
        //support i18n
        return AppPluginUtil.getMessage("org.joget.tutorial.NotPermission.pluginLabel", getClassName(), MESSAGE_PATH);
    }
  
    public String getClassName() {
        return getClass().getName();
    }
  
    public String getPropertyOptions() {
        return AppUtil.readPluginResource(getClassName(), "/properties/notPermission.json", null, true, MESSAGE_PATH);
    }
     
    @Override
    public boolean isAuthorize() {
        throw new UnsupportedOperationException("Not supported yet.");
    }
}

Then, you have to do a UI for the admin user to provide inputs for your plugin. In the getPropertyOptions method, you already specify your Plugin Properties Options definition file is located at /properties/notPermission.json. Let's create a resources/properties directory under the not_permission/src/main directory. After creating the directory, create a file named notPermission.json in the properties folder.

In the properties definition options file, you will need to provide options as below. Please note that you can use the @@message.key@@ syntax to support i18n in your properties options.

[{
    title : '@@userview.notpermission.config@@',
    properties : [{
        name : 'permission',
        label : '@@userview.notpermission.permission@@',
        type : 'elementselect',
        options_ajax : '[CONTEXT_PATH]/web/property/json/getElements?classname=org.joget.apps.userview.model.UserviewPermission',
        url : '[CONTEXT_PATH]/web/property/json[APP_PATH]/getPropertyOptions'
    },
    {
        name : 'loggedIn',
        label : '@@userview.notpermission.loggedIn@@',
        type : 'checkbox',
        value : 'true',
        options : [{
            value : 'true',
            label : ''
        }]
    }]
}]

After doing the properties option to collect input, you can work on the main method of the plugin which is the isAuthorize method.

@Override
public boolean isAuthorize() {
    boolean isAuthorize = false;
    try {
        if ("true".equals(getPropertyString("loggedIn")) && WorkflowUtil.isCurrentUserAnonymous()) {
            return false;
        }
         
        //get the binder
        Object permissionData = getProperty("permission");
        if (permissionData != null && permissionData instanceof Map) {
            Map pMap = (Map) permissionData;
            if (pMap != null && pMap.containsKey("className") && !pMap.get("className").toString().isEmpty()) {
                PluginManager pluginManager = (PluginManager) AppUtil.getApplicationContext().getBean("pluginManager");
                UserviewPermission permission = (UserviewPermission) pluginManager.getPlugin(pMap.get("className").toString());
                if (permission != null) {
                    Map pProps = (Map) pMap.get("properties");
                    permission.setProperties(pProps);
                    permission.setCurrentUser(getCurrentUser());
                    permission.setRequestParameters(getRequestParameters());
                     
                    isAuthorize = !permission.isAuthorize();
                }
            }
        }
    } catch (Exception e) {
        LogUtil.error(getClassName(), e, "");
    }
    return isAuthorize;
}

c. Manage the dependency libraries of your plugin

There are no extra dependencies for this plugin.

d. Make your plugin internationalization (i18n) ready for you

are using the i18n message key in the getLabel and getDescription method. You also used the i18n message key in your properties options definition as well. So, you will need to create a message resource bundle properties file for your plugin. Create the resources/messages directory under the not_permission/src/main directory. Then, create a NotPermission.properties" file in the folder. In the properties file, let's add all the message keys and their labels as below.

org.joget.tutorial.NotPermission.pluginLabel=Not Permission
org.joget.tutorial.NotPermission.pluginDesc=Used to reverse the result of other permission plugin
userview.notpermission.config=Configure Not Permission
userview.notpermission.permission=Permission
userview.notpermission.loggedIn=Must be Logged In User

e. Register your plugin to Felix Framework

You will have to register your plugin class in the Activator class (auto-generated in the same class package) to tell Felix Framework that this is a plugin.

public void start(BundleContext context) {
    registrationList = new ArrayList<ServiceRegistration>();
    //Register plugin here
    registrationList.add(context.registerService(NotPermission.class.getName(), new NotPermission(), null));
}

f. Build it and testing

Let's build your plugin. Once the building process is done, you will find a not_permission-5.0.0.jar file is created under the not_permission/target directory.

Then, let's upload the plugin jar to Manage Plugins. After uploading the jar file, double-check if the plugin is uploaded and activated correctly.

Let's open a userview and change one of the category permissions to Not Permission. You will want the current user to not be in a Managers group.