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

NIFI-4: Updated documentation for annotations

This commit is contained in:
Mark Payne 2015-01-22 09:07:51 -05:00
parent 1a402d468a
commit b942daa65a
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,10 +24,15 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor},
* {@link org.apache.nifi.controller.ControllerService ControllerService} or
* {@link org.apache.nifi.reporting.ReportingTask ReportingTask}
* can use to indicate a method should be called whenever the component is enabled.
* can use to indicate a method should be called whenever the component is enabled.
* Any method that has this annotation will be called every time a user enables the component.
* Additionally, each time that NiFi is restarted, if NiFi is configured to "auto-resume state"
* and the component is enabled (whether stopped or running), the method will be invoked.
* </p>
*
* <p>
* Methods using this annotation must take either 0 arguments or a single argument.

6
nifi/nifi-api/src/main/java/org/apache/nifi/annotation/lifecycle/OnScheduled.java
View File

@ -24,11 +24,15 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* Marker annotation a {@link org.apache.nifi.processor.Processor Processor} or
* {@link org.apache.nifi.reporting.ReportingTask ReportingTask} implementation
* can use to indicate a method should be called whenever the component is scheduled
* to run. This will be called before any call to 'onTrigger' and will be called once each time
* a Processor or Reporting Task is scheduled to run.
* a Processor or Reporting Task is scheduled to run. This occurs in one of two ways: either
* a user clicks to schedule the component to run, or NiFi is restarted with the "auto-resume state"
* configuration set to true (the default value) and the component is already running.
* </p>
*
* <p>
* Methods using this annotation must take either 0 arguments or a single argument.