Uses of Interface
de.xima.fc.plugin.interfaces.IFCPlugin
Packages that use IFCPlugin
Package
Description
Package for API access to system configuration.
-
Uses of IFCPlugin in de.xima.fc.api.system
Method parameters in de.xima.fc.api.system with type arguments of type IFCPluginModifier and TypeMethodDescriptionPluginAPI.getPluginNameMap
(UserContext uc, Mandant client, Class<? extends IFCPlugin> type) Deprecated.PluginAPI.getPluginNames
(UserContext uc, Mandant client, Class<? extends IFCPlugin> type) Method for determining plugin names. -
Uses of IFCPlugin in de.xima.fc.gui.bean.plugingui
Classes in de.xima.fc.gui.bean.plugingui with type parameters of type IFCPluginModifier and TypeClassDescriptionclass
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 IFCPluginModifier and TypeMethodDescriptionstatic <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 IFCPluginModifier and TypeMethodDescriptionIPluginHandler.getPluginNameMap
(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type) 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 IFCPluginModifier and TypeMethodDescriptionPluginHandler.getPluginNameMap
(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type) 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 IFCPluginModifier and TypeMethodDescriptionstatic <T extends IFCPlugin>
booleanPluginHelper.canPluginBeRegistered
(PluginRuntime prtm, Class<T> pluginClass) 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.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) PluginManager.getClientPlugins
(Mandant client, Class<T> pluginType) Get a set of plugins with the given interfaces registered to the given clientPluginManager.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.PluginManager.getPluginNames
(Mandant mandant, Class<T> clazz) PluginManager.getRegisteredPlugins
(Class<T> clazz) Get a 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
-interfacePluginManager.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 IFCPluginModifier and TypeMethodDescriptionstatic 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 IFCPluginModifier and TypeMethodDescriptionPluginHelper.getAllPlugins
(PluginRuntime pluginRuntime) PluginHelper.getAllPlugins
(org.reflections.Reflections reflect) PluginManager.getAllPlugins
(Mandant man, EPluginTypes type) Deprecated.PluginManager.getMandantPlugins
(Mandant man, EPluginTypes type) Deprecated.will be removed!PluginManager.getSystemPlugins
(EPluginTypes type) Deprecated.Methods in de.xima.fc.plugin with parameters of type IFCPluginModifier and TypeMethodDescriptionstatic 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 IFCPluginModifier and TypeMethodDescriptionstatic boolean
PluginManager.isHasAnyPluginsOfType
(Mandant client, Class<? extends IFCPlugin> pluginType) Checks if any plugins of the given type exist.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 -
Uses of IFCPlugin in de.xima.fc.plugin.comperator
Methods in de.xima.fc.plugin.comperator with parameters of type IFCPlugin -
Uses of IFCPlugin in de.xima.fc.plugin.config
Subinterfaces of IFCPlugin in de.xima.fc.plugin.configModifier and TypeInterfaceDescriptioninterface
Deprecated.ImplementIFCPlugin
instead and usegetDescription(java.util.Locale)
.interface
Deprecated.Use the new workflow engine, which lets you specify a custom model and a custom UI.interface
Deprecated.Use the new workflow engine, e.g.interface
Deprecated. -
Uses of IFCPlugin in de.xima.fc.plugin.entities
Subinterfaces of IFCPlugin in de.xima.fc.plugin.entities -
Uses of IFCPlugin in de.xima.fc.plugin.enums
Methods in de.xima.fc.plugin.enums that return types with arguments of type IFCPluginModifier and TypeMethodDescriptionEPluginTypes.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.interfacesModifier and TypeInterfaceDescriptioninterface
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.authModifier and TypeInterfaceDescriptioninterface
Common interface for plugins that provide a custom authentication logic.interface
Interface for custom authenticator types. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.backend
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.backendModifier and TypeInterfaceDescriptioninterface
Interface for backend theme plugins.interface
Interface for client dashboard plugins.interface
Plugin for adding custom menu entries to the backend UI of formcycle.interface
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.formModifier and TypeInterfaceDescriptioninterface
Base interface for plugins which hook into the lifecycle of the form, such as pre-render or pre-process plugins.interface
Interface for a data source plugin.interface
Interface for plugins to add additional resources (CSS or JavaScript) to the form designer.interface
Interface for plugins that may add a set of form items to the designer.interface
A plugin that lets you add additional properties to existing form elements, which can be configured in the form designer.interface
Interface for plugins that wish to provide custom template for the form designer.interface
Mixin that implements the methods ofIPluginFormElementTemplate
with defaults for static form element template plugins, when you have all templates stored as resources in the plugin's class path (i.e.interface
Interface for plugins to integrate own form element widgets within the form designer.interface
Interface for form pre-persist plugins.interface
Interface for a form pre-process plugin.interface
Interface for form pre-render plugins.interface
Interface for a form pre-respond plugin.interface
Deprecated.This plugin type was never called and will never have any function.interface
Plugins that allows the form render process to be customized.interface
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 -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.mail
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.mailModifier and TypeInterfaceDescriptioninterface
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.monitoringModifier and TypeInterfaceDescriptioninterface
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.portalModifier and TypeInterfaceDescriptioninterface
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.projectModifier and TypeInterfaceDescriptioninterface
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.replacerModifier and TypeInterfaceDescriptioninterface
Interface for a form replacer plugin.interface
Interface for a system replacer plugin.interface
Interface for a system replacer plugin.interface
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.scanModifier and TypeInterfaceDescriptioninterface
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 -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.servlet
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.servletModifier and TypeInterfaceDescriptioninterface
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.userModifier and TypeInterfaceDescriptioninterface
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.validationModifier and TypeInterfaceDescriptioninterface
Interface for validation rule plugins. -
Uses of IFCPlugin in de.xima.fc.plugin.interfaces.workflow
Subinterfaces of IFCPlugin in de.xima.fc.plugin.interfaces.workflowModifier and TypeInterfaceDescriptioninterface
Deprecated.You should use the new workflow engine.interface
interface
Interface for workflow node plugins.interface
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 IFCPluginModifier and TypeInterfaceDescriptioninterface
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 IFCPluginModifier and TypeMethodDescriptionstatic <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 IFCPluginModifier and TypeMethodDescriptionstatic 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 IFCPluginModifier and TypeMethodDescriptionstatic 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 IFCPluginModifier and TypeMethodDescription<T extends IFCPlugin>
TPluginRuntime.getPluginByName
(String name, Class<T> pluginType) Gets the plugin with the given name, if it exists.PluginRuntime.getPluginsOfType
(Class<T> clazz) Methods in de.xima.fc.plugin.runtime that return types with arguments of type IFCPluginModifier and TypeMethodDescriptionPluginRuntime.getAllPlugins()
PluginRuntime.getUnregisteredPlugins()
Methods in de.xima.fc.plugin.runtime with parameters of type IFCPluginModifier and TypeMethodDescriptionvoid
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 IFCPluginModifier and TypeMethodDescriptionvoid
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).boolean
PluginRuntime.isHasPluginsOfType
(Class<? extends IFCPlugin> pluginType) Checks if this runtime has any plugins of the given type.Constructor parameters in de.xima.fc.plugin.runtime with type arguments of type IFCPluginModifierConstructorDescriptionPluginRuntime
(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 IFCPluginModifier and TypeInterfaceDescriptioninterface
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.servlet.resource
Subinterfaces of IFCPlugin in de.xima.fc.servlet.resourceModifier and TypeInterfaceDescriptioninterface
Mixin forIPluginServletAction
that provides a basic implementation for a servlet action that provides static resources.Classes in de.xima.fc.servlet.resource that implement IFCPluginModifier and TypeClassDescriptionclass
Base class forIPluginServletAction
which provides a basic implementation for a servlet action that provides static resources. -
Uses of IFCPlugin in de.xima.fc.workflow.mixin
Subinterfaces of IFCPlugin in de.xima.fc.workflow.mixinModifier and TypeInterfaceDescriptioninterface
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 IFCPluginModifier and TypeClassDescriptionclass
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.