Package org.pf4j
-
Interface Summary Interface Description ExtensionFactory Creates an extension instance.ExtensionFinder ExtensionPoint An extension point is a formal declaration in a plugin (or in application API) where customization is allowed.PluginDescriptor A plugin descriptor contains information about a plug-in.PluginDescriptorFinder Find a plugin descriptor for a plugin path.PluginFactory Creates a plugin instance.PluginLoader Load all information (classes) needed by a plugin.PluginManager Provides the functionality for plugin management such as load, start and stop the plugins.PluginRepository Directory that contains plugins.PluginStateListener PluginStateListener defines the interface for an object that listens to plugin state changes.PluginStatusProvider VersionManager Manager responsible for versions of plugins. -
Class Summary Class Description AbstractExtensionFinder AbstractPluginManager This class implements the boilerplate plugin code that anyPluginManagerimplementation would have to support.BasePluginLoader Load all information needed by a plugin.BasePluginRepository CompoundPluginDescriptorFinder CompoundPluginLoader CompoundPluginRepository DefaultExtensionFactory The default implementation forExtensionFactory.DefaultExtensionFinder The default implementation forExtensionFinder.DefaultPluginClasspath The default values areDefaultPluginClasspath.CLASSES_DIRand#LIB_DIR.DefaultPluginDescriptor DefaultPluginFactory The default implementation forPluginFactory.DefaultPluginLoader Load all information needed by a plugin fromDefaultPluginClasspath.DefaultPluginManager Default implementation of thePluginManagerinterface.DefaultPluginRepository DefaultPluginStatusProvider The default implementation forPluginStatusProvider.DefaultVersionManager Default implementation forVersionManager.DependencyResolver This class builds a dependency graph for a list of plugins (descriptors).DependencyResolver.Result DependencyResolver.WrongDependencyVersion DevelopmentPluginClasspath It's a compoundPluginClasspath(DevelopmentPluginClasspath.MAVEN+DevelopmentPluginClasspath.GRADLE+DevelopmentPluginClasspath.KOTLIN) used in development mode (RuntimeMode.DEVELOPMENT).DevelopmentPluginLoader Load all information needed by a plugin fromDevelopmentPluginClasspath.DevelopmentPluginRepository ExtensionDescriptor ExtensionWrapper<T> A wrapper over extension instance.JarPluginLoader JarPluginManager It's aPluginManagerthat loads each plugin from ajarfile.JarPluginRepository LegacyExtensionFinder All extensions declared in a plugin are indexed in a fileMETA-INF/extensions.idx.LoggingPluginStateListener It's an implementation ofPluginStateListenerthat writes all events to logger (DEBUG level).ManifestPluginDescriptorFinder Read the plugin descriptor from the manifest file.Plugin This class will be extended by all plugins and serve as the common class between a plugin and the application.PluginClassLoader One instance of this class should be created by plugin manager for every available plug-in.PluginClasspath The classpath of the plugin.PluginDependency PluginStateEvent PluginWrapper A wrapper over plugin instance.PropertiesPluginDescriptorFinder Find a plugin descriptor in a properties file (in plugin repository).ServiceProviderExtensionFinder TheServiceLoaderbase implementation forExtensionFinder.SingletonExtensionFactory AnExtensionFactorythat always returns a specific instance.ZipPluginManager It's aPluginManagerthat loads each plugin from azipfile. -
Enum Summary Enum Description PluginState RuntimeMode -
Exception Summary Exception Description DependencyResolver.CyclicDependencyException It will be thrown if a cyclic dependency is detected.DependencyResolver.DependenciesNotFoundException Indicates that the dependencies required were not found.DependencyResolver.DependenciesWrongVersionException Indicates that some dependencies have wrong version.PluginAlreadyLoadedException PluginRuntimeException An exception used to indicate that a plugin problem occurred. -
Annotation Types Summary Annotation Type Description Extension