io.cdap.cdap.api.service.http

Interface ServicePluginConfigurer

All Superinterfaces:

PluginConfigurer

public interface ServicePluginConfigurer
extends PluginConfigurer

Plugin configurer specifically for service. It provides additional functionality such as instantiate the plugin with provided macro evaluator.

Method Summary

Modifier and Type	Method and Description
default ClassLoader	createClassLoader() Creates a new instance of ClassLoader that contains this program classloader, all the plugins export-package classloader instantiated by this configurer and system classloader in that loading order.
<T> T	usePlugin(String pluginType, String pluginName, String pluginId, PluginProperties properties, PluginSelector selector, MacroEvaluator macroEvaluator, MacroParserOptions options) Adds a Plugin usage to the Application and create a new instance.

Methods inherited from interface io.cdap.cdap.api.plugin.PluginConfigurer

evaluateMacros, evaluateMacros, usePlugin, usePlugin, usePluginClass, usePluginClass

Method Detail

usePlugin

@Nullable
<T> T usePlugin(String pluginType,
                          String pluginName,
                          String pluginId,
                          PluginProperties properties,
                          PluginSelector selector,
                          MacroEvaluator macroEvaluator,
                          MacroParserOptions options)

Adds a Plugin usage to the Application and create a new instance. The Plugin will be accessible at execution time via the PluginContext.

Type Parameters:

T - type of the plugin class

Parameters:

pluginType - plugin type name

pluginName - plugin name

pluginId - an unique identifier for this usage. The same id is used to get the plugin at execution time.

properties - properties for the plugin. The same set of properties will be used to instantiate the plugin instance at execution time

selector - for selecting which plugin to use

macroEvaluator - macro evaluator to be used to evaluate macros

options - macro parsing options

Returns:

A new instance of the plugin class or null if no plugin was found

Throws:

InvalidPluginConfigException - if the plugin config could not be created from the given properties

createClassLoader

default ClassLoader createClassLoader()

Creates a new instance of ClassLoader that contains this program classloader, all the plugins export-package classloader instantiated by this configurer and system classloader in that loading order. Currently this method is only supported in services.

Returns:

a combined classloader