io.cdap.cdap.api.plugin

Class PluginConfig

java.lang.Object

io.cdap.cdap.api.Config

io.cdap.cdap.api.plugin.PluginConfig

All Implemented Interfaces:

Serializable

@Beta
public abstract class PluginConfig
extends Config
implements Serializable

Base class for writing configuration class for template plugin. This class can also be used inside the plugin configuration class to represent a collection of configs. If it is used to represent a collection of configs: When the plugin is deployed, the configs inside this class will be inspected and represented in the same way as PluginPropertyField. The PluginPropertyField for this field will contain a collection of property names about configs inside this class.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PluginConfig()

Method Summary

Modifier and Type	Method and Description
boolean	containsMacro(String fieldName) Returns true if property value contains a macro; false otherwise.
PluginProperties	getProperties() Returns the PluginProperties.
PluginProperties	getRawProperties() Contains the PluginProperties as they were before macro evaluation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginConfig

protected PluginConfig()

Method Detail

getProperties

public final PluginProperties getProperties()

Returns the PluginProperties. All plugin properties that are macro-enabled and were configured with macro syntax present will be substituted with Java's default values based on the property's type at configuration time. The default values are: - boolean: false - byte: 0 - char: '' - double: 0.0d - float: 0.0f - int: 0 - long: 0L - short: 0 - String: null

getRawProperties

public final PluginProperties getRawProperties()

Contains the PluginProperties as they were before macro evaluation. For example, at configure time, if the 'schema' property is a macro '${schema}', the value will be the raw string '${schema}' instead of null. This is primarily useful when one plugin is passing macro enabled properties to another plugin.

containsMacro

public boolean containsMacro(String fieldName)

Returns true if property value contains a macro; false otherwise. This method should only be called at configure time. At runtime this will always return false, as macro substitution will have already occurred.

Parameters:

fieldName - name of the field

Returns:

whether the field contains a macro or not