Package de.xima.fc.api.system

Class PluginAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.PluginAPI

public class PluginAPI
extends ASubAPI

Constructor Summary

Constructors

Constructor	Description
PluginAPI()

Method Summary

Modifier and Type	Method	Description
void	deactivatePlugin(UserContext uc, String runtimeKey, String scopeKey)	Marks the given plugin as deactivated in the database.
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,IPluginFormElementWidget>	getFormElementWidgetPlugins(UserContext uc, Mandant client, Locale locale)
byte[]	getJarFileData(UserContext uc, PluginSyncData pluginEntity)
byte[]	getPluginFormResource(UserContext uc, Integer clientId, String pluginName, String resourceName, String cacheKey)	Deprecated. Use getPluginFormResource(UserContext, Integer, String, String, String, IPluginFormResourceGetDataParams).
byte[]	getPluginFormResource(UserContext uc, Integer clientId, String pluginName, String resourceName, String cacheKey, IPluginFormResourceGetDataParams params)
Map<EPluginScope,Set<String>>	getPluginNameMap(UserContext uc, Mandant client, EPluginTypes type)	Deprecated. use getPluginNameMap(UserContext, Mandant, Class)
Map<EPluginScope,Set<String>>	getPluginNameMap(UserContext uc, Mandant client, Class<? extends IFCPlugin> type)	Deprecated.
Set<String>	getPluginNames(UserContext uc, Mandant client, EPluginTypes type)	Deprecated. use getPluginNames(UserContext, Mandant, Class)
Set<String>	getPluginNames(UserContext uc, Mandant client, Class<? extends IFCPlugin> type)	Method for determining plugin names.
List<PluginSyncData>	getPluginSyncData(UserContext uc, boolean isFrontendServer)
Map<String,IPluginVRuleModel>	getValidationRulePlugins(Mandant client, Locale locale)

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Details

PluginAPI

public PluginAPI()

Method Details

executeFormPreRenderPlugins

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

executeFormPrePersistPlugins

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

executeFormPreProcessPlugins

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

executeFormPreRespondPlugins

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

executeGenericPlugin

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

executeServletActionPlugin

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

executeDatenquelle

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

deactivatePlugin

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

Marks the given plugin as deactivated in the database. Please note that this does not deactivate the plugin runtime on the current server, this may need to be done separately via the PluginManager.

Parameters:

uc - The current user context for accessing the database.

runtimeKey - The PluginSyncData.getRuntimeKey() of the plugin.

scopeKey - The PluginSyncData.getScopeyKey() of the plugin.

getPluginNames

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

Method for determining plugin names.

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose plugins are searched for.

type - IFCPlugin of the plugin.

Returns:

Set of plugin names which were found.

getPluginNameMap

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

Deprecated.

Method for determining the plugins in a client.

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose plugins are searched for.

type - IFCPlugin of the plugin.

Returns:

Map of the plugins with the corresponding EPluginScope.

getValidationRulePlugins

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

getFormElementWidgetPlugins

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

getPluginFormResource

@Deprecated
public byte[] getPluginFormResource(UserContext uc,
 Integer clientId,
 String pluginName,
 String resourceName,
 String cacheKey)

Deprecated.

Use getPluginFormResource(UserContext, Integer, String, 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.

resourceName - Name of the resource, e.g. the name as it will appear in the URL.

cacheKey - Key for caching the resource in the browser.

Returns:

The form resource from the form resource plugin.

getPluginFormResource

public byte[] getPluginFormResource(UserContext uc,
 Integer clientId,
 String pluginName,
 String resourceName,
 String cacheKey,
 IPluginFormResourceGetDataParams params)

Parameters:

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

clientId - ID of the client.

pluginName - Name of the resource plugin.

resourceName - Name of the resource, e.g. the name as it will appear in the URL.

cacheKey - Key for caching the resource in the browser.

params - Parameters for the plugin.

Returns:

The form resource from the form resource plugin.

getPluginNames

@Deprecated
public Set<String> getPluginNames(UserContext uc,
 Mandant client,
 EPluginTypes type)

Deprecated.

use getPluginNames(UserContext, Mandant, Class)

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose plugins are searched for.

type - IFCPlugin of the plugin.

Returns:

Set of plugin names which were found.

getPluginNameMap

@Deprecated
public Map<EPluginScope,Set<String>> getPluginNameMap(UserContext uc,
 Mandant client,
 EPluginTypes type)

Deprecated.

use getPluginNameMap(UserContext, Mandant, Class)

Parameters:

uc - UserContext the user context in which the action is to be performed.

client - Mandant whose plugins are searched for.

type - IFCPlugin of the plugin.

Returns:

Map of the plugins with the corresponding EPluginScope.

getPluginSyncData

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

getJarFileData

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

getConfigFileData

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