org.pf4j.DefaultPluginManager Java Examples

private <T extends ThrowingToolchainFactory> DefaultToolchainProvider createProvider(
    Class<T> factoryClass) {
  ToolchainSupplier supplier =
      () ->
          Collections.singleton(
              ToolchainDescriptor.of(
                  NoopToolchain.DEFAULT_NAME, NoopToolchain.class, factoryClass));

  return new DefaultToolchainProvider(
      new DefaultPluginManager() {
        @Override
        public <T> List<T> getExtensions(Class<T> type) {
          if (ToolchainSupplier.class.equals(type)) {
            return (List<T>) Collections.singletonList(supplier);
          }
          return super.getExtensions(type);
        }
      },
      ImmutableMap.of(),
      FakeBuckConfig.builder().build(),
      new FakeProjectFilesystem(),
      new FakeProcessExecutor(),
      new ExecutableFinder(),
      TestRuleKeyConfigurationFactory.create());
}
 

public TestApplication() {
    Path pluginsPath;
    try {
        pluginsPath = Files.createTempDirectory("plugins");
    } catch (IOException e) {
        throw new RuntimeException("Failed creating temp plugins directory", e);
    }

    pluginManager = new DefaultPluginManager(pluginsPath);
    updateManager = new UpdateManager(pluginManager);
}
 

public static void main(String[] args){
    final PluginManager pm = new DefaultPluginManager();

    pm.loadPlugins();

    pm.startPlugins();

    final List<PluginInterface> plugins = pm.getExtensions(PluginInterface.class);

    log.info(MessageFormat.format(" {0} Plugin(s) found ", String.valueOf(plugins.size())));

    plugins.forEach(g ->
            log.info(MessageFormat.format(" {0}: {1}",
                    g.getClass().getCanonicalName(),
                    g.identify())));

    pm.stopPlugins();

}
 

public static void main(String[] args) {
	
	System.setProperty("pf4j.mode", RuntimeMode.DEPLOYMENT.toString());
	System.setProperty("pf4j.pluginsDir", "plugins");
	
	if(RuntimeMode.DEPLOYMENT.compareTo(RuntimeMode.DEPLOYMENT) == 0) {
		//System.setProperty("pf4j.pluginsDir", System.getProperty("app.home","e:/root") + "/plugins");
	}
	
	/**
	 * 创建PluginManager对象,此处根据生产环境选择合适的实现，或者自定义实现
	 */
	PluginManager pluginManager = new DefaultPluginManager();
	// PluginManager pluginManager = new Pf4jPluginManager();
	// PluginManager pluginManager = new SpringPluginManager();
	// PluginManager pluginManager = new Pf4jJarPluginManager();
	// PluginManager pluginManager = new Pf4jJarPluginWhitSpringManager();

	/**
	 * 加载插件到JVM
	 */
    pluginManager.loadPlugins();

    /**
     * 调用Plugin实现类的start()方法: 
     */
    pluginManager.startPlugins();
    
    List<PluginWrapper> list = pluginManager.getPlugins();
    for (PluginWrapper pluginWrapper : list) {
		System.out.println(pluginWrapper.getPluginId());
	}
    
    
    List<AuthcExtensionPoint> extensions = pluginManager.getExtensions(AuthcExtensionPoint.class);
    
    for (AuthcExtensionPoint point : extensions) {
    	
    	ExtensionMapping m = point.getClass().getAnnotation(ExtensionMapping.class);
    	System.out.println(m.title());
    	
	}
    
    /**
     * 调用Plugin实现类的stop()方法
     */
    pluginManager.stopPlugins();
    
    System.out.println("=============");
	
}
 

@Test
@DisplayName("Created plugin must be successfully loaded and unloaded by the PluginManager. "
    + "If this test does not work, subsequent use of ServiceArtifactBuilder in other ITs makes "
    + "no sense.")
void createdArtifactCanBeLoaded(@TempDir Path tmp) throws IOException {
  Path pluginPath = tmp.resolve("test-plugin.jar");

  String pluginId = "test-plugin";
  String version = "1.0.1";
  Class<?> pluginClass = TestPlugin.class;
  new ServiceArtifactBuilder()
      .setPluginId(pluginId)
      .setPluginVersion(version)
      .setManifestEntry("Plugin-Class", pluginClass.getName())
      .addClass(pluginClass)
      .addExtensionClass(TestServiceExtensionImpl.class)
      .writeTo(pluginPath);

  PluginManager pluginManager = new DefaultPluginManager();

  // Try to load the plugin
  String loadedPluginId = pluginManager.loadPlugin(pluginPath);
  assertThat(loadedPluginId).isEqualTo(pluginId);

  // Check it has correct version
  PluginWrapper plugin = pluginManager.getPlugin(pluginId);
  assertThat(plugin.getDescriptor().getVersion()).isEqualTo(version);
  assertNamesEqual(plugin.getPlugin().getClass(), pluginClass);

  // Try to start
  PluginState pluginState = pluginManager.startPlugin(pluginId);
  assertThat(pluginState).isEqualTo(PluginState.STARTED);

  // Check the extensions
  List<Class<? extends TestServiceExtension>> extensionClasses = pluginManager
      .getExtensionClasses(TestServiceExtension.class, pluginId);
  assertThat(extensionClasses).hasSize(1);
  Class<?> extensionType = extensionClasses.get(0);
  assertNamesEqual(extensionType, TestServiceExtensionImpl.class);

  // Try to stop and unload
  pluginState = pluginManager.stopPlugin(pluginId);
  assertThat(pluginState).isEqualTo(PluginState.STOPPED);
  boolean unloadResult = pluginManager.unloadPlugin(pluginId);
  assertTrue(unloadResult);
}
 

@Override
PluginManager createPluginManager() {
  return new DefaultPluginManager();
}