org.apache.nifi.controller.repository

Class VolatileFlowFileRepository

java.lang.Object

org.apache.nifi.controller.repository.VolatileFlowFileRepository

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, FlowFileRepository

public class VolatileFlowFileRepository
extends java.lang.Object
implements FlowFileRepository

An in-memory implementation of the FlowFileRepository. Upon restart, all FlowFiles will be discarded, including those that have been swapped out by a FlowFileSwapManager.

Constructor Summary

Constructors

Constructor and Description
VolatileFlowFileRepository()

Method Summary

Modifier and Type	Method and Description
void	close()
long	getMaxFlowFileIdentifier()
long	getNextFlowFileSequence()
long	getStorageCapacity()
long	getUsableStorageSpace()
void	initialize(ResourceClaimManager 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(java.lang.String swapLocation, java.util.List<FlowFileRecord> flowFileRecords, FlowFileQueue queue) Updates the Repository to indicate that the given FlowFileRecords were Swapped In to memory
void	swapFlowFilesOut(java.util.List<FlowFileRecord> swappedOut, FlowFileQueue queue, java.lang.String swapLocation) Updates the Repository to indicate that the given FlowFileRecords were Swapped Out of memory
void	updateRepository(java.util.Collection<RepositoryRecord> records) Updates the repository with the given RepositoryRecords.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VolatileFlowFileRepository

public VolatileFlowFileRepository()

Method Detail

initialize

public void initialize(ResourceClaimManager claimManager)

Description copied from interface: FlowFileRepository

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

Specified by:

initialize in interface FlowFileRepository

Parameters:

claimManager - for handling claims

isVolatile

public boolean isVolatile()

Specified by:

isVolatile in interface FlowFileRepository

Returns:

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

getStorageCapacity

public long getStorageCapacity()
                        throws java.io.IOException

Specified by:

getStorageCapacity in interface FlowFileRepository

Returns:

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

Throws:

java.io.IOException - if computing capacity fails

getUsableStorageSpace

public long getUsableStorageSpace()
                           throws java.io.IOException

Specified by:

getUsableStorageSpace in interface FlowFileRepository

Returns:

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

Throws:

java.io.IOException - if computing usable space fails

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

updateRepository

public void updateRepository(java.util.Collection<RepositoryRecord> records)
                      throws java.io.IOException

Description copied from interface: FlowFileRepository

Updates the repository with the given RepositoryRecords.

Specified by:

updateRepository in interface FlowFileRepository

Parameters:

records - the records to update the repository with

Throws:

java.io.IOException - if update fails

loadFlowFiles

public long loadFlowFiles(QueueProvider queueProvider,
                          long minimumSequenceNumber)
                   throws java.io.IOException

Description copied from interface: FlowFileRepository

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

Specified by:

loadFlowFiles in interface FlowFileRepository

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 FlowFileRepository.getNextFlowFileSequence()

Returns:

index of highest flow file identifier

Throws:

java.io.IOException - if load fails

getNextFlowFileSequence

public long getNextFlowFileSequence()

Specified by:

getNextFlowFileSequence in interface FlowFileRepository

Returns:

the next ID in sequence for creating FlowFiles.

getMaxFlowFileIdentifier

public long getMaxFlowFileIdentifier()
                              throws java.io.IOException

Specified by:

getMaxFlowFileIdentifier in interface FlowFileRepository

Returns:

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

Throws:

java.io.IOException - if computing max identifier fails

swapFlowFilesIn

public void swapFlowFilesIn(java.lang.String swapLocation,
                            java.util.List<FlowFileRecord> flowFileRecords,
                            FlowFileQueue queue)
                     throws java.io.IOException

Description copied from interface: FlowFileRepository

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

Specified by:

swapFlowFilesIn in interface FlowFileRepository

Parameters:

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

flowFileRecords - the records that were swapped in

queue - the queue that the FlowFiles belong to

Throws:

java.io.IOException - if swap fails

swapFlowFilesOut

public void swapFlowFilesOut(java.util.List<FlowFileRecord> swappedOut,
                             FlowFileQueue queue,
                             java.lang.String swapLocation)
                      throws java.io.IOException

Description copied from interface: FlowFileRepository

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

Specified by:

swapFlowFilesOut in interface FlowFileRepository

Parameters:

swappedOut - the FlowFiles that were swapped out of memory

queue - the queue that the FlowFiles belong to

swapLocation - the location to which the FlowFiles were swapped

Throws:

java.io.IOException - if swap fails