Uses of Class
de.xima.fc.plugin.runtime.PluginRuntime

Packages that use PluginRuntime

Package	Description
de.xima.fc.gui.bean.plugin
de.xima.fc.gui.model
de.xima.fc.logic.etag
de.xima.fc.logic.form_theme
de.xima.fc.plugin
de.xima.fc.plugin.entities
de.xima.fc.plugin.event
de.xima.fc.plugin.helper
de.xima.fc.plugin.lifecycle
de.xima.fc.portal
de.xima.fc.portal.runtime
de.xima.fc.proma.util

Uses of PluginRuntime in de.xima.fc.gui.bean.plugin

Methods in de.xima.fc.gui.bean.plugin that return types with arguments of type PluginRuntime

Modifier and Type	Method	Description
protected abstract Set<PluginRuntime>	BasicPluginBean.getAllPluginRuntimes()
protected Set<PluginRuntime>	ClientPluginBean.getAllPluginRuntimes()
protected Set<PluginRuntime>	SystemPluginBean.getAllPluginRuntimes()

Methods in de.xima.fc.gui.bean.plugin with parameters of type PluginRuntime

Modifier and Type	Method	Description
protected Collection<PluginDependencies>	BasicPluginBean.checkFormThemeReferences(PluginRuntime runtime)
protected Collection<PluginDependencies>	BasicPluginBean.checkPromptReferences(PluginRuntime runtime)
abstract List<PluginDependencies>	BasicPluginBean.createPluginDependencies(PluginRuntime runtime)	This method creates a list of plugin dependencies.
List<PluginDependencies>	ClientPluginBean.createPluginDependencies(PluginRuntime runtime)
List<PluginDependencies>	SystemPluginBean.createPluginDependencies(PluginRuntime runtime)

Uses of PluginRuntime in de.xima.fc.gui.model

Methods in de.xima.fc.gui.model that return PluginRuntime

Modifier and Type	Method	Description
PluginRuntime	PluginWrapperModel.getPluginRuntime()
PluginRuntime	PluginWrapperModel.getTempRuntime()

Methods in de.xima.fc.gui.model with parameters of type PluginRuntime

Modifier and Type	Method	Description
void	PluginWrapperModel.setTempRuntime(PluginRuntime tempRuntime)

Constructors in de.xima.fc.gui.model with parameters of type PluginRuntime

Modifier	Constructor	Description
	PluginWrapperModel(Locale locale, PluginRuntime pluginRuntime, IGenericDao<E> dao)	Creates a new plugin wrapper for a given plugin runtime and database access object.

Uses of PluginRuntime in de.xima.fc.logic.etag

Methods in de.xima.fc.logic.etag with parameters of type PluginRuntime

Modifier and Type	Method	Description
static String	ETagFactory.eTagForPluginRuntime(PluginRuntime runtime)	Creates an ETag part for a plugin runtime.

Uses of PluginRuntime in de.xima.fc.logic.form_theme

Methods in de.xima.fc.logic.form_theme with parameters of type PluginRuntime

Modifier and Type	Method	Description
static FormThemeUsages	FormThemeManager.findFormThemeUsages(IEntityContext ec, Mandant client, PluginRuntime runtime)	Finds all locations where any theme from the given form theme plugin is still used.

Uses of PluginRuntime in de.xima.fc.plugin

Methods in de.xima.fc.plugin that return PluginRuntime

Modifier and Type	Method	Description
static PluginRuntime	PluginManager.getPluginRuntime(IFCPlugin targetPlugin)	Gets the runtime of the given plugin.
static PluginRuntime	PluginManager.getPluginRuntime(String scopeKey, String runtimeKey)	Gets the plugin runtime with the given ID (scope key, runtime key).
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(Mandant client, PluginId pluginId)	Gets the plugin runtime for the plugin bundle with the given plugin key.
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(Mandant client, String pluginKey)	Deprecated. Use PluginManager.getPluginRuntimeByPluginKey(Mandant, String, String).
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(Mandant client, String pluginKey, String fileKey)	Gets the plugin runtime for the plugin bundle with the given plugin key.
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(UUID clientUuid, PluginId pluginId)	Gets the plugin runtime for the plugin bundle with the given plugin key and file key.
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(UUID clientUuid, String pluginKey)	Deprecated. Use PluginManager.getPluginRuntimeByPluginKey(UUID, String, String).
static PluginRuntime	PluginManager.getPluginRuntimeByPluginKey(UUID clientUuid, String pluginKey, String fileKey)	Gets the plugin runtime for the plugin bundle with the given plugin key and file key.
static PluginRuntime	PluginManager.initClientPlugin(File pluginJar, Mandant man)	Deprecated.
static PluginRuntime	PluginManager.initSystemPlugin(File pluginJar)	Deprecated.
static <T extends IFCPlugin> PluginRuntime	PluginManager.registerClientPlugin(Mandant man, Class<T> clazz, String runtimeKey)	Method to register a plugin-class in scope of the given client
static PluginRuntime	PluginManager.registerSystemPlugin(Class<? extends IFCPlugin> clazz, String runtimeKey)	Method to register a plugin-class in system-scope

Methods in de.xima.fc.plugin that return types with arguments of type PluginRuntime

Modifier and Type	Method	Description
static Closable<PluginRuntime>	PluginHelper.createTempRuntime(IThrowingSupplier<InputStream> data, String name, String scopeKey, String runtimeKey, boolean instantiate)	Creates a temporary runtime that can be used e.g. for validation.
static Closable<PluginRuntime>	PluginHelper.createTempRuntime(InputStream input, String name, String scopeKey, String runtimeKey, boolean instantiate)	Creates a temporary runtime that can be used e.g. for validation.
static Closable<PluginRuntime>	PluginHelper.createTempRuntime(Path jarFile, String name, String scopeKey, String runtimeKey, boolean instantiate)	Creates a temporary runtime that can be used e.g. for validation.
static List<PluginRuntime>	PluginManager.getAllPluginRuntimes()
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)
static Set<PluginRuntime>	PluginManager.getClientPlugins(Mandant client)	Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
static Set<PluginRuntime>	PluginManager.getClientPlugins(UUID clientUuid)	Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
static <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 List<PluginRuntime>	PluginManager.getMandantPlugins(Mandant man)	Deprecated. use PluginManager.getClientPlugins(Mandant)
static org.apache.commons.lang3.tuple.Pair<PluginRuntime, IPluginAuthenticatorType>	PluginManager.getPluginAuthenticatorTypeWithRuntime(IAuthenticator<?> authenticator)
static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>	PluginManager.getPluginByClassAndNameWithRuntime(UUID clientUuid, Class<T> clazz, String pluginName)
static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>	PluginManager.getPluginByNameWithRuntime(Mandant man, Class<T> clazz, String pluginName)
static <Plugin extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, Plugin>	PluginManager.getPluginWithRuntime(String scopeKey, String runtimeKey, String pluginName, Class<Plugin> pluginClass)	Gets the plugin with the given ID (scope key, runtime key, plugin name), together with its runtime.
static Set<PluginRuntime>	PluginManager.getSystemPlugins()	Get a List of all PluginRuntimes registered in system-scope
static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>>	PluginManager.getSystemPluginsWithRuntime(Class<T> clazz)

Methods in de.xima.fc.plugin with parameters of type PluginRuntime

Modifier and Type	Method	Description
static <T extends IFCPlugin> boolean	PluginHelper.canPluginBeRegistered(PluginRuntime prtm, Class<T> pluginClass)
static byte[]	PluginHelper.createDefaultPluginConfig(PluginRuntime runtime)	Creates the default plugin configuration data for a given plugin runtime, suitable for IFileEntity.setNewData(byte[]).
static void	PluginHelper.createPluginErrorProtocolEntry(PluginRuntime pluginRuntime, DefaultPluginLifecycleData lifecycleData, Throwable error, boolean install, boolean initialize)
static void	PluginManager.deletePlugin(PluginRuntime runtime)	Deprecated.
static List<? extends Class<? extends IFCPlugin>>	PluginHelper.getAllPlugins(PluginRuntime pluginRuntime)
static File	PluginHelper.getPluginFolder(PluginRuntime runtime)	Deprecated.
static File	PluginHelper.getPluginJarFile(PluginRuntime rtm)	Deprecated.
static PluginManifest	PluginHelper.getPluginManifest(PluginRuntime pluginRuntime)	Reads the manifest from the JAR file of the given plugin runtime.
static File	PluginHelper.getPluginMetaFile(PluginRuntime rtm)	Deprecated.
static de.xima.cmn.props.FileBasedPropertiesConfiguration	PluginHelper.getPluginProperties(PluginRuntime rtm)	Deprecated.
static File	PluginHelper.getPluginPropertiesFile(PluginRuntime rtm)	Deprecated.
static <M extends IExtendedParameterModel> List<M>	PluginHelper.readParameterModels(PluginRuntime runtime, Locale locale, com.alibaba.fastjson.util.BiFunction<String,String,M> modelFactory)	Creates the parameter models for a plugin.
static <M extends IExtendedParameterModel> List<M>	PluginHelper.readParameterModels(PluginRuntime runtime, Properties persistedProperties, Locale locale, com.alibaba.fastjson.util.BiFunction<String,String,M> modelFactory)	Creates the parameter models for a plugin.
static <T extends IFCPlugin> T	PluginHelper.registerPlugin(boolean install, boolean initialize, PluginRuntime prtm, Class<T> clazz)
static <Plugin extends IFCPlugin> void	PluginManager.registerPlugin(boolean isInstall, PluginRuntime runtime, Class<Plugin> clazz)	Register a plugin to the given key and PluginRuntime
static <T extends IFCPlugin> void	PluginManager.registerPlugin(PluginRuntime runtime, Class<T> clazz)
static void	PluginManager.releaseMandantPlugin(Mandant man, PluginRuntime pluginMeta)	Deprecated. use PluginManager.releasePlugin(PluginRuntime)
static void	PluginManager.releasePlugin(boolean isUninstall, PluginRuntime runtime)
static void	PluginManager.releasePlugin(PluginRuntime runtime)
static void	PluginHelper.savePluginProperties(PluginRuntime rtm, Properties props)	Deprecated.
static boolean	PluginManager.scanAndRegisterMandantPlugin(Mandant man, PluginRuntime pluginMeta, byte[] jarData)	Deprecated. use PluginManager.initClientPlugin(File, Mandant)
static boolean	PluginManager.scanAndRegisterSystemPlugin(PluginRuntime pluginMeta, byte[] jarData)	Deprecated. use PluginManager.initSystemPlugin(File)
static List<IPluginInitializeValidationResult>	PluginHelper.validateConfiguration(PluginRuntime runtime, Locale locale)	Validates the configuration of the given plugin bundle against all available validation checks.
static List<IPluginInitializeValidationResult>	PluginHelper.validateConfiguration(PluginRuntime runtime, Properties properties, Locale locale)	Validates the configuration of the given plugin bundle against all available validation checks, using a specified set of saved plugin properties.
static List<IPluginInitializeValidationResult>	PluginHelper.validateConfigurationAgainstValidationCallback(PluginRuntime runtime, Locale locale)	Validates the configuration of the given plugin bundle via IFCPlugin#validateConfigurationData.
static List<IPluginInitializeValidationResult>	PluginHelper.validateConfigurationAgainstValidationCallback(PluginRuntime runtime, Properties properties, Locale locale)	Validates the configuration of the given plugin bundle via IFCPlugin#validateConfigurationData.

Uses of PluginRuntime in de.xima.fc.plugin.entities

Methods in de.xima.fc.plugin.entities that return PluginRuntime

Modifier and Type	Method	Description
PluginRuntime	EntitiesRuntime.getPluginRuntime()

Methods in de.xima.fc.plugin.entities with parameters of type PluginRuntime

Modifier and Type	Method	Description
static EntitiesRuntime	EntitiesRuntimeManager.getRuntime(PluginRuntime runtime)
static void	EntitiesRuntimeManager.initRuntime(PluginRuntime pluginRuntime, IPluginEntities plugin)
static void	EntitiesRuntimeManager.shutdownRuntime(PluginRuntime pluginRuntime)

Constructors in de.xima.fc.plugin.entities with parameters of type PluginRuntime

Modifier	Constructor	Description
	EntitiesRuntime(PluginRuntime pluginRuntime, IPluginEntities plugin)	Creates a new entities runtime with the given plugin.

Uses of PluginRuntime in de.xima.fc.plugin.event

Methods in de.xima.fc.plugin.event that return PluginRuntime

Modifier and Type	Method	Description
PluginRuntime	IPluginLifecycleEvent.runtime()	The runtime that contains the plugin being affected.
PluginRuntime	IPluginRuntimeRegisteredEvent.runtime()	The runtime that was registered.
PluginRuntime	IPluginRuntimeReleasedEvent.runtime()	The runtime that was released.

Uses of PluginRuntime in de.xima.fc.plugin.helper

Methods in de.xima.fc.plugin.helper with parameters of type PluginRuntime

Modifier and Type	Method	Description
static IPluginFileHelper	PluginFileHelper.createFacade(PluginRuntime runtime)	Creates a new plugin file helper that delegates to the given runtime.
static IPluginResourceHelper	PluginResourceHelper.createFacade(PluginRuntime runtime)
static void	PluginFileHelper.deletePluginFiles(PluginRuntime prtm)
static File	PluginFileHelper.getPluginFolder(PluginRuntime runtime)	The path to the folder with all plugin files, such as /tmp/formcycle/system/04ed.
static File	PluginFileHelper.getPluginJarFile(PluginRuntime runtime)	The path to the JAR file of the plugin, such as /tmp/formcycle/system/04ed/plugin.jar.
static File	PluginFileHelper.getPluginJarUnpackedDir(PluginRuntime runtime)	The base directory with all files from an unpacked JAR, such as /tmp/formcycle/system/04ed/plugin.
static File	PluginFileHelper.getPluginMetaFile(PluginRuntime rtm)
static de.xima.cmn.props.FileBasedPropertiesConfiguration	PluginPropertiesHelper.getPluginProperties(PluginRuntime rtm)
static File	PluginFileHelper.getPluginPropertiesFile(PluginRuntime rtm)
static String	PluginResourceHelper.i18n(PluginRuntime runtime, String resourceBundleName, Locale loc, String key)
static String	PluginResourceHelper.i18n(PluginRuntime runtime, String resourceBundleName, Locale loc, String key, Object... params)
static void	PluginPropertiesHelper.savePluginProperties(PluginRuntime rtm, Properties props)

Uses of PluginRuntime in de.xima.fc.plugin.lifecycle

Methods in de.xima.fc.plugin.lifecycle with parameters of type PluginRuntime

Modifier and Type	Method	Description
void	IPluginLifecycleListener.handleEvent(EPluginLifecycleEvent event, PluginRuntime pluginRuntime, TPlugin plugin)	The callback method that is invoked when the event occurred for which this listener was registered.

Constructors in de.xima.fc.plugin.lifecycle with parameters of type PluginRuntime

Modifier	Constructor	Description
	DefaultPluginLifecycleData(PluginRuntime runtime)
	DefaultPluginValidationData(PluginRuntime runtime, Properties properties, Locale locale)	Creates a new plugin validation data instance with the given data.

Uses of PluginRuntime in de.xima.fc.portal

Methods in de.xima.fc.portal with parameters of type PluginRuntime

Modifier and Type	Method	Description
static PortalRuntime	PortalManager.getPortal(PluginRuntime runtime)
static void	PortalManager.initPortal(PluginRuntime pluginRuntime, IPluginPortal plugin)

Uses of PluginRuntime in de.xima.fc.portal.runtime

Methods in de.xima.fc.portal.runtime that return PluginRuntime

Modifier and Type	Method	Description
PluginRuntime	PortalRuntime.getPluginRuntime()

Constructors in de.xima.fc.portal.runtime with parameters of type PluginRuntime

Modifier	Constructor	Description
	PortalRuntime(PluginRuntime portalRuntime, IPluginPortal plugin)	Creates a new runtime for a given portal plugin.

Uses of PluginRuntime in de.xima.fc.proma.util

Methods in de.xima.fc.proma.util with parameters of type PluginRuntime

Modifier and Type	Method	Description
static <R> StageChain<org.apache.commons.lang3.tuple.Pair<EPluginUpdateAvailability, String>, R>	PromaPluginUpdateCheck.fetchPluginUpdateStatus(IPublicPromaInvocationContext pc, String pluginKey, Locale locale, PluginManifest manifest, PluginRuntime runtime, String licenseKey)	This method retrieves the update status of the specified plugin.
static <R> StageChain<PluginUpdateMetadata, R>	PromaPluginUpdateCheck.getPluginMetadata(IPublicPromaInvocationContext pc, String pluginKey, Locale locale, PluginManifest manifest, PluginRuntime runtime, de.xima.proma.restclient.pub.gen.model.PublicStoreItemResource storeItem, String licenseKey)	This method returns a model class for caching the plugin meta data based on the plugin data passed.
static <R> StageChain<PluginUpdateMetadata, R>	PromaPluginUpdateCheck.getPluginMetadata(IPublicPromaInvocationContext pc, String pluginKey, Locale locale, PluginManifest manifest, PluginRuntime runtime, String licenseKey)	This method returns a model class for caching the plugin meta data based on the plugin data passed.