Uses of Interface
de.xima.fc.plugin.interfaces.IFCPlugin
-
-
Uses of IFCPlugin in de.xima.fc.api.system
Method parameters in de.xima.fc.api.system with type arguments of type IFCPlugin Modifier and Type Method Description Map<EPluginScope,Set<String>>
PluginAPI. getPluginNameMap(UserContext uc, Mandant client, Class<? extends IFCPlugin> type)
Deprecated.Set<String>
PluginAPI. getPluginNames(UserContext uc, Mandant client, Class<? extends IFCPlugin> type)
Method for determining plugin names. -
Uses of IFCPlugin in de.xima.fc.e2e.containerplugin.plugin
Classes in de.xima.fc.e2e.containerplugin.plugin that implement IFCPlugin Modifier and Type Class Description class
EicarTestFileMalwareScannerPlugin
A sample implementation for a malware scanner plugin.class
FormRecordAttachmentServletPlugin
Simple servlet for downloading a form record attachment, meant for integration tests.class
IntegrationResourcesPortalPlugin
Portal plugin for running E2E tests against a FORMCYCLE app.class
IntegrationTestJavaScriptPlugin
Injects some JavaScript code into all forms with helper functions for testing, such as e.g. reading and asserting the values of select elements.class
MailInboxPartServletPlugin
Simple servlet for downloading a content part of a mail, meant for integration tests.class
RedirectToClientInboxNodePlugin
Plugin for E2E tests that redirects to the inbox page containing the mails for the current client.class
RedirectToFormRecordNodePlugin
Plugin for integration tests that redirects to the portal page that displays various details of the current form record. -
Uses of IFCPlugin in de.xima.fc.gui.bean.plugingui
Classes in de.xima.fc.gui.bean.plugingui with type parameters of type IFCPlugin Modifier and Type Class Description class
PluginBeanHelper<TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
Helper class for handling unmanaged beans used by user interfaces provided by a plugin, eg. a dashboard plugin or a workflow action plugin:Methods in de.xima.fc.gui.bean.plugingui with type parameters of type IFCPlugin Modifier and Type Method Description static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
PluginBeanHelper<TBean,TPlugin>PluginBeanHelper. forCurrentApplicationScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions)
A new helper for application scoped beans of the given plugin.static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
PluginBeanHelper<TBean,TPlugin>PluginBeanHelper. forCurrentRequestScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions)
A new helper for application request beans of the given plugin.static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
PluginBeanHelper<TBean,TPlugin>PluginBeanHelper. forCurrentSessionScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions)
A new helper for session scoped beans of the given plugin.static <TBean extends IPluginGenericCustomGUIBean,TPlugin extends IFCPlugin & IPluginGenericCustomGUI<TBean>>
PluginBeanHelper<TBean,TPlugin>PluginBeanHelper. forCurrentViewScope(TPlugin plugin, Mandant client, PluginBeanOptions pluginBeanOptions)
A new helper for view scoped beans of the given plugin. -
Uses of IFCPlugin in de.xima.fc.handler.interfaces.system
Method parameters in de.xima.fc.handler.interfaces.system with type arguments of type IFCPlugin Modifier and Type Method Description Map<EPluginScope,Set<String>>
IPluginHandler. getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
Set<String>
IPluginHandler. getPluginNames(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
-
Uses of IFCPlugin in de.xima.fc.handler.system
Method parameters in de.xima.fc.handler.system with type arguments of type IFCPlugin Modifier and Type Method Description Map<EPluginScope,Set<String>>
PluginHandler. getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
Set<String>
PluginHandler. getPluginNames(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
-
Uses of IFCPlugin in de.xima.fc.plugin
Methods in de.xima.fc.plugin with type parameters of type IFCPlugin Modifier and Type Method Description static <T extends IFCPlugin>
booleanPluginHelper. canPluginBeRegistered(PluginRuntime prtm, Class<T> pluginClass)
static <T extends IFCPlugin>
Set<T>PluginManager. getAllPlugins(Mandant client, Class<T> pluginType)
Get a set of plugins with the given interface registered in system-scope OR to the given client.static <T extends IFCPlugin>
Set<T>PluginManager. getAllPlugins(UUID clientUuid, Class<T> pluginType)
Get a set of plugins with the given interface registered in system-scope OR to the given client.static <T extends IFCPlugin>
Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>PluginManager. getAllPluginsWithRuntime(Mandant man, Class<T> clazz)
static <T extends IFCPlugin>
Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>PluginManager. getAllPluginsWithRuntime(UUID clientUuid, Class<T> clazz)
static <T extends IFCPlugin>
Set<T>PluginManager. getClientPlugins(Mandant client, Class<T> pluginType)
Get a set of plugins with the given interfaces registered to the given clientstatic <T extends IFCPlugin>
Set<T>PluginManager. getClientPlugins(UUID clientUuid, Class<T> pluginType)
Get a set of plugins with the given interfaces registered to the given clientstatic <T extends IFCPlugin>
Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>PluginManager. getClientPluginsWithRuntime(Mandant client, Class<T> clazz)
static <T extends IFCPlugin>
Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>PluginManager. getClientPluginsWithRuntime(UUID clientUuid, Class<T> clazz)
static <T extends IFCPlugin>
TPluginManager. getPluginByName(Mandant man, Class<T> clazz, String pluginName)
Get a plugin by name andIFCPlugin
-interface from client- and system-scopestatic <T extends IFCPlugin>
org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>PluginManager. getPluginByNameWithRuntime(Mandant man, Class<T> clazz, String pluginName)
static <T extends IFCPlugin>
Map<EPluginScope,Set<String>>PluginManager. getPluginNameMap(Mandant mandant, Class<T> clazz)
Deprecated.static <T extends IFCPlugin>
Set<String>PluginManager. getPluginNames(Mandant mandant, Class<T> clazz)
static <T extends IFCPlugin>
Set<T>PluginManager. getRegisteredPlugins(Class<T> clazz)
Get an set with all registered plugins of the givenIFCPlugin
-interfacestatic <T extends IFCPlugin>
TPluginManager. getSystemPluginByName(Class<T> clazz, String pluginName)
Get a system-plugin by name,IFCPlugin
-interfacestatic <T extends IFCPlugin>
Set<T>PluginManager. getSystemPlugins(Class<T> clazz)
Get a set of plugins with the given interfaces registered in system-scopestatic <T extends IFCPlugin>
Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime,T>>PluginManager. getSystemPluginsWithRuntime(Class<T> clazz)
static <T extends IFCPlugin>
voidPluginManager. registerClientPlugin(Mandant man, Class<T> clazz, String runtimeKey)
Method to register a plugin-class in scope of the given clientstatic <T extends IFCPlugin>
TPluginHelper. registerPlugin(boolean install, boolean initialize, PluginRuntime prtm, Class<T> clazz)
static <T extends IFCPlugin>
voidPluginManager. registerPlugin(boolean isInstall, PluginRuntime prtm, Class<T> clazz)
Register a plugin to the given key andPluginRuntime
static <T extends IFCPlugin>
voidPluginManager. registerPlugin(PluginRuntime prtm, Class<T> clazz)
Methods in de.xima.fc.plugin that return IFCPlugin Modifier and Type Method Description static IFCPlugin
PluginManager. getMandantPluginByName(Mandant man, EPluginTypes type, String pluginName)
Deprecated.will be removed!static IFCPlugin
PluginManager. getPluginByName(Mandant man, EPluginTypes type, String pluginName)
Deprecated.static IFCPlugin
PluginManager. getSystemPluginByName(EPluginTypes type, String pluginName)
Deprecated.Methods in de.xima.fc.plugin that return types with arguments of type IFCPlugin Modifier and Type Method Description static List<? extends Class<? extends IFCPlugin>>
PluginHelper. getAllPlugins(PluginRuntime pluginRuntime)
static List<? extends Class<? extends IFCPlugin>>
PluginHelper. getAllPlugins(org.reflections.Reflections reflect)
static Set<IFCPlugin>
PluginManager. getAllPlugins(Mandant man, EPluginTypes type)
Deprecated.static SortedSet<IFCPlugin>
PluginManager. getMandantPlugins(Mandant man, EPluginTypes type)
Deprecated.will be removed!static SortedSet<IFCPlugin>
PluginManager. getSystemPlugins(EPluginTypes type)
Deprecated.Methods in de.xima.fc.plugin with parameters of type IFCPlugin Modifier and Type Method Description static String
PluginHelper. getDisplayName(IFCPlugin plugin, Locale locale)
Returns the display name of the plugin if it is not null.Method parameters in de.xima.fc.plugin with type arguments of type IFCPlugin Modifier and Type Method Description static void
PluginManager. registerMandantPlugin(Mandant man, EPluginTypes typ, Class<? extends IFCPlugin> clazz)
Deprecated.static void
PluginManager. registerSystemPlugin(EPluginTypes typ, Class<? extends IFCPlugin> clazz)
Deprecated.static void
PluginManager. registerSystemPlugin(Class<? extends IFCPlugin> clazz, String runtimeKey)
Method to register a plugin-class in system-scope -
Uses of IFCPlugin in de.xima.fc.plugin.abstracts
Classes in de.xima.fc.plugin.abstracts that implement IFCPlugin Modifier and Type Class Description class
AFCPlugin
Deprecated.class will be removed. -
Uses of IFCPlugin in de.xima.fc.plugin.comperator
Methods in de.xima.fc.plugin.comperator with parameters of type IFCPlugin Modifier and Type Method Description int
PluginNameComperator. compare(IFCPlugin o1, IFCPlugin o2)
-
Uses of IFCPlugin in de.xima.fc.plugin.config
Subinterfaces of IFCPlugin in de.xima.fc.plugin.config Modifier and Type Interface Description interface
IDescriptionProvidingPlugin
Deprecated.ImplementIFCPlugin
instead and usegetDescription(java.util.Locale)
.interface
IPluginConfigParamList
Interface for workflow action plugins (IPluginProcessing
).interface
IPluginCustomGUI
Interface for a processing plugin with a custom user interface.interface
IPluginShutdown
Deprecated. -
Uses of IFCPlugin in de.xima.fc.plugin.entities
Subinterfaces of IFCPlugin in de.xima.fc.plugin.entities Modifier and Type Interface Description interface
IPluginEntities
Interface for an entities plugin. -
Uses of IFCPlugin in de.xima.fc.plugin.enums
Methods in de.xima.fc.plugin.enums that return types with arguments of type IFCPlugin Modifier and Type Method Description Class<? extends IFCPlugin>
EPluginTypes. getPluginInterface()
Deprecated.Getter für das Interfaze zu dem Plugin-Typ -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces Modifier and Type Interface Description interface
IFCRemoteSyncPlugin
Markup interface for plugins which need to be synchronized with the frontend server. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.auth
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.auth Modifier and Type Interface Description interface
IPluginAuthenticationLogic
Common interface for plugins that provide a custom authentication logic.interface
IPluginAuthenticatorType
Interface for custom authenticator types. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.backend
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.backend Modifier and Type Interface Description interface
IPluginBackendTheme
Interface for backend theme plugins.interface
IPluginClientDashboard
Interface for client dashboard plugins.interface
IPluginMenuEntries
Plugin for adding custom menu entries to the backend UI of FORMCYCLE.interface
IPluginProjectMenu
Plugin interface for providing custom menus for projects with a specified scope -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.form
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.form Modifier and Type Interface Description interface
IFormLifecyclePlugin
Base interface for plugins which hook into the lifecycle of the form, such as pre-render or pre-process plugins.interface
IPluginDataSource
Interface for a data source plugin.interface
IPluginFormElementCatalogue
Interface for plugins that may add a set of form items to the designer.interface
IPluginFormElementWidget
Interface for plugins to integrate own form element widgets within the form designer.interface
IPluginFormPrePersist
Interface for form pre-persist plugins.interface
IPluginFormPreProcess
Interface for a form pre-process plugin.interface
IPluginFormPreRender
Interface for form pre-render plugins.interface
IPluginFormPreRespond
Interface for a form pre-respond plugin.interface
IPluginFormPreview
Deprecated.This plugin type was never called and will never have any function.interface
IPluginFormResource
Interface for plugins to integrate form resources like CSS or JavaScript -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.generic
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.generic Modifier and Type Interface Description interface
IPluginGeneric
Interface for a generic plugin. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.mail
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.mail Modifier and Type Interface Description interface
IPluginMailEncryption
Interface for plugins of type email encryption. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.monitoring
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.monitoring Modifier and Type Interface Description interface
IPluginMonitor
A plugin for checking the current status of the FORMCYCLE system via monitoring MBeans. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.portal
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.portal Modifier and Type Interface Description interface
IPluginPortal
Plugin for creating custom portals with own ui -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.project
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.project Modifier and Type Interface Description interface
IPluginProjectTemplate
Interface for plugins of the typ project template. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.replacer
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.replacer Modifier and Type Interface Description interface
IPluginFormReplacer
Interface for a form replacer plugin.interface
IPluginSessionReplacer
Interface for a system replacer plugin.interface
IPluginSystemReplacer
Interface for a system replacer plugin.interface
IPluginTemplateReplacer
Interface for a template replacer plugin. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.scan
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.scan Modifier and Type Interface Description interface
IPluginMalwareScanner
Interface for plugins that add additional malware scanners to the system. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.scope
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.scope Modifier and Type Interface Description interface
IPluginScopeClient
This interface marks anIFCPlugin
to only be initialized in Client scope.interface
IPluginScopeSystem
This interface marks anIFCPlugin
to only be initialized in SYSTEM scope. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.servlet
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.servlet Modifier and Type Interface Description interface
IPluginServletAction
Interface for plugins servlet action plugins. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.user
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.user Modifier and Type Interface Description interface
IPluginAccessProperties
A plugin for adding customIPluginAccessProperty
s to the FORMCYCLE backend. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.validation
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.validation Modifier and Type Interface Description interface
IPluginValidationRule
Interface for validation rule plugins. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.workflow
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.workflow Modifier and Type Interface Description interface
IPluginProcessing
Deprecated.You should use the new workflow engine.interface
IPluginWorkflowNode
Interface for workflow node plugins.interface
IPluginWorkflowTrigger
Interface for workflow trigger plugins. -
Uses of IFCPlugin in de.xima.fc.plugin.lifecycle
Classes in de.xima.fc.plugin.lifecycle with type parameters of type IFCPlugin Modifier and Type Interface Description interface
IPluginLifecycleListener<TPlugin extends IFCPlugin>
The callback method that is invoked when the event occurred for which the listener was registered.Methods in de.xima.fc.plugin.lifecycle with type parameters of type IFCPlugin Modifier and Type Method Description static <TPlugin extends IFCPlugin>
voidPluginLifecycleEventManager. deregisterListener(EPluginLifecycleEvent event, Class<TPlugin> pluginType, IPluginLifecycleListener<TPlugin> listener)
Deregisters a listener for a plugin event and a certain plugin type.static <TPlugin extends IFCPlugin>
voidPluginLifecycleEventManager. registerListener(EPluginLifecycleEvent event, Class<TPlugin> pluginType, IPluginLifecycleListener<TPlugin> listener)
Registers a listener for a plugin event.Methods in de.xima.fc.plugin.lifecycle with parameters of type IFCPlugin Modifier and Type Method Description static void
PluginLifecycleEventManager. fireEvent(EPluginLifecycleEvent event, PluginRuntime pluginRuntime, IFCPlugin plugin)
Calls all registered events listeners for the given event.Method parameters in de.xima.fc.plugin.lifecycle with type arguments of type IFCPlugin Modifier and Type Method Description static void
PluginLifecycleEventManager. deregisterListeners(EPluginLifecycleEvent event, Class<? extends IFCPlugin> pluginType)
Deregisters all listeners for a plugin event and a certain plugin type. -
Uses of IFCPlugin in de.xima.fc.plugin.runtime
Methods in de.xima.fc.plugin.runtime with type parameters of type IFCPlugin Modifier and Type Method Description <T extends IFCPlugin>
Set<T>PluginRuntime. getPluginsOfType(Class<T> clazz)
Methods in de.xima.fc.plugin.runtime that return types with arguments of type IFCPlugin Modifier and Type Method Description Set<IFCPlugin>
PluginRuntime. getAllPlugins()
Set<Class<? extends IFCPlugin>>
PluginRuntime. getUnregisteredPlugins()
Methods in de.xima.fc.plugin.runtime with parameters of type IFCPlugin Modifier and Type Method Description void
PluginRuntime. addPlugin(IFCPlugin plugin)
Adds an additional plugin to the list of plugins managed by this runtime.Method parameters in de.xima.fc.plugin.runtime with type arguments of type IFCPlugin Modifier and Type Method Description void
PluginRuntime. addUnregisteredPlugin(Class<? extends IFCPlugin> pluginClazz)
Adds a plugin to the list of unregistered plugins, i.e. plugins that are available in the class path of the plugin, but cannot be registered (such as when the license does not allow it or the plugin is not available on the master or frontend server).Constructor parameters in de.xima.fc.plugin.runtime with type arguments of type IFCPlugin Constructor Description PluginRuntime(Class<? extends IFCPlugin> clazz, String scopeKey, String runtimeKey)
Creates a new plugin runtime for a single plugin that ismanaged by the system
. -
Uses of IFCPlugin in de.xima.fc.plugin.workflow.registry
Classes in de.xima.fc.plugin.workflow.registry with type parameters of type IFCPlugin Modifier and Type Interface Description interface
IWorkflowElementRegistry<TEntity extends IWorkflowElementEntity,TElement extends IWorkflowElementTypeProviding,THandler extends IElementHandler<?,TEntity>,TPlugin extends IFCPlugin>
Registry for all workflow element handler. -
Uses of IFCPlugin in de.xima.fc.workflow.mixin
Subinterfaces of IFCPlugin in de.xima.fc.workflow.mixin Modifier and Type Interface Description interface
IPluginActionNodeHandler<TData extends BaseActionProps>
Mixin meant forIPluginWorkflowNode
plugins that only wish to provide a workflow action that executes some business logic.interface
IPluginConditionNodeHandler<TData extends BaseConditionProps>
Mixin meant forIPluginWorkflowNode
plugins that only wish to provide a workflow condition that checks a condition and redirects to the if or else branch based upon the result.interface
IPluginTriggerHandler<TData extends BaseTriggerProps>
Mixin meant forIPluginWorkflowTrigger
plugins that only wish to provide a workflow trigger that executes some business logic.Classes in de.xima.fc.workflow.mixin that implement IFCPlugin Modifier and Type Class Description class
APluginActionNodeHandler<TData extends BaseActionProps>
Abstract base class meant forIPluginWorkflowNode
plugins that only wish to provide a workflow action that executes some business logic.class
APluginConditionNodeHandler<TData extends BaseConditionProps>
Abstract base class meant forIPluginWorkflowNode
plugins that only wish to provide a workflow condition that executes some business logic condition.class
APluginTriggerHandler<TData extends BaseTriggerProps>
Abstract base class meant forIPluginWorkflowTrigger
plugins that only wish to provide a workflow action that executes some business logic.
-