Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Initial commit of NIFI-867 

Signed-off-by: Matt Gilman <matt.c.gilman@gmail.com>
This commit is contained in:
Joseph Percivall 2015-09-09 12:06:55 -04:00 committed by Matt Gilman
parent 59b7a71c8a
commit 9dae76b9c4
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
nifi-docs/src/main/asciidoc/developer-guide.adoc
View File

@ -449,6 +449,30 @@ Annotation will not be invoked. This method will be called only once
for the lifetime of a component.
Methods with this Annotation must take zero arguments.
==== @OnEnabled
The `@OnEnabled` annotation can be used to indicate a method should be called
whenever the Controller Service is enabled. Any method that has this annotation will be
called every time a user enables the service. Additionally, each time that NiFi
is restarted, if NiFi is configured to "auto-resume state" and the service
is enabled, the method will be invoked.
If a method with this annotation throws a Throwable, a log message and
bulletin will be issued for the component. In this event, the service will
remain in an 'ENABLING' state and will not be usable. All methods with this
annotation will then be called again after a delay. The service will not be
made available for use until all methods with this annotation have returned
without throwing anything.
Methods using this annotation must take either 0 arguments or a single argument
of type `org.apache.nifi.controller.ConfigurationContext`.
Note that this annotation will be ignored if applied to a ReportingTask 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.
==== @OnRemoved