public interface ParameterProvider extends ConfigurableComponent
ParameterProvider
s are discovered following Java's
ServiceLoader
pattern. As a result, all implementations must
follow these rules:
META-INF/services
directory. This file contains a list of
fully-qualified class names of all ParameterProvider
s in the jar,
one-per-line.
All implementations of this interface must be thread-safe.
Parameter Providers may choose to annotate a method with the
@OnConfigurationRestored
annotation. If this is done, that method
will be invoked after all properties have been set for the ParameterProvider and
before its parameters are fetched.
Modifier and Type | Method and Description |
---|---|
List<ParameterGroup> |
fetchParameters(ConfigurationContext context)
Fetches named groups of parameters from an external source.
|
void |
initialize(ParameterProviderInitializationContext config)
Provides the Parameter Provider with access to objects that may be of use
throughout the life of the provider
|
getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate
void initialize(ParameterProviderInitializationContext config) throws InitializationException
config
- of initialization contextInitializationException
- if unable to initList<ParameterGroup> fetchParameters(ConfigurationContext context) throws IOException
RuntimeException
context
- The ConfigurationContext
for the providerIOException
- if there is an I/O problem while fetching the ParametersCopyright © 2023 Apache NiFi Project. All rights reserved.