Userview Permission/ Form Permission Plugin

Userview Permission Plugins manage permissions and access rights within a userview, while Form Permission Plugins control access at the form and field level. A usable Userview Permission Plugin must extend the org.joget.apps.userview.model.UserviewPermission abstract class. Similarly, a usable Form Permission Plugin must extend the same class and implement the org.joget.apps.form.model.FormPermission interface.

Abstract Class

org.joget.apps.userview.model.UserviewPermission

• Under wflow-core module.
• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
• Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
• A base abstract class to develop a Userview/Form Permission plugin.

Method Detail

Abstract Methods

isAuthorize

public abstract boolean isAuthorize()
Check the current user is authorized to proceed.

Utility Methods

getRequestParameters

public java.util.Map getRequestParameters()
Gets request parameters.

setRequestParameters

public void setRequestParameters(java.util.Map requestParameters)
Sets request parameters.

getRequestParameter

public java.lang.Object getRequestParameter(java.lang.String requestParameter)
Convenience method to get a parameter value.

getRequestParameterString

public java.lang.String getRequestParameterString(java.lang.String requestParameter)
Convenience method to get a parameter String value.

Return Empty string instead of NULL.

getCurrentUser

public org.joget.directory.model.User getCurrentUser()
Gets current logged in user.

Return NULL if anonymous.

setCurrentUser

public void setCurrentUser(org.joget.directory.model.User currentUser)
Sets current logged in user.

Interface

org.joget.apps.form.model.FormPermission

• Under wflow-core module.
• This interface is used to mark a Userview Permission Plugin is reusable in Form Builder.
• No interface method is available in this interface.

Plugin Properties Options

• Please refer to Plugin Properties Options for more information.

Tutorials

• Guideline for Developing a Plugin
• How to develop a Not Permission

Related Community Plugins

• Bean Shell Permission
  org.joget.apps.userview.lib.BeanShellPermission (wflow-core)
• Department Permission
  org.joget.apps.userview.lib.DepartmentPermission (wflow-core)
• Group Permission
  org.joget.apps.userview.lib.GroupPermission (wflow-core)
• Logged In User Permission
  org.joget.apps.userview.lib.LoggedInUserPermission (wflow-core)
• Organization Permission
  org.joget.apps.userview.lib.OrganizationPermission (wflow-core)
• User Permission
  org.joget.apps.userview.lib.UserPermission (wflow-core)