Class PluginHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.system.PluginHandler

All Implemented Interfaces:

IAPIHandler, IPluginHandler, Serializable

public class PluginHandler
extends AMSApiHandler
implements IPluginHandler

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginHandler()

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 pluginData)
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 pluginData)
IFormResource	getPluginFormResource(UserContext uc, Integer clientId, String pluginName)
IFormResource	getPluginFormResource(UserContext uc, Integer clientId, String pluginName, IPluginFormResourceGetDataParams params)	Deprecated.
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 class AMSApiHandler

getName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IAPIHandler

getName

Constructor Details

PluginHandler

public PluginHandler()

Method Details

executeFormPreRenderPlugins

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

Specified by:

executeFormPreRenderPlugins in interface IPluginHandler

executeFormPrePersistPlugins

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

Specified by:

executeFormPrePersistPlugins in interface IPluginHandler

executeFormPreProcessPlugins

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

Specified by:

executeFormPreProcessPlugins in interface IPluginHandler

executeFormPreRespondPlugins

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

Specified by:

executeFormPreRespondPlugins in interface IPluginHandler

executeGenericPlugin

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

Specified by:

executeGenericPlugin in interface IPluginHandler

executeServletActionPlugin

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

Specified by:

executeServletActionPlugin in interface IPluginHandler

executeDatenquelle

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

Specified by:

executeDatenquelle in interface IPluginHandler

getPluginNames

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

Specified by:

getPluginNames in interface IPluginHandler

getPluginNameMap

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

Specified by:

getPluginNameMap in interface IPluginHandler

getValidationRulePlugins

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

Specified by:

getValidationRulePlugins in interface IPluginHandler

getFormElementCataloguePlugins

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

Specified by:

getFormElementCataloguePlugins in interface IPluginHandler

getFormElementWidgetPlugins

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

Specified by:

getFormElementWidgetPlugins in interface IPluginHandler

deactivatePlugin

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

Specified by:

deactivatePlugin in interface IPluginHandler

getPluginFormResource

public IFormResource getPluginFormResource(UserContext uc,
 Integer clientId,
 String pluginName)

Specified by:

getPluginFormResource in interface IPluginHandler

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
public IFormResource getPluginFormResource(UserContext uc,
 Integer clientId,
 String pluginName,
 IPluginFormResourceGetDataParams params)

Deprecated.

Specified by:

getPluginFormResource in interface IPluginHandler

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

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

Specified by:

getPluginFormResource in interface IPluginHandler

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

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

Specified by:

getPluginFormResource in interface IPluginHandler

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.

getPluginSyncData

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

Specified by:

getPluginSyncData in interface IPluginHandler

getJarFileData

public byte[] getJarFileData(UserContext uc,
 PluginSyncData pluginData)

Specified by:

getJarFileData in interface IPluginHandler

getConfigFileData

public byte[] getConfigFileData(UserContext uc,
 PluginSyncData pluginData)

Specified by:

getConfigFileData in interface IPluginHandler