org.apache.nifi.controller.repository

Interface FlowFileRepository

All Superinterfaces:

AutoCloseable, Closeable

public interface FlowFileRepository
extends Closeable

Implementations must be thread safe

Method Summary

Methods

Modifier and Type	Method and Description
long	getMaxFlowFileIdentifier()
long	getNextFlowFileSequence()
long	getStorageCapacity()
long	getUsableStorageSpace()
void	initialize(ContentClaimManager claimManager) Initializes the Content Repository, providing to it the ContentClaimManager that is to be used for interacting with Content Claims
boolean	isVolatile()
long	loadFlowFiles(QueueProvider queueProvider, long minimumSequenceNumber) Loads all flow files found within the repository, establishes the content claims and their reference count
void	swapFlowFilesIn(String swapLocation, List<FlowFileRecord> flowFileRecords, FlowFileQueue flowFileQueue) Updates the Repository to indicate that the given FlowFileRecpords were Swapped In to memory
void	swapFlowFilesOut(List<FlowFileRecord> swappedOut, FlowFileQueue flowFileQueue, String swapLocation) Updates the Repository to indicate that the given FlowFileRecords were Swapped Out of memory
void	updateRepository(Collection<RepositoryRecord> records) Updates the repository with the given RepositoryRecords.

Methods inherited from interface java.io.Closeable

close

Method Detail

initialize

void initialize(ContentClaimManager claimManager)
                throws IOException

Initializes the Content Repository, providing to it the ContentClaimManager that is to be used for interacting with Content Claims

Parameters:

claimManager - for handling claims

Throws:

IOException - if unable to initialize repository

getStorageCapacity

long getStorageCapacity()
                        throws IOException

Returns:

the maximum number of bytes that can be stored in the underlying storage mechanism

Throws:

IOException - if computing capacity fails

getUsableStorageSpace

long getUsableStorageSpace()
                           throws IOException

Returns:

the number of bytes currently available for use by the underlying storage mechanism

Throws:

IOException - if computing usable space fails

updateRepository

void updateRepository(Collection<RepositoryRecord> records)
                      throws IOException

Updates the repository with the given RepositoryRecords.

Parameters:

records - the records to update the repository with

Throws:

IOException - if update fails

loadFlowFiles

long loadFlowFiles(QueueProvider queueProvider,
                 long minimumSequenceNumber)
                   throws IOException

Loads all flow files found within the repository, establishes the content claims and their reference count

Parameters:

queueProvider - the provider of FlowFile Queues into which the FlowFiles should be enqueued

minimumSequenceNumber - specifies the minimum value that should be returned by a call to getNextFlowFileSequence()

Returns:

index of highest flow file identifier

Throws:

IOException - if load fails

isVolatile

boolean isVolatile()

Returns:

true if the Repository is volatile (i.e., its data is lost upon application restart), false otherwise

getNextFlowFileSequence

long getNextFlowFileSequence()

Returns:

the next ID in sequence for creating FlowFiles.

getMaxFlowFileIdentifier

long getMaxFlowFileIdentifier()
                              throws IOException

Returns:

the max ID of all FlowFiles that currently exist in the repository.

Throws:

IOException - if computing max identifier fails

swapFlowFilesOut

void swapFlowFilesOut(List<FlowFileRecord> swappedOut,
                    FlowFileQueue flowFileQueue,
                    String swapLocation)
                      throws IOException

Updates the Repository to indicate that the given FlowFileRecords were Swapped Out of memory

Parameters:

swappedOut - the FlowFiles that were swapped out of memory

flowFileQueue - the queue that the FlowFiles belong to

swapLocation - the location to which the FlowFiles were swapped

Throws:

IOException - if swap fails

swapFlowFilesIn

void swapFlowFilesIn(String swapLocation,
                   List<FlowFileRecord> flowFileRecords,
                   FlowFileQueue flowFileQueue)
                     throws IOException

Updates the Repository to indicate that the given FlowFileRecpords were Swapped In to memory

Parameters:

swapLocation - the location (e.g., a filename) from which FlowFiles were recovered

flowFileRecords - the records that were swapped in

flowFileQueue - the queue that the FlowFiles belong to

Throws:

IOException - if swap fails