Package org.apache.nifi.util

Class MockProcessSession

java.lang.Object

org.apache.nifi.util.MockProcessSession

All Implemented Interfaces:

ProcessSession

public class MockProcessSession
extends Object
implements ProcessSession

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowSynchronousCommits
private final Set<Long>	beingProcessed
private boolean	committed
private final Map<String,Long>	counterMap
private final Set<Long>	created
private final Map<Long,MockFlowFile>	currentVersions
private final boolean	enforceStreamsClosed
private static final AtomicLong	enqueuedIndex
private final Map<FlowFile,InputStream>	openInputStreams
private final Map<FlowFile,OutputStream>	openOutputStreams
private final Map<Long,MockFlowFile>	originalVersions
private final List<MockFlowFile>	penalized
private final Processor	processor
private final MockFlowFileQueue	processorQueue
private final MockProvenanceReporter	provenanceReporter
private final Map<FlowFile,Integer>	readRecursionSet
private final Set<Long>	removedFlowFiles
private boolean	rolledback
private final SharedSessionState	sharedState
private final StateManager	stateManager
private final Map<Relationship,List<MockFlowFile>>	transferMap
private final Set<FlowFile>	writeRecursionSet

Constructor Summary

Constructors

Constructor	Description
MockProcessSession(SharedSessionState sharedState, Processor processor)
MockProcessSession(SharedSessionState sharedState, Processor processor, boolean enforceStreamsClosed, StateManager stateManager)
MockProcessSession(SharedSessionState sharedState, Processor processor, boolean enforceStreamsClosed, StateManager stateManager, boolean allowSynchronousCommits)
MockProcessSession(SharedSessionState sharedState, Processor processor, StateManager stateManager)

Method Summary

Modifier and Type	Method	Description
void	adjustCounter(String name, long delta, boolean immediate)
FlowFile	append(FlowFile flowFile, OutputStreamCallback callback)
void	assertAllFlowFiles(Relationship relationship, FlowFileValidator validator)	Asserts that all FlowFiles that were transferred in the given relationship are compliant with the given validator.
void	assertAllFlowFiles(FlowFileValidator validator)	Asserts that all FlowFiles that were transferred are compliant with the given validator.
void	assertAllFlowFilesTransferred(String relationship)	Asserts that all FlowFiles that were transferred were transferred to the given relationship
void	assertAllFlowFilesTransferred(String relationship, int count)	Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count
void	assertAllFlowFilesTransferred(Relationship relationship)	Asserts that all FlowFiles that were transferred were transferred to the given relationship
void	assertAllFlowFilesTransferred(Relationship relationship, int count)	Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count
void	assertCommitted()	Assert that the session has been committed
void	assertNotCommitted()	Assert that the session has not been committed
void	assertNotRolledBack()	Assert that rollback() has not been called
void	assertQueueEmpty()	Assert that there are no FlowFiles left on the input queue.
void	assertQueueNotEmpty()	Assert that at least one FlowFile is on the input queue
void	assertRolledBack()	Assert that rollback() has been called
void	assertTransferCount(String relationship, int count)	Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
void	assertTransferCount(Relationship relationship, int count)	Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
void	clearCommitted()	Clear the 'committed' flag so that we can test that the next iteration of Processor.onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory) commits or rolls back the session
void	clearRollback()	Clear the 'rolledBack' flag so that we can test that the next iteration of Processor.onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory) commits or rolls back the session
void	clearState(Scope scope)
void	clearTransferState()	Removes all state information about FlowFiles that have been transferred
MockFlowFile	clone(FlowFile flowFile)
MockFlowFile	clone(FlowFile flowFile, long offset, long size)
private void	closeStreams(Map<FlowFile,? extends Closeable> streamMap, boolean enforceClosed)
void	commit()
void	commitAsync()
void	commitAsync(Runnable onSuccess, Consumer<Throwable> onFailure)
private void	commitInternal()
MockFlowFile	create()
MockFlowFile	create(Collection<FlowFile> flowFiles)
MockFlowFile	create(FlowFile flowFile)
MockFlowFile	createFlowFile(byte[] data)
MockFlowFile	createFlowFile(byte[] data, Map<String,String> attrs)
MockFlowFile	createFlowFile(File file)
private void	decrementReadCount(FlowFile flowFile)
void	exportTo(FlowFile flowFile, OutputStream out)
void	exportTo(FlowFile flowFile, Path path, boolean append)
MockFlowFile	get()
List<FlowFile>	get(int maxResults)
List<FlowFile>	get(FlowFileFilter filter)
byte[]	getContentAsByteArray(MockFlowFile flowFile)
List<MockFlowFile>	getFlowFilesForRelationship(String relationship)
List<MockFlowFile>	getFlowFilesForRelationship(Relationship relationship)
List<MockFlowFile>	getPenalizedFlowFiles()
ProvenanceReporter	getProvenanceReporter()
QueueSize	getQueueSize()
int	getRemovedCount()
StateMap	getState(Scope scope)
MockFlowFile	importFrom(InputStream in, FlowFile flowFile)
MockFlowFile	importFrom(Path path, boolean keepSourceFile, FlowFile flowFile)
private void	incrementReadCount(FlowFile flowFile)
private FlowFile	inheritAttributes(Collection<FlowFile> sources, FlowFile destination)	Inherits the attributes from the given source flow files into the destination flow file.
private FlowFile	inheritAttributes(FlowFile source, FlowFile destination)	Inherits the attributes from the given source flow file into another flow file.
private static Map<String,String>	intersectAttributes(Collection<FlowFile> flowFileList)	Returns the attributes that are common to every flow file given.
(package private) boolean	isFlowFileKnown(FlowFile flowFile)	Checks if a FlowFile is known in this session.
MockFlowFile	merge(Collection<FlowFile> sources, FlowFile destination)
MockFlowFile	merge(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator)
void	migrate(ProcessSession newOwner)
void	migrate(ProcessSession newOwner, Collection<FlowFile> flowFiles)
private void	migrate(MockProcessSession newOwner, Collection<MockFlowFile> flowFiles)
MockFlowFile	penalize(FlowFile flowFile)
MockFlowFile	putAllAttributes(FlowFile flowFile, Map<String,String> attrs)
MockFlowFile	putAttribute(FlowFile flowFile, String attrName, String attrValue)
InputStream	read(FlowFile flowFile)
void	read(FlowFile flowFile, InputStreamCallback callback)
private byte[]	readFully(InputStream in)
void	remove(Collection<FlowFile> flowFiles)
void	remove(FlowFile flowFile)
MockFlowFile	removeAllAttributes(FlowFile flowFile, Pattern keyPattern)
MockFlowFile	removeAllAttributes(FlowFile flowFile, Set<String> attrNames)
MockFlowFile	removeAttribute(FlowFile flowFile, String attrName)
boolean	replaceState(StateMap oldValue, Map<String,String> newValue, Scope scope)
void	rollback()
void	rollback(boolean penalize)
void	setState(Map<String,String> state, Scope scope)
void	transfer(Collection<FlowFile> flowFiles)
void	transfer(Collection<FlowFile> flowFiles, Relationship relationship)
void	transfer(FlowFile flowFile)
void	transfer(FlowFile flowFile, Relationship relationship)
MockFlowFile	unpenalize(FlowFile flowFile)
private void	updateLastQueuedDate(MockFlowFile mockFlowFile)
private void	updateStateWithNewFlowFile(MockFlowFile newFlowFile)
private List<FlowFile>	validateState(Collection<FlowFile> flowFiles)
private MockFlowFile	validateState(FlowFile flowFile)
OutputStream	write(FlowFile flowFile)
MockFlowFile	write(FlowFile flowFile, OutputStreamCallback callback)
MockFlowFile	write(FlowFile flowFile, StreamCallback callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.ProcessSession

commitAsync

Field Details

transferMap

private final Map<Relationship,List<MockFlowFile>> transferMap

processorQueue

private final MockFlowFileQueue processorQueue

beingProcessed

private final Set<Long> beingProcessed

created

private final Set<Long> created

penalized

private final List<MockFlowFile> penalized

processor

private final Processor processor

currentVersions

private final Map<Long,MockFlowFile> currentVersions

originalVersions

private final Map<Long,MockFlowFile> originalVersions

sharedState

private final SharedSessionState sharedState

counterMap

private final Map<String,Long> counterMap

readRecursionSet

private final Map<FlowFile,Integer> readRecursionSet

writeRecursionSet

private final Set<FlowFile> writeRecursionSet

provenanceReporter

private final MockProvenanceReporter provenanceReporter

enforceStreamsClosed

private final boolean enforceStreamsClosed

openInputStreams

private final Map<FlowFile,InputStream> openInputStreams

openOutputStreams

private final Map<FlowFile,OutputStream> openOutputStreams

stateManager

private final StateManager stateManager

allowSynchronousCommits

private final boolean allowSynchronousCommits

committed

private boolean committed

rolledback

private boolean rolledback

removedFlowFiles

private final Set<Long> removedFlowFiles

enqueuedIndex

private static final AtomicLong enqueuedIndex

Constructor Details

MockProcessSession

public MockProcessSession(SharedSessionState sharedState,
 Processor processor)

MockProcessSession

public MockProcessSession(SharedSessionState sharedState,
 Processor processor,
 StateManager stateManager)

MockProcessSession

public MockProcessSession(SharedSessionState sharedState,
 Processor processor,
 boolean enforceStreamsClosed,
 StateManager stateManager)

MockProcessSession

public MockProcessSession(SharedSessionState sharedState,
 Processor processor,
 boolean enforceStreamsClosed,
 StateManager stateManager,
 boolean allowSynchronousCommits)

Method Details

adjustCounter

public void adjustCounter(String name,
 long delta,
 boolean immediate)

Specified by:

adjustCounter in interface ProcessSession

migrate

public void migrate(ProcessSession newOwner)

Specified by:

migrate in interface ProcessSession

migrate

public void migrate(ProcessSession newOwner,
 Collection<FlowFile> flowFiles)

Specified by:

migrate in interface ProcessSession

migrate

private void migrate(MockProcessSession newOwner,
 Collection<MockFlowFile> flowFiles)

clone

public MockFlowFile clone(FlowFile flowFile)

Specified by:

clone in interface ProcessSession

clone

public MockFlowFile clone(FlowFile flowFile,
 long offset,
 long size)

Specified by:

clone in interface ProcessSession

closeStreams

private void closeStreams(Map<FlowFile,? extends Closeable> streamMap,
 boolean enforceClosed)

commit

public void commit()

Specified by:

commit in interface ProcessSession

commitInternal

private void commitInternal()

commitAsync

public void commitAsync()

Specified by:

commitAsync in interface ProcessSession

commitAsync

public void commitAsync(Runnable onSuccess,
 Consumer<Throwable> onFailure)

Specified by:

commitAsync in interface ProcessSession

clearCommitted

public void clearCommitted()

Clear the 'committed' flag so that we can test that the next iteration of Processor.onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory) commits or rolls back the session

clearRollback

public void clearRollback()

Clear the 'rolledBack' flag so that we can test that the next iteration of Processor.onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory) commits or rolls back the session

create

public MockFlowFile create()

Specified by:

create in interface ProcessSession

create

public MockFlowFile create(FlowFile flowFile)

Specified by:

create in interface ProcessSession

create

public MockFlowFile create(Collection<FlowFile> flowFiles)

Specified by:

create in interface ProcessSession

exportTo

public void exportTo(FlowFile flowFile,
 OutputStream out)

Specified by:

exportTo in interface ProcessSession

exportTo

public void exportTo(FlowFile flowFile,
 Path path,
 boolean append)

Specified by:

exportTo in interface ProcessSession

get

public MockFlowFile get()

Specified by:

get in interface ProcessSession

get

public List<FlowFile> get(int maxResults)

Specified by:

get in interface ProcessSession

get

public List<FlowFile> get(FlowFileFilter filter)

Specified by:

get in interface ProcessSession

getQueueSize

public QueueSize getQueueSize()

Specified by:

getQueueSize in interface ProcessSession

importFrom

public MockFlowFile importFrom(InputStream in,
 FlowFile flowFile)

Specified by:

importFrom in interface ProcessSession

importFrom

public MockFlowFile importFrom(Path path,
 boolean keepSourceFile,
 FlowFile flowFile)

Specified by:

importFrom in interface ProcessSession

merge

public MockFlowFile merge(Collection<FlowFile> sources,
 FlowFile destination)

Specified by:

merge in interface ProcessSession

putAllAttributes

public MockFlowFile putAllAttributes(FlowFile flowFile,
 Map<String,String> attrs)

Specified by:

putAllAttributes in interface ProcessSession

putAttribute

public MockFlowFile putAttribute(FlowFile flowFile,
 String attrName,
 String attrValue)

Specified by:

putAttribute in interface ProcessSession

read

public void read(FlowFile flowFile,
 InputStreamCallback callback)

Specified by:

read in interface ProcessSession

incrementReadCount

private void incrementReadCount(FlowFile flowFile)

decrementReadCount

private void decrementReadCount(FlowFile flowFile)

read

public InputStream read(FlowFile flowFile)

Specified by:

read in interface ProcessSession

remove

public void remove(FlowFile flowFile)

Specified by:

remove in interface ProcessSession

remove

public void remove(Collection<FlowFile> flowFiles)

Specified by:

remove in interface ProcessSession

removeAllAttributes

public MockFlowFile removeAllAttributes(FlowFile flowFile,
 Set<String> attrNames)

Specified by:

removeAllAttributes in interface ProcessSession

removeAllAttributes

public MockFlowFile removeAllAttributes(FlowFile flowFile,
 Pattern keyPattern)

Specified by:

removeAllAttributes in interface ProcessSession

removeAttribute

public MockFlowFile removeAttribute(FlowFile flowFile,
 String attrName)

Specified by:

removeAttribute in interface ProcessSession

rollback

public void rollback()

Specified by:

rollback in interface ProcessSession

rollback

public void rollback(boolean penalize)

Specified by:

rollback in interface ProcessSession

transfer

public void transfer(FlowFile flowFile)

Specified by:

transfer in interface ProcessSession

updateLastQueuedDate

private void updateLastQueuedDate(MockFlowFile mockFlowFile)

updateStateWithNewFlowFile

private void updateStateWithNewFlowFile(MockFlowFile newFlowFile)

transfer

public void transfer(Collection<FlowFile> flowFiles)

Specified by:

transfer in interface ProcessSession

transfer

public void transfer(FlowFile flowFile,
 Relationship relationship)

Specified by:

transfer in interface ProcessSession

transfer

public void transfer(Collection<FlowFile> flowFiles,
 Relationship relationship)

Specified by:

transfer in interface ProcessSession

write

public MockFlowFile write(FlowFile flowFile,
 OutputStreamCallback callback)

Specified by:

write in interface ProcessSession

write

public OutputStream write(FlowFile flowFile)

Specified by:

write in interface ProcessSession

append

public FlowFile append(FlowFile flowFile,
 OutputStreamCallback callback)

Specified by:

append in interface ProcessSession

write

public MockFlowFile write(FlowFile flowFile,
 StreamCallback callback)

Specified by:

write in interface ProcessSession

readFully

private byte[] readFully(InputStream in)
                  throws IOException

Throws:

IOException

getFlowFilesForRelationship

public List<MockFlowFile> getFlowFilesForRelationship(Relationship relationship)

getPenalizedFlowFiles

public List<MockFlowFile> getPenalizedFlowFiles()

getFlowFilesForRelationship

public List<MockFlowFile> getFlowFilesForRelationship(String relationship)

Parameters:

relationship - to get flowfiles for

Returns:

a List of FlowFiles in the order in which they were transferred to the given relationship

createFlowFile

public MockFlowFile createFlowFile(File file)
                            throws IOException

Throws:

IOException

createFlowFile

public MockFlowFile createFlowFile(byte[] data)

createFlowFile

public MockFlowFile createFlowFile(byte[] data,
 Map<String,String> attrs)

merge

public MockFlowFile merge(Collection<FlowFile> sources,
 FlowFile destination,
 byte[] header,
 byte[] footer,
 byte[] demarcator)

Specified by:

merge in interface ProcessSession

validateState

private List<FlowFile> validateState(Collection<FlowFile> flowFiles)

validateState

private MockFlowFile validateState(FlowFile flowFile)

inheritAttributes

private FlowFile inheritAttributes(FlowFile source,
 FlowFile destination)

Inherits the attributes from the given source flow file into another flow file. The UUID of the source becomes the parent UUID of this flow file. If a parent uuid had previously been established it will be replaced by the uuid of the given source

Parameters:

source - the FlowFile from which to copy attributes

destination - the FlowFile to which to copy attributes

inheritAttributes

private FlowFile inheritAttributes(Collection<FlowFile> sources,
 FlowFile destination)

Inherits the attributes from the given source flow files into the destination flow file. The UUIDs of the sources becomes the parent UUIDs of the destination flow file. Only attributes which is common to all source items is copied into this flow files attributes. Any previously established parent UUIDs will be replaced by the UUIDs of the sources. It will capture the uuid of a certain number of source objects and may not capture all of them. How many it will capture is unspecified.

Parameters:

sources - to inherit common attributes from

intersectAttributes

private static Map<String,String> intersectAttributes(Collection<FlowFile> flowFileList)

Returns the attributes that are common to every flow file given. The key and value must match exactly.

Parameters:

flowFileList - a list of flow files

Returns:

the common attributes

assertCommitted

public void assertCommitted()

Assert that the session has been committed

assertNotCommitted

public void assertNotCommitted()

Assert that the session has not been committed

assertRolledBack

public void assertRolledBack()

Assert that rollback() has been called

assertNotRolledBack

public void assertNotRolledBack()

Assert that rollback() has not been called

assertTransferCount

public void assertTransferCount(Relationship relationship,
 int count)

Assert that the number of FlowFiles transferred to the given relationship is equal to the given count

Parameters:

relationship - to validate transfer count of

count - items transfer to given relationship

assertTransferCount

public void assertTransferCount(String relationship,
 int count)

Assert that the number of FlowFiles transferred to the given relationship is equal to the given count

Parameters:

relationship - to validate transfer count of

count - items transfer to given relationship

assertQueueEmpty

public void assertQueueEmpty()

Assert that there are no FlowFiles left on the input queue.

assertQueueNotEmpty

public void assertQueueNotEmpty()

Assert that at least one FlowFile is on the input queue

assertAllFlowFilesTransferred

public void assertAllFlowFilesTransferred(String relationship)

Asserts that all FlowFiles that were transferred were transferred to the given relationship

Parameters:

relationship - to check for transferred flow files

assertAllFlowFilesTransferred

public void assertAllFlowFilesTransferred(Relationship relationship)

Asserts that all FlowFiles that were transferred were transferred to the given relationship

Parameters:

relationship - to validate

assertAllFlowFiles

public void assertAllFlowFiles(FlowFileValidator validator)

Asserts that all FlowFiles that were transferred are compliant with the given validator.

Parameters:

validator - validator to use

assertAllFlowFiles

public void assertAllFlowFiles(Relationship relationship,
 FlowFileValidator validator)

Asserts that all FlowFiles that were transferred in the given relationship are compliant with the given validator.

Parameters:

validator - validator to use

clearTransferState

public void clearTransferState()

Removes all state information about FlowFiles that have been transferred

assertAllFlowFilesTransferred

public void assertAllFlowFilesTransferred(Relationship relationship,
 int count)

Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count

Parameters:

relationship - to validate

count - number of items sent to that relationship (expected)

assertAllFlowFilesTransferred

public void assertAllFlowFilesTransferred(String relationship,
 int count)

Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count

Parameters:

relationship - to validate

count - number of items sent to that relationship (expected)

getRemovedCount

public int getRemovedCount()

Returns:

the number of FlowFiles that were removed

getProvenanceReporter

public ProvenanceReporter getProvenanceReporter()

Specified by:

getProvenanceReporter in interface ProcessSession

setState

public void setState(Map<String,String> state,
 Scope scope)
              throws IOException

Specified by:

setState in interface ProcessSession

Throws:

IOException

getState

public StateMap getState(Scope scope)
                  throws IOException

Specified by:

getState in interface ProcessSession

Throws:

IOException

replaceState

public boolean replaceState(StateMap oldValue,
 Map<String,String> newValue,
 Scope scope)
                     throws IOException

Specified by:

replaceState in interface ProcessSession

Throws:

IOException

clearState

public void clearState(Scope scope)
                throws IOException

Specified by:

clearState in interface ProcessSession

Throws:

IOException

penalize

public MockFlowFile penalize(FlowFile flowFile)

Specified by:

penalize in interface ProcessSession

unpenalize

public MockFlowFile unpenalize(FlowFile flowFile)

getContentAsByteArray

public byte[] getContentAsByteArray(MockFlowFile flowFile)

isFlowFileKnown

boolean isFlowFileKnown(FlowFile flowFile)

Checks if a FlowFile is known in this session.

Parameters:

flowFile - the FlowFile to check

Returns:

true if the FlowFile is known in this session, false otherwise.