org.apache.nifi.controller.repository

Interface FlowFileSwapManager

public interface FlowFileSwapManager

Defines a mechanism by which FlowFiles can be move into external storage or memory so that they can be removed from the Java heap and vice-versa

Method Summary

Methods

Modifier and Type	Method and Description
void	purge() Removes all Swap information, permanently destroying any FlowFiles that have been swapped out
long	recoverSwappedFlowFiles(QueueProvider connectionProvider, ResourceClaimManager claimManager) Notifies FlowFile queues of the number of FlowFiles and content size of all FlowFiles that are currently swapped out
void	shutdown() Shuts down the manager
void	start(FlowFileRepository flowFileRepository, QueueProvider queueProvider, ResourceClaimManager claimManager, EventReporter reporter) Starts the Manager's background threads to start swapping FlowFiles in and out of memory

Method Detail

start

void start(FlowFileRepository flowFileRepository,
         QueueProvider queueProvider,
         ResourceClaimManager claimManager,
         EventReporter reporter)

Starts the Manager's background threads to start swapping FlowFiles in and out of memory

Parameters:

flowFileRepository - the FlowFileRepository that must be notified of any swapping in or out of FlowFiles

queueProvider - the provider of FlowFileQueue's so that FlowFiles can be obtained and restored

claimManager - the ContentClaimManager to use for interacting with Content Claims

reporter - the EventReporter that can be used for notifying users of important events

shutdown

void shutdown()

Shuts down the manager

purge

void purge()

Removes all Swap information, permanently destroying any FlowFiles that have been swapped out

recoverSwappedFlowFiles

long recoverSwappedFlowFiles(QueueProvider connectionProvider,
                           ResourceClaimManager claimManager)

Notifies FlowFile queues of the number of FlowFiles and content size of all FlowFiles that are currently swapped out

Parameters:

connectionProvider - provider

claimManager - manager

Returns:

how many flowfiles have been recovered