org.apache.nifi.controller

Interface FlowFileQueue

public interface FlowFileQueue

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge(Collection<FlowFileRecord> flowFiles)
void	acknowledge(FlowFileRecord flowFile)
long	contentSize()
long	drainQueue(Queue<FlowFileRecord> sourceQueue, List<FlowFileRecord> destination, int maxResults, Set<FlowFileRecord> expiredRecords) Drains flow files from the given source queue into the given destination list.
QueueSize	getActiveQueueSize()
String	getBackPressureDataSizeThreshold()
long	getBackPressureObjectThreshold()
String	getFlowFileExpiration()
int	getFlowFileExpiration(TimeUnit timeUnit)
String	getIdentifier()
List<FlowFilePrioritizer>	getPriorities()
int	getSwapQueueSize()
int	getSwapRecordCount()
int	getSwapThreshold() Returns the minimum number of FlowFiles that must be present in order for FlowFiles to begin being swapped out of the queue
void	incrementSwapCount(int numRecords, long contentSize) Updates the internal counters of how much data is queued, based on swapped data that is being restored.
boolean	isActiveQueueEmpty()
boolean	isEmpty()
boolean	isFull()
List<FlowFileRecord>	poll(FlowFileFilter filter, Set<FlowFileRecord> expiredRecords)
List<FlowFileRecord>	poll(int maxResults, Set<FlowFileRecord> expiredRecords)
FlowFileRecord	poll(Set<FlowFileRecord> expiredRecords)
List<FlowFileRecord>	pollSwappableRecords() Removes all records from the internal swap queue and returns them.
void	put(FlowFileRecord file) places the given file into the queue
void	putAll(Collection<FlowFileRecord> files) places the given files into the queue
void	putSwappedRecords(Collection<FlowFileRecord> records) Restores the records from swap space into this queue, adding the records that have expired to the given set instead of enqueuing them.
void	setBackPressureDataSizeThreshold(String maxDataSize) Establishes this queue's preferred maximum data size.
void	setBackPressureObjectThreshold(long maxQueueSize) Establishes this queue's preferred maximum work load.
void	setFlowFileExpiration(String flowExpirationPeriod)
void	setPriorities(List<FlowFilePrioritizer> newPriorities) Resets the comparator used by this queue to maintain order.
QueueSize	size()
int	unswappedSize() Returns the number of FlowFiles that are enqueued and not swapped

Method Detail

getIdentifier

String getIdentifier()

Returns:

the unique identifier for this FlowFileQueue

getPriorities

List<FlowFilePrioritizer> getPriorities()

Returns:

list of processing priorities for this queue

getSwapThreshold

int getSwapThreshold()

Returns the minimum number of FlowFiles that must be present in order for FlowFiles to begin being swapped out of the queue

Returns:

setPriorities

void setPriorities(List<FlowFilePrioritizer> newPriorities)

Resets the comparator used by this queue to maintain order.

Parameters:

newPriorities - the ordered list of prioritizers to use to determine order within this queue.

Throws:

NullPointerException - if arg is null

setBackPressureObjectThreshold

void setBackPressureObjectThreshold(long maxQueueSize)

Establishes this queue's preferred maximum work load.

Parameters:

maxQueueSize - the maximum number of flow files this processor recommends having in its work queue at any one time

getBackPressureObjectThreshold

long getBackPressureObjectThreshold()

Returns:

maximum number of flow files that should be queued up at any one time

setBackPressureDataSizeThreshold

void setBackPressureDataSizeThreshold(String maxDataSize)

Establishes this queue's preferred maximum data size.

Parameters:

maxDataSize -

getBackPressureDataSizeThreshold

String getBackPressureDataSizeThreshold()

Returns:

maximum data size that should be queued up at any one time

size

QueueSize size()

contentSize

long contentSize()

Returns:

total size in bytes of the queue flow file's content

isEmpty

boolean isEmpty()

Returns:

true if no items queue; false otherwise

isActiveQueueEmpty

boolean isActiveQueueEmpty()

Returns:

true if the active queue is empty; false otherwise. The Active queue contains those FlowFiles that can be processed immediately and does not include those FlowFiles that have been swapped out or are currently being processed

getActiveQueueSize

QueueSize getActiveQueueSize()

acknowledge

void acknowledge(FlowFileRecord flowFile)

acknowledge

void acknowledge(Collection<FlowFileRecord> flowFiles)

isFull

boolean isFull()

Returns:

true if maximum queue size has been reached or exceeded; false otherwise

put

void put(FlowFileRecord file)

places the given file into the queue

Parameters:

file -

putAll

void putAll(Collection<FlowFileRecord> files)

places the given files into the queue

Parameters:

files -

pollSwappableRecords

List<FlowFileRecord> pollSwappableRecords()

Removes all records from the internal swap queue and returns them.

Returns:

putSwappedRecords

void putSwappedRecords(Collection<FlowFileRecord> records)

Restores the records from swap space into this queue, adding the records that have expired to the given set instead of enqueuing them.

Parameters:

records -

incrementSwapCount

void incrementSwapCount(int numRecords,
                      long contentSize)

Updates the internal counters of how much data is queued, based on swapped data that is being restored.

Parameters:

numRecords -

contentSize -

unswappedSize

int unswappedSize()

Returns the number of FlowFiles that are enqueued and not swapped

Returns:

getSwapRecordCount

int getSwapRecordCount()

getSwapQueueSize

int getSwapQueueSize()

poll

FlowFileRecord poll(Set<FlowFileRecord> expiredRecords)

Parameters:

expiredRecords -

Returns:

the next flow file on the queue; null if empty

poll

List<FlowFileRecord> poll(int maxResults,
                        Set<FlowFileRecord> expiredRecords)

Parameters:

maxResults -

expiredRecords -

Returns:

the next flow files on the queue up to the max results; null if empty

drainQueue

long drainQueue(Queue<FlowFileRecord> sourceQueue,
              List<FlowFileRecord> destination,
              int maxResults,
              Set<FlowFileRecord> expiredRecords)

Drains flow files from the given source queue into the given destination list.

Parameters:

sourceQueue -

destination -

maxResults - max number to drain

expiredRecords -

Returns:

size (bytes) of flow files drained from queue

poll

List<FlowFileRecord> poll(FlowFileFilter filter,
                        Set<FlowFileRecord> expiredRecords)

getFlowFileExpiration

String getFlowFileExpiration()

getFlowFileExpiration

int getFlowFileExpiration(TimeUnit timeUnit)

setFlowFileExpiration

void setFlowFileExpiration(String flowExpirationPeriod)