Package org.apache.flink.core.plugin

Class DirectoryBasedPluginFinder

java.lang.Object

org.apache.flink.core.plugin.DirectoryBasedPluginFinder

All Implemented Interfaces:

PluginFinder

public class DirectoryBasedPluginFinder
extends Object
implements PluginFinder

This class is used to create a collection of PluginDescriptor based on directory structure for a given plugin root folder.

The expected structure is as follows: the given plugins root folder, containing the plugins folder. One plugin folder contains all resources (jar files) belonging to a plugin. The name of the plugin folder becomes the plugin id.

 plugins-root-folder/
            |------------plugin-a/ (folder of plugin a)
            |                |-plugin-a-1.jar (the jars containing the classes of plugin a)
            |                |-plugin-a-2.jar
            |                |-...
            |
            |------------plugin-b/
            |                |-plugin-b-1.jar
           ...               |-...
 

Constructor Summary

Constructors

Constructor	Description
DirectoryBasedPluginFinder(Path pluginsRootDir)

Method Summary

Modifier and Type	Method	Description
Collection<PluginDescriptor>	findPlugins()	Find plugins and return a corresponding collection of PluginDescriptor instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryBasedPluginFinder

public DirectoryBasedPluginFinder(Path pluginsRootDir)

Method Detail

findPlugins

public Collection<PluginDescriptor> findPlugins()
                                         throws IOException

Description copied from interface: PluginFinder

Find plugins and return a corresponding collection of PluginDescriptor instances.

Specified by:

findPlugins in interface PluginFinder

Returns:

a collection of PluginDescriptor instances for all found plugins.

Throws:

IOException - thrown if a problem occurs during plugin search.