io.cdap.cdap.api.plugin

Interface PluginConfigurer

All Known Subinterfaces:

ApplicationConfigurer, ConditionConfigurer, CustomActionConfigurer, HttpServiceConfigurer, MapReduceConfigurer, ServiceConfigurer, ServicePluginConfigurer, SparkConfigurer, WorkerConfigurer, WorkflowConfigurer

public interface PluginConfigurer

This interface provides methods to register plugin usage in a CDAP Program. The registered plugins will be available at the runtime of the Program. Additionally, it provides methods to evaluate the plugin properties if it contains macro.

Method Summary

Modifier and Type	Method and Description
default Map<String,String>	evaluateMacros(Map<String,String> properties, MacroEvaluator evaluator) Evaluates lookup macros and macro functions using provided macro evaluator.
default Map<String,String>	evaluateMacros(Map<String,String> properties, MacroEvaluator evaluator, MacroParserOptions options) Evaluates macros using provided macro evaluator with the provided parsing options.
default <T> T	usePlugin(String pluginType, String pluginName, String pluginId, PluginProperties properties) Adds a Plugin usage to the Application and create a new instance.
<T> T	usePlugin(String pluginType, String pluginName, String pluginId, PluginProperties properties, PluginSelector selector) Adds a Plugin usage to the Application and create a new instance.
default <T> Class<T>	usePluginClass(String pluginType, String pluginName, String pluginId, PluginProperties properties) Adds a Plugin usage to the Application.
<T> Class<T>	usePluginClass(String pluginType, String pluginName, String pluginId, PluginProperties properties, PluginSelector selector) Adds a Plugin usage to the Application.

Method Detail

usePlugin

@Nullable
default <T> T usePlugin(String pluginType,
                                  String pluginName,
                                  String pluginId,
                                  PluginProperties properties)

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

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

usePlugin

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

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

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

usePluginClass

@Nullable
default <T> Class<T> usePluginClass(String pluginType,
                                              String pluginName,
                                              String pluginId,
                                              PluginProperties properties)

Adds a Plugin usage to the Application. 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

Returns:

A Class for the plugin class or null if no plugin was found

Throws:

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

usePluginClass

@Nullable
<T> Class<T> usePluginClass(String pluginType,
                                      String pluginName,
                                      String pluginId,
                                      PluginProperties properties,
                                      PluginSelector selector)

Adds a Plugin usage to the Application. 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

Returns:

A Class for the plugin class or null if no plugin was found

Throws:

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

evaluateMacros

default Map<String,String> evaluateMacros(Map<String,String> properties,
                                          MacroEvaluator evaluator)
                                   throws InvalidMacroException

Evaluates lookup macros and macro functions using provided macro evaluator.

Parameters:

properties - key-value map of properties to evaluate

evaluator - macro evaluator to be used to evaluate macros

Returns:

map of evaluated macros

Throws:

InvalidMacroException - indicates that there is an invalid macro

evaluateMacros

default Map<String,String> evaluateMacros(Map<String,String> properties,
                                          MacroEvaluator evaluator,
                                          MacroParserOptions options)
                                   throws InvalidMacroException

Evaluates macros using provided macro evaluator with the provided parsing options.

Parameters:

properties - key-value map of properties to evaluate

evaluator - macro evaluator to be used to evaluate macros

options - macro parsing options

Returns:

map of evaluated macros

Throws:

InvalidMacroException - indicates that there is an invalid macro