You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ma...@apache.org on 2015/01/20 19:03:42 UTC
[3/5] incubator-nifi git commit: NIFI-4: Updated docs for OnEnabled
NIFI-4: Updated docs for OnEnabled
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/bd290018
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/bd290018
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/bd290018
Branch: refs/heads/annotations
Commit: bd290018adf08bf027d19f9891e257517e74a7a4
Parents: b595670
Author: Mark Payne <ma...@hotmail.com>
Authored: Tue Jan 20 13:00:44 2015 -0500
Committer: Mark Payne <ma...@hotmail.com>
Committed: Tue Jan 20 13:00:44 2015 -0500
----------------------------------------------------------------------
.../nifi/annotation/lifecycle/OnEnabled.java | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/bd290018/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
index a0d7a14..8d7d6b3 100644
--- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
+++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnEnabled.java
@@ -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