Web Service Plugin

Usages

• Used to provide additional HTML page or Web Service for AJAX call for the system.
• A usable Web Service Plugin need to extends org.joget.plugin.base.ExtDefaultPlugin abstract class and implements org.joget.plugin.base.PluginWebSupport interface.
• Web Service Plugin can be any plugin from other plugin types which implemented org.joget.plugin.base.PluginWebSupport interface.

Interface

org.joget.plugin.base.PluginWebSupport

• Under wflow-plugin-base module
• Interface for Web Service Plugin

Method Detail

Interface Methods

webService

public void webService(javax.servlet.HttpServletRequest request, javax.servlet.HttpServletResponse response) throws javax.servlet.ServletException, java.io.IOException

Work similar to a Servlet.

URL Pattern 

{Context Path}/web/json/plugin/{Plugin Class Name}/service

• Example: http://localhost:8080/jw/web/json/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World

{Context Path}/web/json/app/{App Id}/{App Version}/plugin/{Plugin Class Name}/service

• Example: http://localhost:8080/jw/web/json/app/crm/1/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World
• This pattern allowed you to retrieve app definition in your implementation by using this code:

AppDefinition appDef = AppUtil.getCurrentAppDefinition();

Plugin Properties Options

• Does not support.

Tutorials

• Guideline for developing a plugin
• How to develop a JDBC Options Binder
• How to develop a JDBC Form Load Binder
• How to develop a JDBC Form Store Binder
• File Upload Form Element Integrated with Amazon S3

Related Community Plugins

• Department Permission
  org.joget.apps.userview.lib.DepartmentPermission (wflow-core)
• Email Tool
  org.joget.apps.app.lib.EmailTool (wflow-core)
• Group Permission
  org.joget.apps.userview.lib.GroupPermission (wflow-core)
• Inbox
  org.joget.apps.userview.lib.InboxMenu (wflow-core)
• Organization Permission
  org.joget.apps.userview.lib.OrganizationPermission (wflow-core)
• Run Process
  org.joget.apps.userview.lib.RunProcess (wflow-core)
• Subform
  org.joget.apps.form.lib.SubForm (wflow-core)
• User Notification
  org.joget.apps.app.lib.UserNotificationAuditTrail (wflow-core)
• User Permission
  org.joget.apps.userview.lib.UserPermission (wflow-core)