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)
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, for removal: This API element is subject to removal in a future version. Use getPluginFormResource(UserContext, Long, String, String, IPluginFormResourceGetDataParams).
IFormResource	getPluginFormResource(UserContext uc, Long clientId, String pluginKey, String pluginName, IPluginFormResourceGetDataParams params)
IFormResource	getPluginFormResource(UserContext uc, UUID clientUuid, String pluginKey, String pluginName, IPluginFormResourceGetDataParams params)
Map<EPluginScope, Set<String>>	getPluginNameMap(UserContext uc, Mandant mandant, Class<? extends IFCPlugin> type)
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 IAPIHandler

getName

Method Details

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

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

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(forRemoval=true,
            since="8.3.0")
IFormResource getPluginFormResource(UserContext uc,
 Integer clientID,
 String pluginName,
 IPluginFormResourceGetDataParams params)

Deprecated, for removal: This API element is subject to removal in a future version.

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 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.

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 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.

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)