ai.djl.serving.plugins

Class FolderScanPluginManager

java.lang.Object

ai.djl.serving.plugins.FolderScanPluginManager

All Implemented Interfaces:

PluginManager

public class FolderScanPluginManager
extends java.lang.Object
implements PluginManager

The PluginManager is responsible to load and manage plugins from the file system.

The Plugin Folder configuration is received from the ConfigManager and usually defaults to {workpath}/plugins. The plugins uses Java's SPI and have to implement interfaces from serving-api.

Constructor Summary

Constructors

Constructor and Description
FolderScanPluginManager(ConfigManager configManager) Constructs a PluginManager instance.

Method Summary

Modifier and Type	Method and Description
<T> java.util.Set<T>	findImplementations(java.lang.Class<T> pluginInterface) returns a set of plug-in components implementing the specific service interface.
void	loadPlugins() Loads all plugins from the plugin folder and register them.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderScanPluginManager

public FolderScanPluginManager(ConfigManager configManager)

Constructs a PluginManager instance.

Parameters:

configManager - a instance of the configManager to lookup configuration like plugin-folder.

Method Detail

loadPlugins

public void loadPlugins()
                 throws java.io.IOException

Loads all plugins from the plugin folder and register them.

Throws:

java.io.IOException - when error during IO operation occurs.

findImplementations

public <T> java.util.Set<T> findImplementations(java.lang.Class<T> pluginInterface)

returns a set of plug-in components implementing the specific service interface.

only active plug-ins are returned which are fully initialised at this point.

Set<RequestHandler> allActiveRequestHandler=findImplementations(RequestHandler.class)

Specified by:

findImplementations in interface PluginManager

Type Parameters:

T - generic type of service interface

Parameters:

pluginInterface - the specific service interface

Returns:

a set of all plugin components implementing this service interface