Package de.xima.fc.handler.interfaces.system

Interface IPluginHandler

All Superinterfaces:

IAPIHandler, Serializable

All Known Implementing Classes:

PluginHandler

public interface IPluginHandler
extends IAPIHandler

Method Summary

Modifier and Type	Method	Description
void	deactivatePlugin(UserContext uc, String runtimeKey, String scopeKey)
IPluginDataSourceRetVal	executeDatenquelle(UserContext uc, String datasourceName, Mandant mandant, IPluginDataSourceParams params)
Map<String,IPluginFormPrePersistRetVal>	executeFormPrePersistPlugins(UserContext uc, Mandant mandant, IPluginFormPrePersistParams params)
Map<String,IPluginFormPreProcessRetVal>	executeFormPreProcessPlugins(UserContext uc, Mandant mandant, IPluginFormPreProcessParams params)
Map<String,IPluginFormPreRenderRetVal>	executeFormPreRenderPlugins(UserContext uc, Mandant mandant, IPluginFormPreRenderParams params)
Map<String,IPluginFormPreRespondRetVal>	executeFormPreRespondPlugins(UserContext uc, Mandant mandant, IPluginFormPreRespondParams params)
IPluginGenericRetVal	executeGenericPlugin(UserContext uc, String pluginName, Mandant mandant, IPluginGenericParams params)
IPluginServletActionRetVal	executeServletActionPlugin(UserContext uc, String pluginName, Mandant mandant, IPluginServletActionParams params)
XFormDatatypeValidationLogicRetVal	executeValidationLogic(Mandant tenant, XFormDatatypeValidationLogicParams params)	Executes the custom validation logic for a given validation rule.
byte[]	getConfigFileData(UserContext uc, PluginSyncData pluginEntity)
Map<String,IPluginFormElementCatalogue>	getFormElementCataloguePlugins(UserContext uc, Mandant mandant, Locale locale)
Map<String,IPluginFormElementWidget>	getFormElementWidgetPlugins(UserContext uc, Mandant mandant, Locale locale)
byte[]	getJarFileData(UserContext uc, PluginSyncData pluginEntity)
IFormResource	getPluginFormResource(UserContext uc, Integer clientID, String pluginName)	Deprecated. Use getPluginFormResource(UserContext, Integer, String, IPluginFormResourceGetDataParams).
IFormResource	getPluginFormResource(UserContext uc, Integer clientID, String pluginName, IPluginFormResourceGetDataParams params)	Deprecated. Use getPluginFormResource(UserContext, Long, String, String, IPluginFormResourceGetDataParams).
IFormResource	getPluginFormResource(UserContext uc, Long clientId, String pluginKey, String pluginName, IPluginFormResourceGetDataParams params)	Deprecated. Use getPluginFormResource(UserContext, Long, String, String, String, IPluginFormResourceGetDataParams).
IFormResource	getPluginFormResource(UserContext uc, Long clientId, String pluginKey, String pluginFileKey, String pluginName, IPluginFormResourceGetDataParams params)
IFormResource	getPluginFormResource(UserContext uc, UUID clientUuid, String pluginKey, String pluginName, IPluginFormResourceGetDataParams params)	Deprecated. Use getPluginFormResource(UserContext, UUID, String, String, String, IPluginFormResourceGetDataParams).
IFormResource	getPluginFormResource(UserContext uc, UUID clientUuid, String pluginKey, String pluginFileKey, String pluginName, IPluginFormResourceGetDataParams params)
Map<EPluginScope,Set<String>>	getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)	Deprecated.
Set<String>	getPluginNames(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
List<PluginSyncData>	getPluginSyncData(UserContext uc, boolean isFrontendServer)
Map<String,IPluginVRuleModel>	getValidationRulePlugins(Mandant mandant, Locale locale)

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Method Detail

executeFormPreRenderPlugins

Map<String,IPluginFormPreRenderRetVal> executeFormPreRenderPlugins(UserContext uc,
                                                                         Mandant mandant,
                                                                         IPluginFormPreRenderParams params)

executeFormPrePersistPlugins

Map<String,IPluginFormPrePersistRetVal> executeFormPrePersistPlugins(UserContext uc,
                                                                           Mandant mandant,
                                                                           IPluginFormPrePersistParams params)

executeFormPreProcessPlugins

Map<String,IPluginFormPreProcessRetVal> executeFormPreProcessPlugins(UserContext uc,
                                                                           Mandant mandant,
                                                                           IPluginFormPreProcessParams params)

executeFormPreRespondPlugins

Map<String,IPluginFormPreRespondRetVal> executeFormPreRespondPlugins(UserContext uc,
                                                                           Mandant mandant,
                                                                           IPluginFormPreRespondParams params)

executeServletActionPlugin

IPluginServletActionRetVal executeServletActionPlugin(UserContext uc,
                                                      String pluginName,
                                                      Mandant mandant,
                                                      IPluginServletActionParams params)

executeGenericPlugin

IPluginGenericRetVal executeGenericPlugin(UserContext uc,
                                          String pluginName,
                                          Mandant mandant,
                                          IPluginGenericParams params)

executeDatenquelle

IPluginDataSourceRetVal executeDatenquelle(UserContext uc,
                                           String datasourceName,
                                           Mandant mandant,
                                           IPluginDataSourceParams params)

getPluginNames

Set<String> getPluginNames(UserContext uc,
                           Mandant mandant,
                           Class<? extends IFCPlugin> type)

getPluginNameMap

@Deprecated
Map<EPluginScope,Set<String>> getPluginNameMap(UserContext uc,
                                                     Mandant mandant,
                                                     Class<? extends IFCPlugin> type)

Deprecated.

getValidationRulePlugins

Map<String,IPluginVRuleModel> getValidationRulePlugins(Mandant mandant,
                                                             Locale locale)

getPluginFormResource

@Deprecated
IFormResource getPluginFormResource(UserContext uc,
                                    Integer clientID,
                                    String pluginName)

Deprecated.

Use getPluginFormResource(UserContext, Integer, String, IPluginFormResourceGetDataParams).

Parameters:

uc - Current user context with the user, may be anonymous.

clientID - ID of the client.

pluginName - Name of the resource plugin.

Returns:

The form resource from the form resource plugin.

getPluginFormResource

@Deprecated(since="8.3.0")
IFormResource getPluginFormResource(UserContext uc,
                                    Integer clientID,
                                    String pluginName,
                                    IPluginFormResourceGetDataParams params)

Deprecated.

Use getPluginFormResource(UserContext, Long, String, String, IPluginFormResourceGetDataParams).

Parameters:

uc - Current user context with the user, may be anonymous.

clientID - ID of the client.

pluginName - Name of the resource plugin.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

getPluginFormResource

IFormResource getPluginFormResource(UserContext uc,
                                    Long clientId,
                                    String pluginKey,
                                    String pluginFileKey,
                                    String pluginName,
                                    IPluginFormResourceGetDataParams params)

Parameters:

uc - Current user context with the user, may be anonymous.

clientId - ID of the client.

pluginKey - Key of the plugin. This is the Plugin-Key entry of the plugin's manifest. Pass null to search for a plugin with the given name from any installed plugin JAR.

pluginFileKey - File key of the plugin. This is the Plugin-File-Key entry of the plugin's manifest. Pass null if the plugin does not have a file key.

pluginName - Name of the resource plugin.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

Since:

8.5.4

getPluginFormResource

@Deprecated
IFormResource getPluginFormResource(UserContext uc,
                                    Long clientId,
                                    String pluginKey,
                                    String pluginName,
                                    IPluginFormResourceGetDataParams params)

Deprecated.

Use getPluginFormResource(UserContext, Long, String, String, String, IPluginFormResourceGetDataParams).

Parameters:

uc - Current user context with the user, may be anonymous.

clientId - ID of the client.

pluginKey - Key of the plugin. This is the Plugin-Key entry of the plugin's manifest. Pass null to search for a plugin with the given name from any installed plugin JAR.

pluginName - Name of the resource plugin.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

getPluginFormResource

IFormResource getPluginFormResource(UserContext uc,
                                    UUID clientUuid,
                                    String pluginKey,
                                    String pluginFileKey,
                                    String pluginName,
                                    IPluginFormResourceGetDataParams params)

Parameters:

uc - Current user context with the user, may be anonymous.

clientUuid - UUID of the client.

pluginKey - Key of the plugin. This is the Plugin-Key entry of the plugin's manifest. Pass null to search for a plugin with the given name from any installed plugin JAR.

pluginFileKey - File key of the plugin. This is the Plugin-File-Key entry of the plugin's manifest. Pass null if the plugin does not have a file key.

pluginName - Name of the resource plugin.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

Since:

8.5.4

getPluginFormResource

@Deprecated
IFormResource getPluginFormResource(UserContext uc,
                                    UUID clientUuid,
                                    String pluginKey,
                                    String pluginName,
                                    IPluginFormResourceGetDataParams params)

Deprecated.

Use getPluginFormResource(UserContext, UUID, String, String, String, IPluginFormResourceGetDataParams).

Parameters:

uc - Current user context with the user, may be anonymous.

clientUuid - UUID of the client.

pluginKey - Key of the plugin. This is the Plugin-Key entry of the plugin's manifest. Pass null to search for a plugin with the given name from any installed plugin JAR.

pluginName - Name of the resource plugin.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

getFormElementCataloguePlugins

Map<String,IPluginFormElementCatalogue> getFormElementCataloguePlugins(UserContext uc,
                                                                             Mandant mandant,
                                                                             Locale locale)

getFormElementWidgetPlugins

Map<String,IPluginFormElementWidget> getFormElementWidgetPlugins(UserContext uc,
                                                                       Mandant mandant,
                                                                       Locale locale)

getPluginSyncData

List<PluginSyncData> getPluginSyncData(UserContext uc,
                                       boolean isFrontendServer)

getJarFileData

byte[] getJarFileData(UserContext uc,
                      PluginSyncData pluginEntity)

getConfigFileData

byte[] getConfigFileData(UserContext uc,
                         PluginSyncData pluginEntity)

deactivatePlugin

void deactivatePlugin(UserContext uc,
                      String runtimeKey,
                      String scopeKey)

executeValidationLogic

XFormDatatypeValidationLogicRetVal executeValidationLogic(Mandant tenant,
                                                          XFormDatatypeValidationLogicParams params)

Executes the custom validation logic for a given validation rule. If the rule does not have custom validation logic, this method always returns a valid validation result.

Parameters:

tenant - The tenant scope where to look for validation plugins.

params - The parameters for the validation logic, containing the value to validate and the validation rule to apply.

Returns:

The result of the validation logic, indicating whether the value is valid and providing an error message if it is not valid.

Since:

8.5.4