You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/09/09 21:10:05 UTC
nifi git commit: Initial commit of NIFI-867
Repository: nifi
Updated Branches:
refs/heads/master 59b7a71c8 -> 9dae76b9c
Initial commit of NIFI-867
Signed-off-by: Matt Gilman <ma...@gmail.com>
Project: http://git-wip-us.apache.org/repos/asf/nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/9dae76b9
Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/9dae76b9
Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/9dae76b9
Branch: refs/heads/master
Commit: 9dae76b9c4aba55cbec9d75cf1af406da10461ee
Parents: 59b7a71
Author: Joseph Percivall <jo...@yahoo.com>
Authored: Wed Sep 9 12:06:55 2015 -0400
Committer: Matt Gilman <ma...@gmail.com>
Committed: Wed Sep 9 15:09:33 2015 -0400
----------------------------------------------------------------------
.../src/main/asciidoc/developer-guide.adoc | 24 ++++++++++++++++++++
1 file changed, 24 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi/blob/9dae76b9/nifi-docs/src/main/asciidoc/developer-guide.adoc
----------------------------------------------------------------------
diff --git a/nifi-docs/src/main/asciidoc/developer-guide.adoc b/nifi-docs/src/main/asciidoc/developer-guide.adoc
index caa57c0..f9950d5 100644
--- a/nifi-docs/src/main/asciidoc/developer-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/developer-guide.adoc
@@ -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