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

NIFI-4: Updated docs for OnEnabled

This commit is contained in:
Mark Payne 2015-01-20 13:00:44 -05:00
parent b5956709b7
commit bd290018ad
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
View File

@ -30,9 +30,22 @@ import java.lang.annotation.Target;
* can use to indicate a method should be called whenever the component is enabled.
*
* <p>
* Methods using this annotation must take no arguments. If a method with this annotation
* throws a Throwable, a log message and bulletin will be issued for the component, but
* the component will still be enabled.
* Methods using this annotation must take either 0 arguments or a single argument.
* </p>
*
* <p>
* If using 1 argument and the component using the annotation is a Processor, that argument must
* be of type {@link org.apache.nifi.processor.ProcessContext ProcessContext}.
* </p>
*
* <p>
* If using 1 argument and the component using the annotation is a Reporting Task or Controller Service,
* that argument must be of type {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
* </p>
*
* <p>
* If a method with this annotation throws a Throwable, a log message and bulletin will be issued
* for the component, but the component will still be enabled.
* </p>
*
* @author none