Annotation Interface OnDisabled
Marker annotation a
ControllerService can
use to indicate a method should be called whenever the service is disabled.
Methods using this annotation are permitted to take zero arguments or to take
a single argument of type ConfigurationContext. If a method with this
annotation throws a Throwable, a log message and bulletin will be issued for
the service, but the service will still be marked as Disabled. The failing
method will not be called again until the service is enabled and disabled again.
This is done in order to prevent a ControllerService from continually failing
in such a way that the service could not be disabled and updated without
restarting the instance of NiFi.
Note that this annotation will be ignored if applied to a ReportingTask, ParameterProvider or Processor. For a Controller Service, enabling and disabling are considered lifecycle events, as the action makes them usable or unusable by other components. However, for a Processor and a Reporting Task, these are not lifecycle events but rather a mechanism to allow a component to be excluded when starting or stopping a group of components.