Package org.apache.nifi.processor.util.bin

Class BinManager

java.lang.Object

org.apache.nifi.processor.util.bin.BinManager

public class BinManager
extends Object

This class is thread safe

Field Summary

Fields

Modifier and Type	Field	Description
private int	binCount
private final AtomicReference<String>	fileCountAttribute
private final Map<String,List<Bin>>	groupBinMap
private final AtomicInteger	maxBinAgeSeconds
private final AtomicInteger	maxEntries
private final AtomicLong	maxSizeBytes
private final AtomicInteger	minEntries
private final AtomicLong	minSizeBytes
private final Lock	rLock
private final ReentrantReadWriteLock	rwLock
private final Lock	wLock

Constructor Summary

Constructors

Constructor	Description
BinManager()

Method Summary

Modifier and Type	Method	Description
boolean	containsOldBins()
int	getBinCount()
String	getFileCountAttribute()
Set<FlowFile>	offer(String groupIdentifier, Collection<FlowFile> flowFiles, ProcessSession session, ProcessSessionFactory sessionFactory)	Adds the given flowFiles to the first available bin in which it fits for the given group or creates a new bin in the specified group if necessary.
boolean	offer(String groupIdentifier, FlowFile flowFile, ProcessSession session, ProcessSessionFactory sessionFactory)	Adds the given flowFile to the first available bin in which it fits for the given group or creates a new bin in the specified group if necessary.
void	purge()
Bin	removeOldestBin()
Collection<Bin>	removeReadyBins(boolean relaxFullnessConstraint)	Finds all bins that are considered full and removes them from the manager.
void	setFileCountAttribute(String fileCountAttribute)
void	setMaxBinAge(int seconds)
void	setMaximumEntries(int maximumEntries)
void	setMaximumSize(long numBytes)
void	setMinimumEntries(int minimumEntries)
void	setMinimumSize(long numBytes)

Methods inherited from class java.lang.Object

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

Field Details

minSizeBytes

private final AtomicLong minSizeBytes

maxSizeBytes

private final AtomicLong maxSizeBytes

minEntries

private final AtomicInteger minEntries

maxEntries

private final AtomicInteger maxEntries

fileCountAttribute

private final AtomicReference<String> fileCountAttribute

maxBinAgeSeconds

private final AtomicInteger maxBinAgeSeconds

groupBinMap

private final Map<String,List<Bin>> groupBinMap

rwLock

private final ReentrantReadWriteLock rwLock

rLock

private final Lock rLock

wLock

private final Lock wLock

binCount

private int binCount

Constructor Details

BinManager

public BinManager()

Method Details

purge

public void purge()

setFileCountAttribute

public void setFileCountAttribute(String fileCountAttribute)

getFileCountAttribute

public String getFileCountAttribute()

setMinimumEntries

public void setMinimumEntries(int minimumEntries)

setMaximumEntries

public void setMaximumEntries(int maximumEntries)

getBinCount

public int getBinCount()

setMinimumSize

public void setMinimumSize(long numBytes)

setMaximumSize

public void setMaximumSize(long numBytes)

setMaxBinAge

public void setMaxBinAge(int seconds)

offer

public boolean offer(String groupIdentifier,
 FlowFile flowFile,
 ProcessSession session,
 ProcessSessionFactory sessionFactory)

Adds the given flowFile to the first available bin in which it fits for the given group or creates a new bin in the specified group if necessary.

Parameters:

groupIdentifier - the group to which the flow file belongs; can be null

flowFile - the flow file to bin

session - the ProcessSession to which the FlowFile belongs

sessionFactory - a ProcessSessionFactory that can be used to create a new ProcessSession in order to create a new bin if necessary

Returns:

true if added; false if no bin exists which can fit this item and no bin can be created based on current min/max criteria

offer

public Set<FlowFile> offer(String groupIdentifier,
 Collection<FlowFile> flowFiles,
 ProcessSession session,
 ProcessSessionFactory sessionFactory)

Adds the given flowFiles to the first available bin in which it fits for the given group or creates a new bin in the specified group if necessary.

Parameters:

groupIdentifier - the group to which the flow file belongs; can be null

flowFiles - the flow files to bin

session - the ProcessSession to which the FlowFiles belong

sessionFactory - a ProcessSessionFactory that can be used to create a new ProcessSession in order to create a new bin if necessary

Returns:

all of the FlowFiles that could not be successfully binned

removeReadyBins

public Collection<Bin> removeReadyBins(boolean relaxFullnessConstraint)

Finds all bins that are considered full and removes them from the manager.

Parameters:

relaxFullnessConstraint - if false will require bins to be full before considered ready; if true bins only have to meet their minimum size criteria or be 'old' and then they'll be considered ready

Returns:

bins that are considered full

removeOldestBin

public Bin removeOldestBin()

containsOldBins

public boolean containsOldBins()

Returns:

true if any current bins are older than the allowable max