Class PluginManager

java.lang.Object
de.xima.fc.plugin.PluginManager
public class PluginManager extends Object
Class for managing plugins
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • PluginManager

      public PluginManager()

  • Method Details

    • createClientProtocolEntry

      public static void createClientProtocolEntry(UserContext uc, Mandant man, String protocolEntry, Object... params)
      Creates a client protocol entry
      Parameters:
      uc - UserContext with the user who uploaded the plugin.
      man - The client for which to create the protocol entry.
      protocolEntry - String protocol-text
      params - Objects parameters

    • createMandantProtocolEntry

      @Deprecated public static void createMandantProtocolEntry(IEntityContext ec, Mandant man, String protocolEntry, Object... params)
      Deprecated.
      use createClientProtocolEntry(UserContext, Mandant, String, Object...)
      Parameters:
      ec - Entity context for accessing the database.
      man - The client scope for which to create a protocol entry.
      protocolEntry - Protocol entry to create.
      params - Additional message params for the protocol message.

    • createSystemProtocolEntry

      public static void createSystemProtocolEntry(UserContext uc, String protocolEntry, Object... params)
      Creates a system protocol entry
      Parameters:
      uc - UserContext
      protocolEntry - String protocol-text
      params - Objects parameters

    • deletePlugin

      @Deprecated public static void deletePlugin(PluginRuntime runtime) throws IOException
      Deprecated.
      Throws:
      IOException

    • deletePlugin

      @Deprecated public static void deletePlugin(String scopeKey, String runtimeKey) throws IOException
      Deprecated.
      Throws:
      IOException

    • getAllPlugins

      public static <T extends IFCPlugin> Set<T> getAllPlugins(Mandant client, Class<T> pluginType)
      Get a set of plugins with the given interface registered in system-scope OR to the given client. (client-scope wins over system-scope)
      Parameters:
      client - Client scope for which to retrieve all plugins.
      pluginType - Type of the plugins to retrieve.
      Returns:
      All plugins from the given client (if any) and from the system scope. A client-scoped plugin overwrites a system-scoped plugin.

    • getAllPlugins

      public static <T extends IFCPlugin> Set<T> getAllPlugins(UUID clientUuid, Class<T> pluginType)
      Get a set of plugins with the given interface registered in system-scope OR to the given client. (client-scope wins over system-scope)
      Parameters:
      clientUuid - UUID of a client.
      pluginType - Type of the plugins to retrieve.
      Returns:
      All plugins from the given client (if any) and from the system scope. A client-scoped plugin overwrites a system-scoped plugin.

    • getAllPlugins

      @Deprecated public static Set<IFCPlugin> getAllPlugins(Mandant man, EPluginTypes type)
      Deprecated.
      user getAllPlugins(Mandant, Class)
      Parameters:
      man - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      Returns:
      A set of all matching plugins.

    • getAllPluginsWithRuntime

      public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>> getAllPluginsWithRuntime(Mandant man, Class<T> clazz)

    • getAllPluginsWithRuntime

      public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>> getAllPluginsWithRuntime(UUID clientUuid, Class<T> clazz)

    • getClientPlugins

      public static <T extends IFCPlugin> Set<T> getClientPlugins(Mandant client, Class<T> pluginType)
      Get a set of plugins with the given interfaces registered to the given client
      Parameters:
      client - The client-scope to use for retrieving client plugins, if any.
      pluginType - Type of the plugins to retrieve.
      Returns:
      All active plugins for the given client, if any (does not include systm plugins!)

    • getClientPlugins

      public static <T extends IFCPlugin> Set<T> getClientPlugins(UUID clientUuid, Class<T> pluginType)
      Get a set of plugins with the given interfaces registered to the given client
      Parameters:
      clientUuid - The client-scope to use for retrieving client plugins, if any.
      pluginType - Type of the plugins to retrieve.
      Returns:
      All active plugins for the given client, if any (does not include systm plugins!)

    • getClientPlugins

      public static Set<PluginRuntime> getClientPlugins(Mandant client)
      Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
      Parameters:
      client - A client for which to retrieve the plugins.
      Returns:
      A list of all plugin runtimes corresponding to the plugin installed for the given client

    • getClientPlugins

      public static Set<PluginRuntime> getClientPlugins(UUID clientUuid)
      Gets a list of all plugin runtimes registered to the given client (not including system plugins!)
      Parameters:
      clientUuid - UUID of a client.
      Returns:
      A list of all plugin runtimes corresponding to the plugin installed for the given client

    • getClientPluginsWithRuntime

      public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>> getClientPluginsWithRuntime(Mandant client, Class<T> clazz)

    • getClientPluginsWithRuntime

      public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>> getClientPluginsWithRuntime(UUID clientUuid, Class<T> clazz)

    • getMandantPluginByName

      @Deprecated public static IFCPlugin getMandantPluginByName(Mandant man, EPluginTypes type, String pluginName)
      Deprecated.
      will be removed!
      Parameters:
      man - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      pluginName - The name of the plugin to retrieve.
      Returns:
      The plugin or null when no plugin matches.

    • getMandantPluginJar

      @Deprecated public static File getMandantPluginJar(Mandant man, String jarName) throws IOException
      Deprecated.
      use PluginRuntime.getJarFile()
      Parameters:
      man - The client scope for which to register a plugin.
      jarName - Name of the JAR file for which to look for.
      Returns:
      Always null - this method is deprecated!
      Throws:
      IOException - Never thrown.

    • getMandantPlugins

      @Deprecated public static SortedSet<IFCPlugin> getMandantPlugins(Mandant man, EPluginTypes type)
      Deprecated.
      will be removed!
      Parameters:
      man - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      Returns:
      A set of all matching plugins.

    • getMandantPlugins

      @Deprecated public static List<PluginRuntime> getMandantPlugins(Mandant man)
      Deprecated.
      use getClientPlugins(Mandant)
      Parameters:
      man - The client for which to retrieve a plugin.
      Returns:
      A list of all matching plugins.

    • getPluginAuthenticatorType

      public static IPluginAuthenticatorType getPluginAuthenticatorType(IAuthenticator<?> authenticator)

    • getPluginAuthenticatorTypeWithRuntime

      public static org.apache.commons.lang3.tuple.Pair<PluginRuntime, IPluginAuthenticatorType> getPluginAuthenticatorTypeWithRuntime(IAuthenticator<?> authenticator)

    • getPluginByName

      public static <T extends IFCPlugin> T getPluginByName(Mandant man, Class<T> clazz, String pluginName)
      Get a plugin by name and IFCPlugin-interface from client- and system-scope
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      man - The client from which to retrieve the plugins.
      clazz - IFCPlugin-interface to search for
      pluginName - String name of the searched plugin
      Returns:
      IFCPlugin-instance or null if no plugin could be found

    • getPluginByName

      @Deprecated public static IFCPlugin getPluginByName(Mandant man, EPluginTypes type, String pluginName)
      Deprecated.
      Use getPluginByName(Mandant, Class, String)
      Parameters:
      man - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      pluginName - The name of the plugin to retrieve.
      Returns:
      The plugin or null when no matching plugin was found.

    • getPluginByNameWithRuntime

      public static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, T> getPluginByNameWithRuntime(Mandant man, Class<T> clazz, String pluginName)

    • getPluginRuntime

      public static PluginRuntime getPluginRuntime(IFCPlugin targetPlugin)
      Gets the runtime of the given plugin.
      Parameters:
      targetPlugin - The plugin for which to retrieve the runtime.
      Returns:
      The PluginRuntime of the plugin, or null if no runtime was found.

    • getPluginByClassAndNameWithRuntime

      public static <T extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, T> getPluginByClassAndNameWithRuntime(UUID clientUuid, Class<T> clazz, String pluginName)

    • getPluginByPluginKeyAndName

      @Deprecated public static <Plugin extends IFCPlugin> Plugin getPluginByPluginKeyAndName(Mandant client, String pluginKey, String pluginName, Class<Plugin> pluginClass)
      Deprecated.
      Use getPluginByPluginKeyAndName(Mandant, String, String, Class)
      Gets a plugin with a certain name from the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Type Parameters:
      Plugin - Type of the plugin to retrieve.
      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      pluginName - The name of the plugin to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      The plugin instance, or null if no matching plugin could be found.

    • getPluginByPluginKeyAndName

      public static <Plugin extends IFCPlugin> Plugin getPluginByPluginKeyAndName(Mandant client, PluginExtensionPointId extensionPointId, Class<Plugin> pluginClass)
      Gets a plugin with a certain name from the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Type Parameters:
      Plugin - Type of the plugin to retrieve.
      Parameters:
      client - The client for which to retrieve the plugin.
      extensionPointId - The ID of the IFCPlugin to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      The plugin instance, or null if no matching plugin could be found.

    • getPluginByPluginKeyAndName

      public static <Plugin extends IFCPlugin> Plugin getPluginByPluginKeyAndName(Mandant client, String pluginKey, String fileKey, String pluginName, Class<Plugin> pluginClass)
      Gets a plugin with a certain name from the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Type Parameters:
      Plugin - Type of the plugin to retrieve.
      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      fileKey - The plugin file key to search for. May be null or empty when the plugin consists of a single JAR file.
      pluginName - The name of the plugin to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      The plugin instance, or null if no matching plugin could be found.

    • getPluginNameMap

      @Deprecated public static Map<EPluginScope, Set<String>> getPluginNameMap(UserContext uc, Mandant mandant, EPluginTypes type)
      Deprecated.
      Parameters:
      uc - The current user context, this parameter is not used anymore.
      mandant - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      Returns:
      A map with all matching plugins.

    • getPluginNameMap

      @Deprecated public static <T extends IFCPlugin> Map<EPluginScope, Set<String>> getPluginNameMap(Mandant mandant, Class<T> clazz)
      Deprecated.
      Get a map of plugins by client, system and IFCPlugin-interface
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      mandant - Mandant
      clazz - IFCPlugin-interface
      Returns:
      Map of plugins

    • getPluginNames

      public static <T extends IFCPlugin> Set<String> getPluginNames(Mandant mandant, Class<T> clazz)
      Get a set of all plugin-names with the given IFCPlugin-interface and Mandant
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      mandant - Mandant
      clazz - IFCPlugin-interface
      Returns:
      Set of Strings

    • getPluginNames

      @Deprecated public static Set<String> getPluginNames(UserContext uc, Mandant mandant, EPluginTypes type)
      Deprecated.
      Parameters:
      uc - The current user context, this parameter is not used anymore.
      mandant - The client scope from which to retrieve plugins.
      type - The type of the plugins to retrieve.
      Returns:
      A set of all matching plugins.

    • getPluginRuntime

      public static PluginRuntime getPluginRuntime(String scopeKey, String runtimeKey)
      Gets the plugin runtime with the given ID (scope key, runtime key).
      Parameters:
      scopeKey - The scope key, either the UUID of a client or the system scope key.
      runtimeKey - The runtime key, which is the unique identifier of the plugin runtime within the scope.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPlugin

      public static IFCPlugin getPlugin(String scopeKey, String runtimeKey, String pluginName)
      Gets the plugin with the given ID (scope key, runtime key, plugin name).
      Parameters:
      scopeKey - The scope key, either the UUID of a client or the system scope key.
      runtimeKey - The runtime key, which is the unique identifier of the plugin runtime within the scope.
      pluginName - The name of the plugin to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getAllPluginRuntimes

      public static List<PluginRuntime> getAllPluginRuntimes()

    • getPlugin

      public static <Plugin extends IFCPlugin> Plugin getPlugin(String scopeKey, String runtimeKey, String pluginName, Class<Plugin> pluginClass)
      Gets the plugin with the given ID (scope key, runtime key, plugin name).
      Parameters:
      scopeKey - The scope key, either the UUID of a client or the system scope key.
      runtimeKey - The runtime key, which is the unique identifier of the plugin runtime within the scope.
      pluginName - The name of the plugin to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      The plugin, or null if no matching plugin could be found or is not of the expected type.

    • getPluginWithRuntime

      public static <Plugin extends IFCPlugin> org.apache.commons.lang3.tuple.Pair<PluginRuntime, Plugin> 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.
      Parameters:
      scopeKey - The scope key, either the UUID of a client or the system scope key.
      runtimeKey - The runtime key, which is the unique identifier of the plugin runtime within the scope.
      pluginName - The name of the plugin to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      The plugin with its runtime, or null if no matching plugin could be found or is not of the expected type.

    • getPluginRuntimeByPluginKey

      @Deprecated public static PluginRuntime getPluginRuntimeByPluginKey(Mandant client, String pluginKey)
      Deprecated.
      Use getPluginRuntimeByPluginKey(Mandant, String, String).
      Gets the plugin runtime for the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginRuntimeByPluginKey

      public static PluginRuntime getPluginRuntimeByPluginKey(Mandant client, PluginId pluginId)
      Gets the plugin runtime for the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      client - The client for which to retrieve the plugin.
      pluginId - The plugin ID to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginRuntimeByPluginKey

      public static PluginRuntime getPluginRuntimeByPluginKey(Mandant client, String pluginKey, String fileKey)
      Gets the plugin runtime for the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      fileKey - The file key to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginRuntimeByPluginKey

      @Deprecated public static PluginRuntime getPluginRuntimeByPluginKey(UUID clientUuid, String pluginKey)
      Deprecated.
      Use getPluginRuntimeByPluginKey(UUID, String, String).
      Gets the plugin runtime for the plugin bundle with the given plugin key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      clientUuid - The UUID of the client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginRuntimeByPluginKey

      public static PluginRuntime getPluginRuntimeByPluginKey(UUID clientUuid, PluginId pluginId)
      Gets the plugin runtime for the plugin bundle with the given plugin key and file key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      clientUuid - The UUID of the client for which to retrieve the plugin.
      pluginId - The ID of the plugin to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginRuntimeByPluginKey

      public static PluginRuntime getPluginRuntimeByPluginKey(UUID clientUuid, String pluginKey, String fileKey)
      Gets the plugin runtime for the plugin bundle with the given plugin key and file key.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. If the plugin consists of multiple JAR files, each JAR file must also specify a Plugin-File-Key that identifies it. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Parameters:
      clientUuid - The UUID of the client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      fileKey - The plugin file key to search for.
      Returns:
      The plugin runtime, or null if no matching plugin could be found.

    • getPluginsByPluginKey

      @Deprecated public static <Plugin extends IFCPlugin> Set<Plugin> getPluginsByPluginKey(Mandant client, String pluginKey, Class<Plugin> pluginClass)
      Deprecated.
      Use getPluginsByPluginKey(Mandant, String, String, Class)
      Gets all plugins from the plugin bundle with the given plugin key, limited to plugins of the given type.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Type Parameters:
      Plugin - Type of the plugin to retrieve.
      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      All plugin instances, or an empty set if no matching plugins could be found.

    • getPluginsByPluginKey

      public static <Plugin extends IFCPlugin> Set<Plugin> getPluginsByPluginKey(Mandant client, String pluginKey, String fileKey, Class<Plugin> pluginClass)
      Gets all plugins from the plugin bundle with the given plugin key, limited to plugins of the given type.

      A plugin bundle is a JAR file that contains one or more implementations of the IFCPlugin interface. Each bundle must specify a Plugin-Key in its manifest file, which uniquely identifies the plugin bundle amongst all available formcycle plugins. Each implementation of IFCPlugin has a name, which uniquely identifies that plugin within the bundle. In principle, different plugin bundles could contain plugins with the same name. The combination of the plugin key and the plugin name uniquely identifies a plugin.

      When a client is given, looks for plugins installed either in that client scope, or within the system scope. In case a plugin is found in both scopes, the client-scoped plugin is returned. When no client is given, only system-scoped plugins are searched.

      You may also specify the expected subtype of IFCPlugin. If you do, the plugin instance gets returned only if matches the given type. Use IFCPlugin.class to apply no restriction.

      Type Parameters:
      Plugin - Type of the plugin to retrieve.
      Parameters:
      client - The client for which to retrieve the plugin.
      pluginKey - The plugin key to search for.
      fileKey - The plugin file key to search for.
      pluginClass - The expected subtype of IFCPlugin to return.
      Returns:
      All plugin instances, or an empty set if no matching plugins could be found.

    • getRegisteredPlugins

      public static <T extends IFCPlugin> Set<T> getRegisteredPlugins(Class<T> clazz)
      Get a set with all registered plugins of the given IFCPlugin-interface
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      clazz - IFCPlugin-interfaces
      Returns:
      Set of IFCPlugin-instances

    • getSystemPluginByName

      public static <T extends IFCPlugin> T getSystemPluginByName(Class<T> clazz, String pluginName)
      Get a system-plugin by name, IFCPlugin-interface
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      clazz - IFCPlugin-interface to search for
      pluginName - String name of the searched plugin
      Returns:
      IFCPlugin-instance or null if no plugin could be found

    • getSystemPluginByName

      @Deprecated public static IFCPlugin getSystemPluginByName(EPluginTypes type, String pluginName)
      Deprecated.
      user getSystemPluginByName(Class, String)
      Parameters:
      type - The type of the plugins to retrieve.
      pluginName - The name of the plugin to retrieve.
      Returns:
      The plugin or null when no plugin matches.

    • getSystemPlugins

      public static <T extends IFCPlugin> Set<T> getSystemPlugins(Class<T> clazz)
      Get a set of plugins with the given interfaces registered in system-scope
      Type Parameters:
      T - Type of the plugins to retrieve.
      Parameters:
      clazz - IFCPlugin-interface
      Returns:
      Set of IFCPlugin-instances

    • getSystemPlugins

      public static Set<PluginRuntime> getSystemPlugins()
      Get a List of all PluginRuntimes registered in system-scope
      Returns:
      Set of PluginRuntimes

    • getSystemPlugins

      @Deprecated public static SortedSet<IFCPlugin> getSystemPlugins(EPluginTypes type)
      Deprecated.
      use getSystemPlugins(Class)
      Parameters:
      type - The type of the plugins to retrieve.
      Returns:
      A set of all matching plugins.

    • getSystemPluginsWithRuntime

      public static <T extends IFCPlugin> Set<org.apache.commons.lang3.tuple.Pair<PluginRuntime, T>> getSystemPluginsWithRuntime(Class<T> clazz)

    • initClientPlugin

      @Deprecated public static PluginRuntime initClientPlugin(File pluginJar, Mandant man) throws IOException, FCPluginException
      Deprecated.
      Throws:
      IOException
      FCPluginException

    • initPlugins

      public static void initPlugins()
      Initialize all plugins stored in the database

    • initSystemPlugin

      @Deprecated public static PluginRuntime initSystemPlugin(File pluginJar) throws IOException, FCPluginException
      Deprecated.
      Throws:
      IOException
      FCPluginException

    • install

      public static void install(IPluginEntity<?,?,?> pluginEntity) throws IOException, FCPluginException
      Throws:
      IOException
      FCPluginException

    • isHasAnyPluginsOfType

      public static boolean isHasAnyPluginsOfType(Mandant client, Class<? extends IFCPlugin> pluginType)
      Checks if any plugins of the given type exist.
      Parameters:
      client - Optional client scope. When given, the client and system scope is searched. Otherwise, only the system scope is searched.
      pluginType - Type of plugin to search for.
      Returns:
      Whether any plugins of the given type exist.

    • isPluginJar

      @Deprecated public static boolean isPluginJar(File file)
      Deprecated.

    • registerClientPlugin

      public static <T extends IFCPlugin> PluginRuntime registerClientPlugin(Mandant man, Class<T> clazz, String runtimeKey) throws FCPluginException
      Method to register a plugin-class in scope of the given client
      Type Parameters:
      T - Type of the plugin to register.
      Parameters:
      man - The client for which to register the plugin.
      clazz - The class of the plugin to register.
      runtimeKey - Runtime key (UUID) of the plugin to register.
      Returns:
      The newly created plugin runtime for the registered plugin.
      Throws:
      FCPluginException - When the plugin could not be registered.

    • registerMandantPlugin

      @Deprecated public static void registerMandantPlugin(Mandant man, EPluginTypes typ, Class<? extends IFCPlugin> clazz) throws FCPluginException
      Deprecated.
      use registerClientPlugin(Mandant, Class, String)
      Parameters:
      man - The client scope for which to register a plugin.
      typ - The type of the plugin to register.
      clazz - The class of the plugin to register.
      Throws:
      FCPluginException - When the plugin could not be registered or initialized.

    • registerPlugin

      public static <T extends IFCPlugin> void registerPlugin(PluginRuntime runtime, Class<T> clazz) throws FCPluginException
      Throws:
      FCPluginException

    • registerPlugin

      public static <Plugin extends IFCPlugin> void registerPlugin(boolean isInstall, PluginRuntime runtime, Class<Plugin> clazz) throws FCPluginException
      Register a plugin to the given key and PluginRuntime
      Type Parameters:
      Plugin - Type of the plugin to register.
      Parameters:
      isInstall - true if the plugin is installed for the first time, false if the plugin configuration is only updated.
      runtime - The runtime of the plugin to register.
      clazz - Class of the plugin to register.
      Throws:
      FCPluginException - When the plugin could not be registered.

    • registerSystemPlugin

      public static PluginRuntime registerSystemPlugin(Class<? extends IFCPlugin> clazz, String runtimeKey) throws FCPluginException
      Method to register a plugin-class in system-scope
      Parameters:
      clazz - IFCPlugin-class to register
      runtimeKey - Runtime key (UUID) of the plugin to register.
      Returns:
      The newly created plugin runtime for the registered plugin.
      Throws:
      FCPluginException - When the plugin could not be registered.

    • registerSystemPlugin

      @Deprecated public static void registerSystemPlugin(EPluginTypes typ, Class<? extends IFCPlugin> clazz) throws FCPluginException
      Deprecated.
      use registerSystemPlugin(Class, String)
      Parameters:
      typ - The type of the plugin to register.
      clazz - The class of the plugin to register.
      Throws:
      FCPluginException - When the plugin could not be registered or initialized.

    • releaseMandantPlugin

      @Deprecated public static void releaseMandantPlugin(Mandant man, PluginRuntime pluginMeta) throws IOException
      Deprecated.
      use releasePlugin(PluginRuntime)
      Parameters:
      man - The client scope for which to register a plugin.
      pluginMeta - Runtime of the plugin to release.
      Throws:
      IOException - When the plugin could not be released, such as due to a database error.

    • releasePlugin

      public static void releasePlugin(String scopeKey, String runtimeKey) throws IOException
      Throws:
      IOException

    • releasePlugin

      public static void releasePlugin(boolean isUninstall, String scopeKey, String runtimeKey) throws IOException
      Throws:
      IOException

    • releasePlugin

      public static void releasePlugin(PluginRuntime runtime) throws IOException
      Throws:
      IOException

    • releasePlugin

      public static void releasePlugin(boolean isUninstall, PluginRuntime runtime) throws IOException
      Throws:
      IOException

    • releasePlugins

      public static void releasePlugins()
      Releases all registered plugins

    • scanAndRegisterMandantPlugin

      @Deprecated public static boolean scanAndRegisterMandantPlugin(Mandant man, PluginRuntime pluginMeta, byte[] jarData)
      Deprecated.
      use initClientPlugin(File, Mandant)
      Parameters:
      man - The client for which to register a plugin.
      pluginMeta - Runtime of the plugin to register.
      jarData - Binary content of the JAR file to register.
      Returns:
      Always false - this method is deprecated!

    • scanAndRegisterSystemPlugin

      @Deprecated public static boolean scanAndRegisterSystemPlugin(PluginRuntime pluginMeta, byte[] jarData)
      Deprecated.
      use initSystemPlugin(File)
      Parameters:
      pluginMeta - Runtime of the plugin to register.
      jarData - Binary content of the JAR file to register.
      Returns:
      Always false - this method is deprecated!

    • scanForAllPlugins

      @Deprecated public static void scanForAllPlugins()
      Deprecated.
      use initPlugins()

    • synchronizePlugin

      public static void synchronizePlugin(boolean isInstall, PluginSyncData pluginData) throws IOException, FCPluginException
      Throws:
      IOException
      FCPluginException

    • uninstallPlugin

      public static void uninstallPlugin(String scopeKey, String runtimeKey) throws IOException
      Parameters:
      scopeKey - the plugin scope key
      runtimeKey - the plugin runtime key
      Throws:
      IOException - on errors while uninstall