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

NIFI-12986 Remove depreciation warning from ProcessSession.commit 

Explain advantage of commitAsync in ProcessSession

This closes #8683

Signed-off-by: Joseph Witt <joewitt@apache.org>
This commit is contained in:
Lucas 2024-04-22 20:14:09 +03:00 committed by Joseph Witt
parent 7c5e6b9e14
commit 49862d5342
No known key found for this signature in database
GPG Key ID: 9093BF854F811A1A
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
nifi-api/src/main/java/org/apache/nifi/processor/ProcessSession.java
View File

@ -75,10 +75,11 @@ public interface ProcessSession {
* All FlowFiles operated on within this session must be accounted for by transfer or removal or the commit will fail.
* <p>
* As soon as the commit completes the session is again ready to be used.
* <p>
* See {@link #commitAsync()}, {@link #commitAsync(Runnable)}, and {@link #commitAsync(Runnable, Consumer)}.
* The asynchronous session commit methods are preferable to this commit call for most cases
* as it defers when the actual commit happens to the framework so that it can optimize when the commit call takes place.
*
* @deprecated As of NiFi 1.14.0, replaced by {@link #commitAsync()}, {@link #commitAsync(Runnable)}, and {@link #commitAsync(Runnable, Consumer)}.
* The synchronous API is less suited for execution in different runtimes, e.g. MiNiFi or Stateless NiFi,
* and may cause the dataflow in such runtimes to get stuck.
* @throws IllegalStateException if detected that this method is being called from within a read or write callback
* (see {@link #read(FlowFile, InputStreamCallback)}, {@link #write(FlowFile, StreamCallback)},
* {@link #write(FlowFile, OutputStreamCallback)}) or while a read or write stream is open