StandardProcessSession (nifi-framework-components 1.13.0 API)

java.lang.Object
- org.apache.nifi.controller.repository.StandardProcessSession

All Implemented Interfaces:

ProvenanceEventEnricher, ProcessSession
```
public class StandardProcessSession
extends Object
implements ProcessSession, ProvenanceEventEnricher
```
Provides a ProcessSession that ensures all accesses, changes and transfers occur in an atomic manner for all FlowFiles including their contents and attributes

NOT THREAD SAFE

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`StandardProcessSession.Checkpoint`
`private static interface`	`StandardProcessSession.ConnectionPoller` Callback interface used to poll a FlowFileQueue, in order to perform functional programming-type of polling a queue

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<ContentClaim,org.apache.nifi.stream.io.ByteCountingOutputStream>`	`appendableStreams`
`private long`	`bytesRead`
`private long`	`bytesWritten`
`private StandardProcessSession.Checkpoint`	`checkpoint`
`private ContentClaimWriteCache`	`claimCache`
`private static org.slf4j.Logger`	`claimLog`
`private StateMap`	`clusterState`
`private String`	`connectableDescription`
`private Map<String,StandardFlowFileEvent>`	`connectionCounts`
`private long`	`contentSizeIn`
`private long`	`contentSizeOut`
`private RepositoryContext`	`context`
`private Map<String,Long>`	`countersOnCommit`
`private Set<String>`	`createdFlowFiles`
`private ContentClaim`	`currentReadClaim`
`private ContentClaimInputStream`	`currentReadClaimStream`
`static String`	`DEFAULT_FLOWFILE_PATH`
`private Map<FlowFile,Path>`	`deleteOnCommit`
`private static StateMap`	`EMPTY_STATE_MAP`
`private static AtomicLong`	`enqueuedIndex`
`private int`	`flowFilesIn`
`private int`	`flowFilesOut`
`private Map<FlowFile,ProvenanceEventBuilder>`	`forkEventBuilders`
`private Map<FlowFile,List<ProvenanceEventRecord>>`	`generatedProvenanceEvents`
`private static AtomicLong`	`idGenerator`
`private Map<String,Long>`	`immediateCounters`
`private StateMap`	`localState`
`private static org.slf4j.Logger`	`LOG`
`private static int`	`MAX_ROLLBACK_FLOWFILES_TO_LOG`
`private Map<FlowFile,InputStream>`	`openInputStreams`
`private Map<FlowFile,OutputStream>`	`openOutputStreams`
`private long`	`processingStartTime`
`private InternalProvenanceReporter`	`provenanceReporter`
`private Map<FlowFile,Integer>`	`readRecursionSet`
`private Map<Long,StandardRepositoryRecord>`	`records`
`private long`	`removedBytes`
`private int`	`removedCount`
`private Set<String>`	`removedFlowFiles`
`private long`	`sessionId`
`private TaskTermination`	`taskTermination`
`private Map<FlowFileQueue,Set<FlowFileRecord>>`	`unacknowledgedFlowFiles`
`static int`	`VERBOSE_LOG_THRESHOLD`
`private Set<FlowFile>`	`writeRecursionSet`

Constructor Summary

Constructors
Constructor and Description

StandardProcessSession(RepositoryContext context, TaskTermination taskTermination)

Constructors
Constructor and Description
`StandardProcessSession(RepositoryContext context, TaskTermination taskTermination)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`acknowledgeRecords()`
`private void`	`addEventType(Map<String,BitSet> map, String id, ProvenanceEventType eventType)`
`void`	`adjustCounter(String name, long delta, boolean immediate)`
`private void`	`adjustCounter(String name, long delta, Map<String,Long> map)`
`FlowFile`	`append(FlowFile source, OutputStreamCallback writer)`
`void`	`checkpoint()`
`private void`	`checkpoint(boolean copyCollections)`
`void`	`clearState(Scope scope)`
`FlowFile`	`clone(FlowFile example)`
`FlowFile`	`clone(FlowFile example, long offset, long size)`
`private void`	`closeStreams(Map<FlowFile,? extends Closeable> streamMap, String action, String streamType)`
`private Map<String,Long>`	`combineCounters(Map<String,Long> first, Map<String,Long> second)`
`void`	`commit()`
`protected void`	`commit(StandardProcessSession.Checkpoint checkpoint)`
`FlowFile`	`create()`
`FlowFile`	`create(Collection<FlowFile> parents)`
`FlowFile`	`create(FlowFile parent)`
`private InputStream`	`createTaskTerminationStream(InputStream delegate)`
`private OutputStream`	`createTaskTerminationStream(OutputStream delegate)`
`private void`	`decrementClaimCount(ContentClaim claim)`
`private void`	`decrementReadCount(FlowFile flowFile)`
`private void`	`destroyContent(ContentClaim claim, StandardRepositoryRecord repoRecord)` Destroys a ContentClaim that was being written to but is no longer needed
`ProvenanceEventRecord`	`enrich(ProvenanceEventRecord rawEvent, FlowFile flowFile, long commitNanos)` Returns a new Provenance event that has been updated to contain the original and updated FlowFile attributes and content claim information.
`private ProvenanceEventRecord`	`enrich(ProvenanceEventRecord rawEvent, Map<String,FlowFileRecord> flowFileRecordMap, Map<Long,StandardRepositoryRecord> records, boolean updateAttributes, long commitNanos)`
`private void`	`ensureNotAppending(ContentClaim claim)`
`void`	`expireFlowFiles()`
`void`	`exportTo(FlowFile source, OutputStream destination)`
`void`	`exportTo(FlowFile source, Path destination, boolean append)`
`protected void`	`finalize()`
`private void`	`formatNanos(long nanos, StringBuilder sb)`
`FlowFile`	`get()`
`List<FlowFile>`	`get(FlowFileFilter filter)`
`List<FlowFile>`	`get(int maxResults)`
`private List<FlowFile>`	`get(StandardProcessSession.ConnectionPoller poller, boolean lockAllQueues)`
`private InputStream`	`getInputStream(FlowFile flowFile, ContentClaim claim, long offset, boolean allowCachingOfStream)`
`private FlowFile`	`getMostRecent(FlowFile flowFile)`
`ProvenanceReporter`	`getProvenanceReporter()`
`QueueSize`	`getQueueSize()`
`private StandardRepositoryRecord`	`getRecord(FlowFile flowFile)`
`protected long`	`getSessionId()`
`StateMap`	`getState(Scope scope)`
`private void`	`handleConflictingId(FlowFileRecord flowFile, Connection connection, StandardRepositoryRecord conflict)`
`private void`	`handleContentNotFound(ContentNotFoundException nfe, Collection<StandardRepositoryRecord> suspectRecords)`
`private void`	`handleContentNotFound(ContentNotFoundException nfe, StandardRepositoryRecord suspectRecord)`
`FlowFile`	`importFrom(InputStream source, FlowFile destination)`
`FlowFile`	`importFrom(Path source, boolean keepSourceFile, FlowFile destination)`
`private void`	`incrementConnectionInputCounts(Connection connection, RepositoryRecord record)`
`private void`	`incrementConnectionInputCounts(String connectionId, int flowFileCount, long bytes)`
`private void`	`incrementConnectionOutputCounts(Connection connection, FlowFileRecord record)`
`private void`	`incrementConnectionOutputCounts(String connectionId, int flowFileCount, long bytes)`
`private void`	`incrementReadCount(FlowFile flowFile)`
`private static Map<String,String>`	`intersectAttributes(Collection<FlowFile> flowFileList)` Returns the attributes that are common to every FlowFile given.
`(package private) boolean`	`isFlowFileKnown(FlowFile flowFile)` Checks if a FlowFile is known in this session.
`private boolean`	`isSpuriousForkEvent(ProvenanceEventRecord event, Set<String> removedFlowFiles)` Checks if the given event is a spurious FORK, meaning that the FORK has a single child and that child was removed in this session.
`private boolean`	`isSpuriousRouteEvent(ProvenanceEventRecord event, Map<Long,StandardRepositoryRecord> records)` Checks if the given event is a spurious ROUTE, meaning that the ROUTE indicates that a FlowFile was routed to a relationship with only 1 connection and that Connection is the Connection from which the FlowFile was pulled.
`private String`	`loggableFlowfileInfo()`
`FlowFile`	`merge(Collection<FlowFile> sources, FlowFile destination)`
`FlowFile`	`merge(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator)`
`void`	`migrate(ProcessSession newOwner, Collection<FlowFile> flowFiles)`
`private void`	`migrate(StandardProcessSession newOwner, Collection<FlowFile> flowFiles)`
`FlowFile`	`penalize(FlowFile flowFile)`
`FlowFile`	`putAllAttributes(FlowFile flowFile, Map<String,String> attributes)`
`FlowFile`	`putAttribute(FlowFile flowFile, String key, String value)`
`InputStream`	`read(FlowFile source)`
`void`	`read(FlowFile source, boolean allowSessionStreamManagement, InputStreamCallback reader)`
`void`	`read(FlowFile source, InputStreamCallback reader)`
`private void`	`registerDequeuedRecord(FlowFileRecord flowFile, Connection connection)`
`private void`	`registerForkEvent(FlowFile parent, FlowFile child)`
`private void`	`registerJoinEvent(FlowFile child, Collection<FlowFile> parents)`
`void`	`remove(Collection<FlowFile> flowFiles)`
`void`	`remove(FlowFile flowFile)`
`FlowFile`	`removeAllAttributes(FlowFile flowFile, Pattern keyPattern)`
`FlowFile`	`removeAllAttributes(FlowFile flowFile, Set<String> keys)`
`FlowFile`	`removeAttribute(FlowFile flowFile, String key)`
`private void`	`removeExpired(Set<FlowFileRecord> flowFiles, Connection connection)`
`private void`	`removeForkEvents(FlowFile flowFile)`
`private void`	`removeTemporaryClaim(StandardRepositoryRecord record)` Checks if the ContentClaim associated with this record should be removed, since the record is about to be updated to point to a new content claim.
`boolean`	`replaceState(StateMap oldValue, Map<String,String> newValue, Scope scope)`
`private void`	`resetReadClaim()`
`private void`	`resetState()`
`private void`	`resetWriteClaims()`
`private void`	`resetWriteClaims(boolean suppressExceptions)`
`void`	`rollback()`
`void`	`rollback(boolean penalize)`
`protected void`	`rollback(boolean penalize, boolean rollbackCheckpoint)`
`protected void`	`rollbackRecord(StandardRepositoryRecord record, boolean penalize)` Rolls back the Record in a manner that is appropriate for the context.
`void`	`setState(Map<String,String> state, Scope scope)`
`private void`	`setState(StateMap stateMap, Scope scope)`
`private String`	`summarizeEvents(StandardProcessSession.Checkpoint checkpoint)`
`String`	`toString()`
`void`	`transfer(Collection<FlowFile> flowFiles)`
`void`	`transfer(Collection<FlowFile> flowFiles, Relationship relationship)`
`void`	`transfer(FlowFile flowFile)`
`void`	`transfer(FlowFile flowFile, Relationship relationship)`
`private void`	`updateEventContentClaims(ProvenanceEventBuilder builder, FlowFile flowFile, StandardRepositoryRecord repoRecord)`
`private void`	`updateEventRepository(StandardProcessSession.Checkpoint checkpoint)`
`private void`	`updateLastQueuedDate(StandardRepositoryRecord record)`
`private void`	`updateLastQueuedDate(StandardRepositoryRecord record, Long lastQueueDate)`
`protected void`	`updateProvenanceRepo(StandardProcessSession.Checkpoint checkpoint)`
`private List<FlowFile>`	`validateRecordState(Collection<FlowFile> flowFiles)`
`private FlowFile`	`validateRecordState(FlowFile flowFile)`
`private FlowFile`	`validateRecordState(FlowFile flowFile, boolean allowRecursiveRead)`
`private void`	`verifyTaskActive()`
`OutputStream`	`write(FlowFile source)`
`FlowFile`	`write(FlowFile source, OutputStreamCallback writer)`
`FlowFile`	`write(FlowFile source, StreamCallback writer)`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

idGenerator

private static final AtomicLong idGenerator

enqueuedIndex

private static final AtomicLong enqueuedIndex

EMPTY_STATE_MAP

private static final StateMap EMPTY_STATE_MAP

VERBOSE_LOG_THRESHOLD
```
public static final int VERBOSE_LOG_THRESHOLD
```
See Also:

Constant Field Values

DEFAULT_FLOWFILE_PATH

public static final String DEFAULT_FLOWFILE_PATH

See Also:: Constant Field Values

LOG

private static final org.slf4j.Logger LOG

claimLog

private static final org.slf4j.Logger claimLog

MAX_ROLLBACK_FLOWFILES_TO_LOG
```
private static final int MAX_ROLLBACK_FLOWFILES_TO_LOG
```
See Also:

Constant Field Values

records

private final Map<Long,StandardRepositoryRecord> records

connectionCounts

private final Map<String,StandardFlowFileEvent> connectionCounts

unacknowledgedFlowFiles

private final Map<FlowFileQueue,Set<FlowFileRecord>> unacknowledgedFlowFiles

appendableStreams

private final Map<ContentClaim,org.apache.nifi.stream.io.ByteCountingOutputStream> appendableStreams

context

private final RepositoryContext context

taskTermination

private final TaskTermination taskTermination

readRecursionSet

private final Map<FlowFile,Integer> readRecursionSet

writeRecursionSet

private final Set<FlowFile> writeRecursionSet

deleteOnCommit

private final Map<FlowFile,Path> deleteOnCommit

sessionId
```
private final long sessionId
```

connectableDescription

private final String connectableDescription

countersOnCommit

private Map<String,Long> countersOnCommit

immediateCounters

private Map<String,Long> immediateCounters

removedFlowFiles

private final Set<String> removedFlowFiles

createdFlowFiles

private final Set<String> createdFlowFiles

provenanceReporter

private final InternalProvenanceReporter provenanceReporter

removedCount
```
private int removedCount
```

removedBytes
```
private long removedBytes
```

bytesRead
```
private long bytesRead
```

bytesWritten
```
private long bytesWritten
```

flowFilesIn
```
private int flowFilesIn
```

flowFilesOut
```
private int flowFilesOut
```

contentSizeIn
```
private long contentSizeIn
```

contentSizeOut
```
private long contentSizeOut
```

currentReadClaim
```
private ContentClaim currentReadClaim
```

currentReadClaimStream

private ContentClaimInputStream currentReadClaimStream

processingStartTime
```
private long processingStartTime
```

openInputStreams

private final Map<FlowFile,InputStream> openInputStreams

openOutputStreams

private final Map<FlowFile,OutputStream> openOutputStreams

generatedProvenanceEvents

private final Map<FlowFile,List<ProvenanceEventRecord>> generatedProvenanceEvents

forkEventBuilders

private final Map<FlowFile,ProvenanceEventBuilder> forkEventBuilders

checkpoint

private StandardProcessSession.Checkpoint checkpoint

claimCache

private final ContentClaimWriteCache claimCache

localState
```
private StateMap localState
```

clusterState
```
private StateMap clusterState
```

Constructor Detail

StandardProcessSession

public StandardProcessSession(RepositoryContext context,
                              TaskTermination taskTermination)

Method Detail

verifyTaskActive
```
private void verifyTaskActive()
```

getSessionId
```
protected long getSessionId()
```

closeStreams

private void closeStreams(Map<FlowFile,? extends Closeable> streamMap,
                          String action,
                          String streamType)

checkpoint
```
public void checkpoint()
```

checkpoint

private void checkpoint(boolean copyCollections)

commit
```
public void commit()
```
Specified by:

commit in interface ProcessSession

commit

protected void commit(StandardProcessSession.Checkpoint checkpoint)

updateEventRepository

private void updateEventRepository(StandardProcessSession.Checkpoint checkpoint)

combineCounters

private Map<String,Long> combineCounters(Map<String,Long> first,
                                         Map<String,Long> second)

addEventType

private void addEventType(Map<String,BitSet> map,
                          String id,
                          ProvenanceEventType eventType)

getRecord

private StandardRepositoryRecord getRecord(FlowFile flowFile)

updateProvenanceRepo

protected void updateProvenanceRepo(StandardProcessSession.Checkpoint checkpoint)

updateEventContentClaims

private void updateEventContentClaims(ProvenanceEventBuilder builder,
                                      FlowFile flowFile,
                                      StandardRepositoryRecord repoRecord)

enrich
```
public ProvenanceEventRecord enrich(ProvenanceEventRecord rawEvent,
                                    FlowFile flowFile,
                                    long commitNanos)
```
Description copied from interface: ProvenanceEventEnricher

Returns a new Provenance event that has been updated to contain the original and updated FlowFile attributes and content claim information.

Specified by:

enrich in interface ProvenanceEventEnricher

Parameters:

rawEvent - record

flowFile - flowfile

commitNanos - the time (in nanoseconds) when the associated session was committed

Returns:

new event record

enrich

private ProvenanceEventRecord enrich(ProvenanceEventRecord rawEvent,
                                     Map<String,FlowFileRecord> flowFileRecordMap,
                                     Map<Long,StandardRepositoryRecord> records,
                                     boolean updateAttributes,
                                     long commitNanos)

isSpuriousForkEvent
```
private boolean isSpuriousForkEvent(ProvenanceEventRecord event,
                                    Set<String> removedFlowFiles)
```
Checks if the given event is a spurious FORK, meaning that the FORK has a single child and that child was removed in this session. This happens when a Processor calls #create(FlowFile) and then removes the created FlowFile.

Parameters:

event - event

Returns:

true if spurious fork

isSpuriousRouteEvent
```
private boolean isSpuriousRouteEvent(ProvenanceEventRecord event,
                                     Map<Long,StandardRepositoryRecord> records)
```
Checks if the given event is a spurious ROUTE, meaning that the ROUTE indicates that a FlowFile was routed to a relationship with only 1 connection and that Connection is the Connection from which the FlowFile was pulled. I.e., the FlowFile was really routed nowhere.

Parameters:

event - event

records - records

Returns:

true if spurious route

rollback
```
public void rollback()
```
Specified by:

rollback in interface ProcessSession

rollback
```
public void rollback(boolean penalize)
```
Specified by:

rollback in interface ProcessSession

rollback

protected void rollback(boolean penalize,
                        boolean rollbackCheckpoint)

rollbackRecord
```
protected void rollbackRecord(StandardRepositoryRecord record,
                              boolean penalize)
```
Rolls back the Record in a manner that is appropriate for the context. The default implementation is to place the queue back on its original queue, if it exists, or just ignore it if it has no original queue. However, subclasses may wish to change the behavior for how Records are handled when a rollback occurs.

Parameters:

record - the Record that is to be rolled back

penalize - whether or not the Record should be penalized

loggableFlowfileInfo
```
private String loggableFlowfileInfo()
```

decrementClaimCount

private void decrementClaimCount(ContentClaim claim)

destroyContent

private void destroyContent(ContentClaim claim,
                            StandardRepositoryRecord repoRecord)

Destroys a ContentClaim that was being written to but is no longer needed

Parameters:: claim - claim to destroy

resetState
```
private void resetState()
```

acknowledgeRecords
```
private void acknowledgeRecords()
```

migrate

public void migrate(ProcessSession newOwner,
                    Collection<FlowFile> flowFiles)

Specified by:: migrate in interface ProcessSession

migrate

private void migrate(StandardProcessSession newOwner,
                     Collection<FlowFile> flowFiles)

summarizeEvents

private String summarizeEvents(StandardProcessSession.Checkpoint checkpoint)

formatNanos

private void formatNanos(long nanos,
                         StringBuilder sb)

incrementConnectionInputCounts

private void incrementConnectionInputCounts(Connection connection,
                                            RepositoryRecord record)

incrementConnectionInputCounts

private void incrementConnectionInputCounts(String connectionId,
                                            int flowFileCount,
                                            long bytes)

incrementConnectionOutputCounts

private void incrementConnectionOutputCounts(Connection connection,
                                             FlowFileRecord record)

incrementConnectionOutputCounts

private void incrementConnectionOutputCounts(String connectionId,
                                             int flowFileCount,
                                             long bytes)

registerDequeuedRecord

private void registerDequeuedRecord(FlowFileRecord flowFile,
                                    Connection connection)

handleConflictingId

private void handleConflictingId(FlowFileRecord flowFile,
                                 Connection connection,
                                 StandardRepositoryRecord conflict)

adjustCounter

public void adjustCounter(String name,
                          long delta,
                          boolean immediate)

Specified by:: adjustCounter in interface ProcessSession

adjustCounter

private void adjustCounter(String name,
                           long delta,
                           Map<String,Long> map)

get
```
public FlowFile get()
```
Specified by:

get in interface ProcessSession

get

public List<FlowFile> get(int maxResults)

Specified by:: get in interface ProcessSession

get

public List<FlowFile> get(FlowFileFilter filter)

Specified by:: get in interface ProcessSession

get

private List<FlowFile> get(StandardProcessSession.ConnectionPoller poller,
                           boolean lockAllQueues)

getQueueSize
```
public QueueSize getQueueSize()
```
Specified by:

getQueueSize in interface ProcessSession

create
```
public FlowFile create()
```
Specified by:

create in interface ProcessSession

create
```
public FlowFile create(FlowFile parent)
```
Specified by:

create in interface ProcessSession

create

public FlowFile create(Collection<FlowFile> parents)

Specified by:: create in interface ProcessSession

clone
```
public FlowFile clone(FlowFile example)
```
Specified by:

clone in interface ProcessSession

clone

public FlowFile clone(FlowFile example,
                      long offset,
                      long size)

Specified by:: clone in interface ProcessSession

registerForkEvent

private void registerForkEvent(FlowFile parent,
                               FlowFile child)

registerJoinEvent

private void registerJoinEvent(FlowFile child,
                               Collection<FlowFile> parents)

penalize
```
public FlowFile penalize(FlowFile flowFile)
```
Specified by:

penalize in interface ProcessSession

putAttribute

public FlowFile putAttribute(FlowFile flowFile,
                             String key,
                             String value)

Specified by:: putAttribute in interface ProcessSession

putAllAttributes

public FlowFile putAllAttributes(FlowFile flowFile,
                                 Map<String,String> attributes)

Specified by:: putAllAttributes in interface ProcessSession

removeAttribute

public FlowFile removeAttribute(FlowFile flowFile,
                                String key)

Specified by:: removeAttribute in interface ProcessSession

removeAllAttributes

public FlowFile removeAllAttributes(FlowFile flowFile,
                                    Set<String> keys)

Specified by:: removeAllAttributes in interface ProcessSession

removeAllAttributes

public FlowFile removeAllAttributes(FlowFile flowFile,
                                    Pattern keyPattern)

Specified by:: removeAllAttributes in interface ProcessSession

updateLastQueuedDate

private void updateLastQueuedDate(StandardRepositoryRecord record,
                                  Long lastQueueDate)

updateLastQueuedDate

private void updateLastQueuedDate(StandardRepositoryRecord record)

transfer

public void transfer(FlowFile flowFile,
                     Relationship relationship)

Specified by:: transfer in interface ProcessSession

transfer
```
public void transfer(FlowFile flowFile)
```
Specified by:

transfer in interface ProcessSession

transfer

public void transfer(Collection<FlowFile> flowFiles)

Specified by:: transfer in interface ProcessSession

transfer

public void transfer(Collection<FlowFile> flowFiles,
                     Relationship relationship)

Specified by:: transfer in interface ProcessSession

remove
```
public void remove(FlowFile flowFile)
```
Specified by:

remove in interface ProcessSession

remove

public void remove(Collection<FlowFile> flowFiles)

Specified by:: remove in interface ProcessSession

removeForkEvents

private void removeForkEvents(FlowFile flowFile)

expireFlowFiles
```
public void expireFlowFiles()
```

removeExpired

private void removeExpired(Set<FlowFileRecord> flowFiles,
                           Connection connection)

getInputStream

private InputStream getInputStream(FlowFile flowFile,
                                   ContentClaim claim,
                                   long offset,
                                   boolean allowCachingOfStream)
                            throws ContentNotFoundException

Throws:: ContentNotFoundException

read

public void read(FlowFile source,
                 InputStreamCallback reader)

Specified by:: read in interface ProcessSession

read

public void read(FlowFile source,
                 boolean allowSessionStreamManagement,
                 InputStreamCallback reader)

Specified by:: read in interface ProcessSession

read

public InputStream read(FlowFile source)

Specified by:: read in interface ProcessSession

createTaskTerminationStream

private InputStream createTaskTerminationStream(InputStream delegate)

createTaskTerminationStream

private OutputStream createTaskTerminationStream(OutputStream delegate)

incrementReadCount

private void incrementReadCount(FlowFile flowFile)

decrementReadCount

private void decrementReadCount(FlowFile flowFile)

merge

public FlowFile merge(Collection<FlowFile> sources,
                      FlowFile destination)

Specified by:: merge in interface ProcessSession

merge

public FlowFile merge(Collection<FlowFile> sources,
                      FlowFile destination,
                      byte[] header,
                      byte[] footer,
                      byte[] demarcator)

Specified by:: merge in interface ProcessSession

ensureNotAppending

private void ensureNotAppending(ContentClaim claim)
                         throws IOException

Throws:: IOException

write

public OutputStream write(FlowFile source)

Specified by:: write in interface ProcessSession

write

public FlowFile write(FlowFile source,
                      OutputStreamCallback writer)

Specified by:: write in interface ProcessSession

append

public FlowFile append(FlowFile source,
                       OutputStreamCallback writer)

Specified by:: append in interface ProcessSession

removeTemporaryClaim
```
private void removeTemporaryClaim(StandardRepositoryRecord record)
```
Checks if the ContentClaim associated with this record should be removed, since the record is about to be updated to point to a new content claim. If so, removes the working claim. This happens if & only if the content of this FlowFile has been modified since it was last committed to the FlowFile repository, because this indicates that the content is no longer needed and should be cleaned up.

Parameters:

record - record

resetWriteClaims
```
private void resetWriteClaims()
```

resetWriteClaims

private void resetWriteClaims(boolean suppressExceptions)

resetReadClaim
```
private void resetReadClaim()
```

write

public FlowFile write(FlowFile source,
                      StreamCallback writer)

Specified by:: write in interface ProcessSession

importFrom

public FlowFile importFrom(Path source,
                           boolean keepSourceFile,
                           FlowFile destination)

Specified by:: importFrom in interface ProcessSession

importFrom

public FlowFile importFrom(InputStream source,
                           FlowFile destination)

Specified by:: importFrom in interface ProcessSession

exportTo

public void exportTo(FlowFile source,
                     Path destination,
                     boolean append)

Specified by:: exportTo in interface ProcessSession

exportTo

public void exportTo(FlowFile source,
                     OutputStream destination)

Specified by:: exportTo in interface ProcessSession

handleContentNotFound

private void handleContentNotFound(ContentNotFoundException nfe,
                                   Collection<StandardRepositoryRecord> suspectRecords)

handleContentNotFound

private void handleContentNotFound(ContentNotFoundException nfe,
                                   StandardRepositoryRecord suspectRecord)

validateRecordState

private FlowFile validateRecordState(FlowFile flowFile)

validateRecordState

private FlowFile validateRecordState(FlowFile flowFile,
                                     boolean allowRecursiveRead)

validateRecordState

private List<FlowFile> validateRecordState(Collection<FlowFile> flowFiles)

isFlowFileKnown
```
boolean isFlowFileKnown(FlowFile flowFile)
```
Checks if a FlowFile is known in this session.

Parameters:

flowFile - the FlowFile to check

Returns:

true if the FlowFile is known in this session, false otherwise.

getMostRecent

private FlowFile getMostRecent(FlowFile flowFile)

intersectAttributes
```
private static Map<String,String> intersectAttributes(Collection<FlowFile> flowFileList)
```
Returns the attributes that are common to every FlowFile given. The key and value must match exactly.

Parameters:

flowFileList - a list of FlowFiles

Returns:

the common attributes

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

getProvenanceReporter
```
public ProvenanceReporter getProvenanceReporter()
```
Specified by:

getProvenanceReporter in interface ProcessSession

setState

public void setState(Map<String,String> state,
                     Scope scope)
              throws IOException

Specified by:: setState in interface ProcessSession
Throws:: IOException

setState

private void setState(StateMap stateMap,
                      Scope scope)

getState

public StateMap getState(Scope scope)
                  throws IOException

Specified by:: getState in interface ProcessSession
Throws:: IOException

replaceState

public boolean replaceState(StateMap oldValue,
                            Map<String,String> newValue,
                            Scope scope)
                     throws IOException

Specified by:: replaceState in interface ProcessSession
Throws:: IOException

clearState
```
public void clearState(Scope scope)
```
Specified by:

clearState in interface ProcessSession

toString
```
public String toString()
```
Overrides:

toString in class Object

Class StandardProcessSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idGenerator

enqueuedIndex

EMPTY_STATE_MAP

VERBOSE_LOG_THRESHOLD

DEFAULT_FLOWFILE_PATH

LOG

claimLog

MAX_ROLLBACK_FLOWFILES_TO_LOG

records

connectionCounts

unacknowledgedFlowFiles

appendableStreams

context

taskTermination

readRecursionSet

writeRecursionSet

deleteOnCommit

sessionId

connectableDescription

countersOnCommit

immediateCounters

removedFlowFiles

createdFlowFiles

provenanceReporter

removedCount

removedBytes

bytesRead

bytesWritten

flowFilesIn

flowFilesOut

contentSizeIn

contentSizeOut

currentReadClaim

currentReadClaimStream

processingStartTime

openInputStreams

openOutputStreams

generatedProvenanceEvents

forkEventBuilders

checkpoint

claimCache

localState

clusterState

Constructor Detail

StandardProcessSession

Method Detail

verifyTaskActive

getSessionId

closeStreams

checkpoint

checkpoint

commit

commit

updateEventRepository

combineCounters

addEventType

getRecord

updateProvenanceRepo

updateEventContentClaims

enrich

enrich

isSpuriousForkEvent

isSpuriousRouteEvent

rollback

rollback

rollback

rollbackRecord

loggableFlowfileInfo

decrementClaimCount

destroyContent

resetState

acknowledgeRecords

migrate