Wiki source code of Plugin-Typen

Show last authors
1 {{figure image="usecases_plugin_interfaces_en.png" title="FORMCYCLE Plugineinordnung" width="500"}}
2 All available interfaces for plugin. This figure shows when each type of plugin will be called during the process of providing, submitting and post processing a submitted form.
3 {{/figure}}
4
5 This page contains an overview of the different types of plugins and when they are called. By adding custom plugins, you can connect {{formcycle/}} to a variety of different web services.
6
7 == List of interfaces ==
8
9 The following Java interfaces are available, each corresponding to certain type of plugin:
10
11 * [[Access properties>>Formcycle.PluginDevelopment.Types.AccessProperties]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.user.IPluginAccessProperties"/}})
12 * [[Client dashboard plugin>>doc:.IPluginClientDashboard.WebHome]] (Java interface name: {{jpath path="de.xima.fc.plugin.interfaces.IPluginClientDashboard"/}})
13 * [[Data source plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginDataSource]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.form.IPluginDataSource"/}})
14 * [[Entities plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginEntities]] (Java interface name: {{jpath path="de.xima.fc.plugin.interfaces.IPluginEntities"/}})
15 * [[Form field validation plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginValidationRule]] (Java-Schnittstellenname: {{jpath path="de.xima.fc.plugin.interfaces.validation.IPluginValidationRule"/}})
16 * [[Form pre-persist plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginFormPrePersist]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.form.IPluginFormPrePersist"/}})
17 * [[Form pre-processing plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginFormPreProcess]] (Java interface name {{jpath path="IPluginFormPreProcess"/}})
18 * [[Form pre-render plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginFormPreRender]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.form.IPluginFormPreRender"/}})
19 * [[Form template plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginProjectTemplate]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.project.IPluginProjectTemplate"/}})
20 * [[Form menu plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginProjectMenu.WebHome]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.backend.IPluginProjectMenu"/}})
21 * [[Form variable evaluation plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginFormReplacer]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.replacer.IPluginFormReplacer"/}})
22 * [[Generic plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginGeneric]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.generic.IPluginGeneric"/}})
23 * [[Mailencryption plugin>>path:/xwiki/bin/view/Formcycle/PluginDevelopment/Types/IMailEncryption]] (Java interface name: //IPluginMailEncryption//)
24 * [[Menu entries (backend)>>Formcycle.PluginDevelopment.Types.BackendMenuEntries]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.backend.IPluginMenuEntries"/}})
25 * [[Portal>>Formcycle.PluginDevelopment.Types.Portal]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.portal.IPluginPortal"/}})
26 * [[Pre-response page plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginFormPreRespond]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.form.IPluginFormPreRespond"/}})
27 * [[Limiting the scope of plugins>>doc:Formcycle.PluginDevelopment.Types.IPluginScope.WebHome]] (Java interface names {{jpath path="de.xima.fc.plugin.interfaces.scope.IPluginScopeClient"/}} & {{jpath path="de.xima.fc.plugin.interfaces.scope.IPluginScopeSystem"/}})
28 * [[Servlet action plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (Java interface name {{jpath path="de.xima.fc.interfaces.plugin.param.servlet.IPluginServletAction"/}})
29 * [[Session variable evaluation plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginSessionReplacer]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.replacer.IPluginSessionReplacer"/}})
30 * [[System variable evaluation plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginSystemReplacer]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.replacer.IPluginSystemReplacer"/}})
31 * [[Template variable evaluation plugin>>doc:Formcycle.PluginDevelopment.Types.IPluginTemplateReplacer]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.replacer.IPluginTemplateReplacer"/}})
32 * [[Theme (backend)>>Formcycle.PluginDevelopment.Types.BackendTheme]] (Java interface name {{jpath path="de.xima.fc.plugin.interfaces.backend.IPluginBackendTheme"/}})
33 * [[Workflow node>>doc:Formcycle.PluginDevelopment.Types.IPluginWorkflowNode]] (Java interface name: {{jpath path="de.xima.fc.plugin.interfaces.workflow.IPluginWorkflowNode"/}})
34 * [[Workflow trigger>>doc:Formcycle.PluginDevelopment.Types.IPluginWorkflowTrigger]] (Java inteface name: {{jpath path="de.xima.fc.plugin.interfaces.workflow.IPluginWorkflowTrigger"/}})
35 * [[JMX plugin>>doc:Formcycle.PluginDevelopment.Types.IMonitorPlugin]] (Java interface name: {{jpath path="de.xima.fc.plugin.interfaces.IMonitorPlugin"/}})
36
37 === Deprecated plugin interfaces ===
38
39 * [[--Workflow processing plugin-->>doc:Formcycle.PluginDevelopment.Types.IPluginProcessing.WebHome]] (Java plugin interface: //--IPluginProcessing--//)
40 ** Processing plugins should be implemented for the new workflow using [[plugin workflow nodes>>doc:Formcycle.PluginDevelopment.Types.IPluginWorkflowNode]] & [[plugin workflow triggers>>doc:Formcycle.PluginDevelopment.Types.IPluginWorkflowTrigger]].