io.cdap.cdap.api.plugin

Interface PluginContext

All Superinterfaces:

FeatureFlagsProvider

All Known Subinterfaces:

CustomActionContext, HttpServiceContext, MapReduceContext, MapReduceTaskContext<KEYOUT,VALUEOUT>, ServiceContext, SparkClientContext, WorkerContext, WorkflowContext

@Beta
public interface PluginContext
extends FeatureFlagsProvider

Provides access to plugin context when a program is executing.

Method Summary

Modifier and Type	Method and Description
PluginProperties	getPluginProperties(String pluginId) Gets the PluginProperties associated with the given plugin id.
PluginProperties	getPluginProperties(String pluginId, MacroEvaluator evaluator) Gets the PluginProperties associated with the given plugin id.
<T> Class<T>	loadPluginClass(String pluginId) Loads and returns a plugin class as specified by the given plugin id.
<T> T	newPluginInstance(String pluginId) Creates a new instance of a plugin.
<T> T	newPluginInstance(String pluginId, MacroEvaluator evaluator) Creates a new instance of a plugin.

Methods inherited from interface io.cdap.cdap.api.feature.FeatureFlagsProvider

isFeatureEnabled

Method Detail

getPluginProperties

PluginProperties getPluginProperties(String pluginId)

Gets the PluginProperties associated with the given plugin id.

Parameters:

pluginId - the unique identifier provide when declaring plugin usage in the program.

Returns:

the PluginProperties.

Throws:

IllegalArgumentException - if pluginId is not found

UnsupportedOperationException - if the program does not support plugin

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

getPluginProperties

PluginProperties getPluginProperties(String pluginId,
                                     MacroEvaluator evaluator)
                              throws InvalidMacroException

Gets the PluginProperties associated with the given plugin id. If a plugin field has a macro, the parameter evaluator is used to evaluate the macro and the evaluated value is used for the plugin field.

Parameters:

pluginId - the unique identifier provide when declaring plugin usage in the program.

evaluator - the macro evaluator that's used to evaluate macro for plugin field if macro is supported on those fields.

Returns:

the macro evaluated PluginProperties.

Throws:

IllegalArgumentException - if pluginId is not found

UnsupportedOperationException - if the program does not support plugin

InvalidMacroException - if there is an exception during macro evaluation

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

loadPluginClass

<T> Class<T> loadPluginClass(String pluginId)

Loads and returns a plugin class as specified by the given plugin id.

Type Parameters:

T - the class type of the plugin

Parameters:

pluginId - the unique identifier provide when declaring plugin usage in the program.

Returns:

the resulting plugin Class.

Throws:

IllegalArgumentException - if pluginId is not found

UnsupportedOperationException - if the program does not support plugin

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

newPluginInstance

<T> T newPluginInstance(String pluginId)
                 throws InstantiationException

Creates a new instance of a plugin. The instance returned will have the PluginConfig setup with PluginProperties provided at the time when the PluginConfigurer.usePlugin(String, String, String, PluginProperties) was called during the program configuration time.

Type Parameters:

T - the class type of the plugin

Parameters:

pluginId - the unique identifier provide when declaring plugin usage in the program.

Returns:

A new instance of the plugin being specified by the arguments

Throws:

InstantiationException - if failed create a new instance

IllegalArgumentException - if pluginId is not found

UnsupportedOperationException - if the program does not support plugin

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

newPluginInstance

<T> T newPluginInstance(String pluginId,
                        MacroEvaluator evaluator)
                 throws InstantiationException,
                        InvalidMacroException

Creates a new instance of a plugin. The instance returned will have the PluginConfig setup with PluginProperties provided at the time when the PluginConfigurer.usePlugin(String, String, String, PluginProperties) was called during the program configuration time. If a plugin field has a macro, the parameter evaluator is used to evaluate the macro and the evaluated value is used for the plugin field.

Type Parameters:

T - the class type of the plugin

Parameters:

pluginId - the unique identifier provide when declaring plugin usage in the program.

evaluator - the macro evaluator that's used to evaluate macro for plugin field if macro is supported on those fields.

Returns:

A new instance of the plugin being specified by the arguments

Throws:

InstantiationException - if failed create a new instance

IllegalArgumentException - if pluginId is not found

UnsupportedOperationException - if the program does not support plugin

InvalidMacroException - if there is an exception during macro evaluation

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