Package org.laxture.sbp

Class SpringBootPluginManager

  • All Implemented Interfaces:
    org.pf4j.PluginManager, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
    public class SpringBootPluginManager
extends org.pf4j.DefaultPluginManager
implements org.springframework.context.ApplicationContextAware
    PluginManager to hold the main ApplicationContext

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.Map<java.lang.String,​java.lang.Object> presetProperties  

      • Fields inherited from class org.pf4j.DefaultPluginManager

        PLUGINS_DIR_CONFIG_PROPERTY_NAME

      • Fields inherited from class org.pf4j.AbstractPluginManager

        DEFAULT_PLUGINS_DIR, dependencyResolver, DEVELOPMENT_PLUGINS_DIR, exactVersionAllowed, extensionFactory, extensionFinder, MODE_PROPERTY_NAME, pluginClassLoaders, pluginDescriptorFinder, pluginFactory, pluginLoader, plugins, PLUGINS_DIR_PROPERTY_NAME, pluginsRoots, pluginStateListeners, pluginStatusProvider, resolvedPlugins, runtimeMode, startedPlugins, systemVersion, unresolvedPlugins, versionManager

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.pf4j.ExtensionFactory createExtensionFactory()  
      protected org.pf4j.PluginRepository createPluginRepository()  
      org.springframework.context.ApplicationContext getMainApplicationContext()  
      org.pf4j.PluginDescriptorFinder getPluginDescriptorFinder()  
      org.pf4j.PluginRepository getPluginRepository()  
      PluginStartingError getPluginStartingError​(java.lang.String pluginId)  
      java.util.Map<java.lang.String,​java.lang.Object> getPresetProperties()  
      java.lang.String[] getProfiles()  
      void init()
      This method load, start plugins and inject extensions in Spring
      boolean isAutoStartPlugin()  
      boolean isMainApplicationStarted()  
      void presetProperties​(java.lang.String name, java.lang.Object value)  
      void presetProperties​(java.util.Map<java.lang.String,​java.lang.Object> presetProperties)  
      void reloadPlugins​(boolean restartStartedOnly)  
      org.pf4j.PluginState reloadPlugins​(java.lang.String pluginId)  
      org.pf4j.PluginState restartPlugin​(java.lang.String pluginId)  
      void restartPlugins()  
      void setApplicationContext​(org.springframework.context.ApplicationContext applicationContext)  
      void setAutoStartPlugin​(boolean autoStartPlugin)  
      void setMainApplicationStarted​(boolean mainApplicationStarted)  
      void setProfiles​(java.lang.String[] profiles)  
      org.pf4j.PluginState startPlugin​(java.lang.String pluginId)  
      void startPlugins()  
      org.pf4j.PluginState stopPlugin​(java.lang.String pluginId)  
      void stopPlugins()  

      • Methods inherited from class org.pf4j.DefaultPluginManager

        createExtensionFinder, createPluginDescriptorFinder, createPluginFactory, createPluginLoader, createPluginStatusProvider, createVersionManager, initialize, loadPluginFromPath

      • Methods inherited from class org.pf4j.AbstractPluginManager

        addPluginStateListener, checkPluginId, createPluginsRoot, createPluginWrapper, deletePlugin, disablePlugin, enablePlugin, firePluginStateEvent, getExtensionClasses, getExtensionClasses, getExtensionClasses, getExtensionClasses, getExtensionClassNames, getExtensionFactory, getExtensions, getExtensions, getExtensions, getExtensions, getPlugin, getPluginClassLoader, getPluginClassLoaders, getPluginFactory, getPluginLabel, getPluginLoader, getPlugins, getPlugins, getPluginsRoot, getPluginsRoots, getResolvedPlugins, getRuntimeMode, getStartedPlugins, getSystemVersion, getUnresolvedPlugins, getVersion, getVersionManager, idForPath, isExactVersionAllowed, isPluginDisabled, isPluginValid, loadPlugin, loadPlugins, removePluginStateListener, resolvePlugins, setExactVersionAllowed, setSystemVersion, stopPlugin, unloadPlugin, unloadPlugin, unloadPlugins, validatePluginDescriptor, whichPlugin

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.pf4j.PluginManager

        isDevelopment, isNotDevelopment

    • Field Detail

      • presetProperties

        public java.util.Map<java.lang.String,​java.lang.Object> presetProperties

    • Constructor Detail

      • SpringBootPluginManager

        public SpringBootPluginManager()

      • SpringBootPluginManager

        public SpringBootPluginManager​(java.nio.file.Path pluginsRoot)

    • Method Detail

      • createExtensionFactory

        protected org.pf4j.ExtensionFactory createExtensionFactory()
        Overrides:
        createExtensionFactory in class org.pf4j.DefaultPluginManager

      • setApplicationContext

        public void setApplicationContext​(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
        Specified by:
        setApplicationContext in interface org.springframework.context.ApplicationContextAware
        Throws:
        org.springframework.beans.BeansException

      • getPluginDescriptorFinder

        public org.pf4j.PluginDescriptorFinder getPluginDescriptorFinder()
        Overrides:
        getPluginDescriptorFinder in class org.pf4j.AbstractPluginManager

      • createPluginRepository

        protected org.pf4j.PluginRepository createPluginRepository()
        Overrides:
        createPluginRepository in class org.pf4j.DefaultPluginManager

      • getPluginRepository

        public org.pf4j.PluginRepository getPluginRepository()

      • setAutoStartPlugin

        public void setAutoStartPlugin​(boolean autoStartPlugin)

      • isAutoStartPlugin

        public boolean isAutoStartPlugin()

      • setMainApplicationStarted

        public void setMainApplicationStarted​(boolean mainApplicationStarted)

      • setProfiles

        public void setProfiles​(java.lang.String[] profiles)

      • getProfiles

        public java.lang.String[] getProfiles()

      • presetProperties

        public void presetProperties​(java.util.Map<java.lang.String,​java.lang.Object> presetProperties)

      • presetProperties

        public void presetProperties​(java.lang.String name,
                             java.lang.Object value)

      • getPresetProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getPresetProperties()

      • getMainApplicationContext

        public org.springframework.context.ApplicationContext getMainApplicationContext()

      • isMainApplicationStarted

        public boolean isMainApplicationStarted()

      • init

        @PostConstruct
public void init()
        This method load, start plugins and inject extensions in Spring

      • getPluginStartingError

        public PluginStartingError getPluginStartingError​(java.lang.String pluginId)

      • startPlugins

        public void startPlugins()
        Specified by:
        startPlugins in interface org.pf4j.PluginManager
        Overrides:
        startPlugins in class org.pf4j.AbstractPluginManager

      • startPlugin

        public org.pf4j.PluginState startPlugin​(java.lang.String pluginId)
        Specified by:
        startPlugin in interface org.pf4j.PluginManager
        Overrides:
        startPlugin in class org.pf4j.AbstractPluginManager

      • stopPlugins

        public void stopPlugins()
        Specified by:
        stopPlugins in interface org.pf4j.PluginManager
        Overrides:
        stopPlugins in class org.pf4j.AbstractPluginManager

      • stopPlugin

        public org.pf4j.PluginState stopPlugin​(java.lang.String pluginId)
        Specified by:
        stopPlugin in interface org.pf4j.PluginManager
        Overrides:
        stopPlugin in class org.pf4j.AbstractPluginManager

      • restartPlugins

        public void restartPlugins()

      • restartPlugin

        public org.pf4j.PluginState restartPlugin​(java.lang.String pluginId)

      • reloadPlugins

        public void reloadPlugins​(boolean restartStartedOnly)

      • reloadPlugins

        public org.pf4j.PluginState reloadPlugins​(java.lang.String pluginId)