org.apache.nifi.util

Class MockProcessSession

java.lang.Object

org.apache.nifi.util.MockProcessSession

All Implemented Interfaces:

ProcessSession

public class MockProcessSession
extends java.lang.Object
implements ProcessSession

Constructor Summary

Constructors

Constructor and Description
MockProcessSession(SharedSessionState sharedState, Processor processor)
MockProcessSession(SharedSessionState sharedState, Processor processor, boolean enforceStreamsClosed)

Method Summary

Modifier and Type	Method and Description
void	adjustCounter(java.lang.String name, long delta, boolean immediate) Adjusts counter data for the given counter name and takes care of registering the counter if not already present.
FlowFile	append(FlowFile flowFile, OutputStreamCallback callback) Executes the given callback against the content corresponding to the given FlowFile, such that any data written to the OutputStream of the content will be appended to the end of FlowFile.
void	assertAllFlowFiles(FlowFileValidator validator) Asserts that all FlowFiles that were transferred are compliant with the given validator.
void	assertAllFlowFiles(Relationship relationship, FlowFileValidator validator) Asserts that all FlowFiles that were transferred in the given relationship are compliant with the given validator.
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	assertAllFlowFilesTransferred(java.lang.String relationship) Asserts that all FlowFiles that were transferred were transferred to the given relationship
void	assertAllFlowFilesTransferred(java.lang.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	assertCommitted() Assert that commit() has been called
void	assertNotCommitted() Assert that commit() has not been called
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(Relationship relationship, int count) Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
void	assertTransferCount(java.lang.String 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	clearTransferState() Removes all state information about FlowFiles that have been transferred
MockFlowFile	clone(FlowFile flowFile) Creates a new FlowFile that is a clone of the given FlowFile as of the time this is called, both in content and attributes.
MockFlowFile	clone(FlowFile flowFile, long offset, long size) Creates a new FlowFile whose parent is the given FlowFile.
void	commit() Commits the current session ensuring all operations against FlowFiles within this session are atomically persisted.
MockFlowFile	create() Creates a new FlowFile in the repository with no content and without any linkage to a parent FlowFile.
MockFlowFile	create(java.util.Collection<FlowFile> flowFiles) Creates a new FlowFile in the repository with no content but with a parent linkage to the FlowFiles specified by the parents Collection.
MockFlowFile	create(FlowFile flowFile) Creates a new FlowFile in the repository with no content but with a parent linkage to parent.
MockFlowFile	createFlowFile(byte[] data)
MockFlowFile	createFlowFile(byte[] data, java.util.Map<java.lang.String,java.lang.String> attrs)
MockFlowFile	createFlowFile(java.io.File file)
void	exportTo(FlowFile flowFile, java.io.OutputStream out) Writes the content of the given FlowFile to the given destination stream
void	exportTo(FlowFile flowFile, java.nio.file.Path path, boolean append) Writes the content of the given FlowFile to the given destination path.
MockFlowFile	get()
java.util.List<FlowFile>	get(FlowFileFilter filter) Returns all FlowFiles from all of the incoming queues for which the given FlowFileFilter indicates should be accepted.
java.util.List<FlowFile>	get(int maxResults) Returns up to maxResults FlowFiles from the work queue.
byte[]	getContentAsByteArray(MockFlowFile flowFile)
java.util.List<MockFlowFile>	getFlowFilesForRelationship(Relationship relationship)
java.util.List<MockFlowFile>	getFlowFilesForRelationship(java.lang.String relationship)
java.util.List<MockFlowFile>	getPenalizedFlowFiles()
ProvenanceReporter	getProvenanceReporter() Returns a ProvenanceReporter that is tied to this ProcessSession.
QueueSize	getQueueSize()
int	getRemovedCount()
MockFlowFile	importFrom(java.io.InputStream in, FlowFile flowFile) Writes to the given FlowFile all content from the given content path.
MockFlowFile	importFrom(java.nio.file.Path path, boolean keepSourceFile, FlowFile flowFile) Writes to the given FlowFile all content from the given content path.
MockFlowFile	merge(java.util.Collection<FlowFile> sources, FlowFile destination) Combines the content of all given source FlowFiles into a single given destination FlowFile.
MockFlowFile	merge(java.util.Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator) Combines the content of all given source FlowFiles into a single given destination FlowFile.
void	migrate(ProcessSession newOwner, java.util.Collection<FlowFile> flowFiles) Migrates ownership of the given FlowFiles from this to the given newOwner.
MockFlowFile	penalize(FlowFile flowFile) Sets a penalty for the given FlowFile which will make it unavailable to be operated on any further during the penalty period.
MockFlowFile	putAllAttributes(FlowFile flowFile, java.util.Map<java.lang.String,java.lang.String> attrs) Updates the given FlowFiles attributes with the given key/value pairs.
MockFlowFile	putAttribute(FlowFile flowFile, java.lang.String attrName, java.lang.String attrValue) Updates the given FlowFiles attributes with the given key/value pair.
java.io.InputStream	read(FlowFile flowFile) Provides an InputStream that can be used to read the contents of the given FlowFile.
void	read(FlowFile flowFile, boolean allowSessionStreamManagement, InputStreamCallback callback) Executes the given callback against the contents corresponding to the given FlowFile.
void	read(FlowFile flowFile, InputStreamCallback callback) Executes the given callback against the contents corresponding to the given FlowFile.
void	remove(java.util.Collection<FlowFile> flowFiles) Ends the managed persistence for the given FlowFiles.
void	remove(FlowFile flowFile) Ends the managed persistence for the given FlowFile.
MockFlowFile	removeAllAttributes(FlowFile flowFile, java.util.regex.Pattern keyPattern) Remove all attributes from the given FlowFile that have keys which match the given pattern.
MockFlowFile	removeAllAttributes(FlowFile flowFile, java.util.Set<java.lang.String> attrNames) Removes the attributes with the given keys from the given FlowFile.
MockFlowFile	removeAttribute(FlowFile flowFile, java.lang.String attrName) Removes the given FlowFile attribute with the given key.
void	rollback() Reverts any changes made during this session.
void	rollback(boolean penalize) Reverts any changes made during this session.
void	transfer(java.util.Collection<FlowFile> flowFiles) Transfers the given FlowFiles back to the work queues from which the FlowFiles were pulled.
void	transfer(java.util.Collection<FlowFile> flowFiles, Relationship relationship) Transfers the given FlowFile to the appropriate destination processor work queue(s) based on the given relationship.
void	transfer(FlowFile flowFile) Transfers the given FlowFile back to the work queue from which it was pulled.
void	transfer(FlowFile flowFile, Relationship relationship) Transfers the given FlowFile to the appropriate destination processor work queue(s) based on the given relationship.
java.io.OutputStream	write(FlowFile flowFile) Provides an OutputStream that can be used to write to the contents of the given FlowFile.
MockFlowFile	write(FlowFile flowFile, OutputStreamCallback callback) Executes the given callback against the content corresponding to the given FlowFile.
MockFlowFile	write(FlowFile flowFile, StreamCallback callback) Executes the given callback against the content corresponding to the given flow file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockProcessSession

public MockProcessSession(SharedSessionState sharedState,
                          Processor processor)

MockProcessSession

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

Method Detail

adjustCounter

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

Description copied from interface: ProcessSession

Adjusts counter data for the given counter name and takes care of registering the counter if not already present. The adjustment occurs only if and when the ProcessSession is committed.

Specified by:

adjustCounter in interface ProcessSession

Parameters:

name - the name of the counter

delta - the delta by which to modify the counter (+ or -)

immediate - if true, the counter will be updated immediately, without regard to whether the ProcessSession is commit or rolled back; otherwise, the counter will be incremented only if and when the ProcessSession is committed.

migrate

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

Description copied from interface: ProcessSession

Migrates ownership of the given FlowFiles from this to the given newOwner.

When calling this method, all of the following pre-conditions must be met:

• This method cannot be called from within a callback (see ProcessSession.write(FlowFile, OutputStreamCallback), ProcessSession.write(FlowFile, StreamCallback), ProcessSession.read(FlowFile, InputStreamCallback), ProcessSession.read(FlowFile, boolean, InputStreamCallback) for any of the given FlowFiles.
• No InputStream can be open for the content of any of the given FlowFiles (see ProcessSession.read(FlowFile)).
• No OutputStream can be open for the content of any of the given FlowFiles (see ProcessSession.write(FlowFile).
• For any provided FlowFile, if the FlowFile has any child (e.g., by calling ProcessSession.create(FlowFile) and passing the FlowFile as the argument), then all children that were created must also be in the Collection of provided FlowFiles.

Also note, that if any FlowFile given is not the most up-to-date version of that FlowFile, then the most up-to-date version of the FlowFile will be migrated to the new owner. For example, if a call to ProcessSession.putAttribute(FlowFile, String, String) is made, passing flowFile1 as the FlowFile, and then flowFile1 is passed to this method, then the newest version (including the newly added attribute) will be migrated, not the outdated version of the FlowFile that flowFile1 points to.

Specified by:

migrate in interface ProcessSession

Parameters:

newOwner - the ProcessSession that is to become the new owner of all FlowFiles that currently belong to this.

flowFiles - the FlowFiles to migrate

clone

public MockFlowFile clone(FlowFile flowFile)

Description copied from interface: ProcessSession

Creates a new FlowFile that is a clone of the given FlowFile as of the time this is called, both in content and attributes. This method automatically emits a Provenance CLONE Event.

Specified by:

clone in interface ProcessSession

Parameters:

flowFile - FlowFile to be the source of cloning - given FlowFile must be a part of the given session

Returns:

FlowFile that is a clone of the given example

clone

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

Description copied from interface: ProcessSession

Creates a new FlowFile whose parent is the given FlowFile. The content of the new FlowFile will be a subset of the byte sequence of the given FlowFile starting at the specified offset and with the length specified. The new FlowFile will contain all of the attributes of the original. This method automatically emits a Provenance FORK Event (or a Provenance CLONE Event, if the offset is 0 and the size is exactly equal to the size of the example FlowFile).

Specified by:

clone in interface ProcessSession

Parameters:

flowFile - to base the new flowfile attributes on

offset - of the parent flowfile to base the child flowfile content on

size - of the new flowfile from the offset

Returns:

a FlowFile with the specified size whose parent is first argument to this function

commit

public void commit()

Description copied from interface: ProcessSession

Commits the current session ensuring all operations against FlowFiles within this session are atomically persisted. All FlowFiles operated on within this session must be accounted for by transfer or removal or the commit will fail.

As soon as the commit completes the session is again ready to be used

Specified by:

commit 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()

Description copied from interface: ProcessSession

Creates a new FlowFile in the repository with no content and without any linkage to a parent FlowFile. This method is appropriate only when data is received or created from an external system. Otherwise, this method should be avoided and should instead use ProcessSession.create(FlowFile) or ProcessSession.create(Collection). When this method is used, a Provenance CREATE or RECEIVE Event should be generated. See the ProcessSession.getProvenanceReporter() method and ProvenanceReporter class for more information

Specified by:

create in interface ProcessSession

Returns:

newly created FlowFile

create

public MockFlowFile create(FlowFile flowFile)

Description copied from interface: ProcessSession

Creates a new FlowFile in the repository with no content but with a parent linkage to parent. The newly created FlowFile will inherit all of the parent's attributes except for the UUID. This method will automatically generate a Provenance FORK event or a Provenance JOIN event, depending on whether or not other FlowFiles are generated from the same parent before the ProcessSession is committed.

Specified by:

create in interface ProcessSession

Parameters:

flowFile - to base the new flowfile on

Returns:

newly created flowfile

create

public MockFlowFile create(java.util.Collection<FlowFile> flowFiles)

Description copied from interface: ProcessSession

Creates a new FlowFile in the repository with no content but with a parent linkage to the FlowFiles specified by the parents Collection. The newly created FlowFile will inherit all of the attributes that are in common to all parents (except for the UUID, which will be in common if only a single parent exists). This method will automatically generate a Provenance JOIN event.

Specified by:

create in interface ProcessSession

Parameters:

flowFiles - which the new flowfile should inherit shared attributes from

Returns:

new flowfile

exportTo

public void exportTo(FlowFile flowFile,
                     java.io.OutputStream out)

Description copied from interface: ProcessSession

Writes the content of the given FlowFile to the given destination stream

Specified by:

exportTo in interface ProcessSession

Parameters:

flowFile - to export the content of

out - to export the content to

exportTo

public void exportTo(FlowFile flowFile,
                     java.nio.file.Path path,
                     boolean append)

Description copied from interface: ProcessSession

Writes the content of the given FlowFile to the given destination path.

Specified by:

exportTo in interface ProcessSession

Parameters:

flowFile - to export the content of

path - to export the content to

append - if true will append to the current content at the given path; if false will replace any current content

get

public MockFlowFile get()

Specified by:

get in interface ProcessSession

Returns:

FlowFile that is next highest priority FlowFile to process. Otherwise returns null.

get

public java.util.List<FlowFile> get(int maxResults)

Description copied from interface: ProcessSession

Returns up to maxResults FlowFiles from the work queue. If no FlowFiles are available, returns an empty list. Will not return null. If multiple incoming queues are present, the behavior is unspecified in terms of whether all queues or only a single queue will be polled in a single call.

Specified by:

get in interface ProcessSession

Parameters:

maxResults - the maximum number of FlowFiles to return

Returns:

up to maxResults FlowFiles from the work queue. If no FlowFiles are available, returns an empty list. Will not return null.

get

public java.util.List<FlowFile> get(FlowFileFilter filter)

Description copied from interface: ProcessSession

Returns all FlowFiles from all of the incoming queues for which the given FlowFileFilter indicates should be accepted. Calls to this method provide exclusive access to the underlying queues. I.e., no other thread will be permitted to pull FlowFiles from this Processor's queues or add FlowFiles to this Processor's incoming queues until this method call has returned.

Specified by:

get in interface ProcessSession

Parameters:

filter - to limit which flow files are returned

Returns:

all FlowFiles from all of the incoming queues for which the given FlowFileFilter indicates should be accepted.

getQueueSize

public QueueSize getQueueSize()

Specified by:

getQueueSize in interface ProcessSession

Returns:

the QueueSize that represents the number of FlowFiles and their combined data size for all FlowFiles waiting to be processed by the Processor that owns this ProcessSession, regardless of which Connection the FlowFiles live on

importFrom

public MockFlowFile importFrom(java.io.InputStream in,
                               FlowFile flowFile)

Description copied from interface: ProcessSession

Writes to the given FlowFile all content from the given content path.

Specified by:

importFrom in interface ProcessSession

Parameters:

in - the file from which content will be obtained

flowFile - the FlowFile whose content will be updated

Returns:

the updated destination FlowFile (new size)

importFrom

public MockFlowFile importFrom(java.nio.file.Path path,
                               boolean keepSourceFile,
                               FlowFile flowFile)

Description copied from interface: ProcessSession

Writes to the given FlowFile all content from the given content path.

Specified by:

importFrom in interface ProcessSession

Parameters:

path - the file from which content will be obtained

keepSourceFile - if true the content is simply copied; if false the original content might be used in a destructive way for efficiency such that the repository will have the data but the original data will be gone. If false the source object will be removed or gone once imported. It will not be restored if the session is rolled back so this must be used with caution. In some cases it can result in tremendous efficiency gains but is also dangerous.

flowFile - the FlowFile whose content will be updated

Returns:

the updated destination FlowFile (new size)

merge

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

Description copied from interface: ProcessSession

Combines the content of all given source FlowFiles into a single given destination FlowFile.

Specified by:

merge in interface ProcessSession

Parameters:

sources - the flowfiles to merge

destination - the flowfile to use as the merged result

Returns:

updated destination FlowFile (new size, etc...)

putAllAttributes

public MockFlowFile putAllAttributes(FlowFile flowFile,
                                     java.util.Map<java.lang.String,java.lang.String> attrs)

Description copied from interface: ProcessSession

Updates the given FlowFiles attributes with the given key/value pairs. If the map contains a key named uuid, this attribute will be ignored.

Specified by:

putAllAttributes in interface ProcessSession

Parameters:

flowFile - to update

attrs - the attributes to add to the given FlowFile

Returns:

FlowFile the updated FlowFile

putAttribute

public MockFlowFile putAttribute(FlowFile flowFile,
                                 java.lang.String attrName,
                                 java.lang.String attrValue)

Description copied from interface: ProcessSession

Updates the given FlowFiles attributes with the given key/value pair. If the key is named uuid, this attribute will be ignored.

Specified by:

putAttribute in interface ProcessSession

Parameters:

flowFile - to update

attrName - of attribute

attrValue - of attribute

Returns:

FlowFile the updated FlowFile

read

public void read(FlowFile flowFile,
                 InputStreamCallback callback)

Description copied from interface: ProcessSession

Executes the given callback against the contents corresponding to the given FlowFile.

Specified by:

read in interface ProcessSession

Parameters:

flowFile - flowfile to retrieve content of

callback - that will be called to read the flowfile content

read

public void read(FlowFile flowFile,
                 boolean allowSessionStreamManagement,
                 InputStreamCallback callback)

Description copied from interface: ProcessSession

Executes the given callback against the contents corresponding to the given FlowFile. Note: The OutputStream provided to the given OutputStreamCallback will not be accessible once this method has completed its execution.

Specified by:

read in interface ProcessSession

Parameters:

flowFile - flowfile to retrieve content of

allowSessionStreamManagement - allow session to hold the stream open for performance reasons

callback - that will be called to read the flowfile content

read

public java.io.InputStream read(FlowFile flowFile)

Description copied from interface: ProcessSession

Provides an InputStream that can be used to read the contents of the given FlowFile. This method differs from those that make use of callbacks in that this method returns an InputStream and expects the caller to properly handle the lifecycle of the InputStream (i.e., the caller is responsible for ensuring that the InputStream is closed appropriately). The Process Session may or may not handle closing the stream when ProcessSession.commit() or ProcessSession.rollback() is called, but the responsibility of doing so belongs to the caller. The InputStream will throw an IOException if an attempt is made to read from the stream after the session is committed or rolled back.

Specified by:

read in interface ProcessSession

Parameters:

flowFile - the FlowFile to read

Returns:

an InputStream that can be used to read the contents of the FlowFile

remove

public void remove(FlowFile flowFile)

Description copied from interface: ProcessSession

Ends the managed persistence for the given FlowFile. The persistent attributes for the FlowFile are deleted and so is the content assuming nothing else references it and this FlowFile will no longer be available for further operation.

Specified by:

remove in interface ProcessSession

Parameters:

flowFile - to remove

remove

public void remove(java.util.Collection<FlowFile> flowFiles)

Description copied from interface: ProcessSession

Ends the managed persistence for the given FlowFiles. The persistent attributes for the FlowFile are deleted and so is the content assuming nothing else references it and this FlowFile will no longer be available for further operation.

Specified by:

remove in interface ProcessSession

Parameters:

flowFiles - to remove

removeAllAttributes

public MockFlowFile removeAllAttributes(FlowFile flowFile,
                                        java.util.Set<java.lang.String> attrNames)

Description copied from interface: ProcessSession

Removes the attributes with the given keys from the given FlowFile. If the set of keys contains the value uuid, this key will be ignored

Specified by:

removeAllAttributes in interface ProcessSession

Parameters:

flowFile - to update

attrNames - of attribute

Returns:

FlowFile the updated FlowFile

removeAllAttributes

public MockFlowFile removeAllAttributes(FlowFile flowFile,
                                        java.util.regex.Pattern keyPattern)

Description copied from interface: ProcessSession

Remove all attributes from the given FlowFile that have keys which match the given pattern. If the pattern matches the key uuid, this key will not be removed.

Specified by:

removeAllAttributes in interface ProcessSession

Parameters:

flowFile - to update

keyPattern - may be null; if supplied is matched against each of the FlowFile attribute keys

Returns:

FlowFile containing only attributes which did not meet the key pattern

removeAttribute

public MockFlowFile removeAttribute(FlowFile flowFile,
                                    java.lang.String attrName)

Description copied from interface: ProcessSession

Removes the given FlowFile attribute with the given key. If the key is named uuid, this method will return the same FlowFile without removing any attribute.

Specified by:

removeAttribute in interface ProcessSession

Parameters:

flowFile - to update

attrName - of attribute

Returns:

FlowFile the updated FlowFile

rollback

public void rollback()

Description copied from interface: ProcessSession

Reverts any changes made during this session. All FlowFiles are restored back to their initial session state and back to their original queues. If this session is already committed or rolled back then no changes will occur. This method can be called any number of times. Calling this method is identical to calling ProcessSession.rollback(boolean) passing false as the parameter.

Specified by:

rollback in interface ProcessSession

rollback

public void rollback(boolean penalize)

Description copied from interface: ProcessSession

Reverts any changes made during this session. All FlowFiles are restored back to their initial session state and back to their original queues, after optionally being penalized. If this session is already committed or rolled back then no changes will occur. This method can be called any number of times.

Specified by:

rollback in interface ProcessSession

Parameters:

penalize - whether or not the FlowFiles that are being restored back to their queues should be penalized

transfer

public void transfer(FlowFile flowFile)

Description copied from interface: ProcessSession

Transfers the given FlowFile back to the work queue from which it was pulled. The processor will not be able to operate on the given FlowFile until this session is committed. Any modifications that have been made to the FlowFile will be maintained. FlowFiles that are created by the processor cannot be transferred back to themselves via this method.

Specified by:

transfer in interface ProcessSession

Parameters:

flowFile - to transfer

transfer

public void transfer(java.util.Collection<FlowFile> flowFiles)

Description copied from interface: ProcessSession

Transfers the given FlowFiles back to the work queues from which the FlowFiles were pulled. The processor will not be able to operate on the given FlowFile until this session is committed. Any modifications that have been made to the FlowFile will be maintained. FlowFiles that are created by the processor cannot be transferred back to themselves via this method.

Specified by:

transfer in interface ProcessSession

Parameters:

flowFiles - to transfer

transfer

public void transfer(FlowFile flowFile,
                     Relationship relationship)

Description copied from interface: ProcessSession

Transfers the given FlowFile to the appropriate destination processor work queue(s) based on the given relationship. If the relationship leads to more than one destination the state of the FlowFile is replicated such that each destination receives an exact copy of the FlowFile though each will have its own unique identity. The destination processors will not be able to operate on the given FlowFile until this session is committed or until the ownership of the session is migrated to another processor. If ownership of the session is passed to a destination processor then that destination processor will have immediate visibility of the transferred FlowFiles within the session.

Specified by:

transfer in interface ProcessSession

Parameters:

flowFile - to transfer

relationship - to transfer to

transfer

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

Description copied from interface: ProcessSession

Transfers the given FlowFile to the appropriate destination processor work queue(s) based on the given relationship. If the relationship leads to more than one destination the state of the FlowFile is replicated such that each destination receives an exact copy of the FlowFile though each will have its own unique identity. The destination processors will not be able to operate on the given FlowFile until this session is committed or until the ownership of the session is migrated to another processor. If ownership of the session is passed to a destination processor then that destination processor will have immediate visibility of the transferred FlowFiles within the session.

Specified by:

transfer in interface ProcessSession

Parameters:

flowFiles - to transfer

relationship - to transfer to

write

public MockFlowFile write(FlowFile flowFile,
                          OutputStreamCallback callback)

Description copied from interface: ProcessSession

Executes the given callback against the content corresponding to the given FlowFile. Note: The OutputStream provided to the given OutputStreamCallback will not be accessible once this method has completed its execution.

Specified by:

write in interface ProcessSession

Parameters:

flowFile - to write to

callback - used to write new content

Returns:

updated FlowFile

write

public java.io.OutputStream write(FlowFile flowFile)

Description copied from interface: ProcessSession

Provides an OutputStream that can be used to write to the contents of the given FlowFile.

Specified by:

write in interface ProcessSession

Parameters:

flowFile - to write to

Returns:

an OutputStream that can be used to write to the contents of the FlowFile

append

public FlowFile append(FlowFile flowFile,
                       OutputStreamCallback callback)

Description copied from interface: ProcessSession

Executes the given callback against the content corresponding to the given FlowFile, such that any data written to the OutputStream of the content will be appended to the end of FlowFile. Note: The OutputStream provided to the given OutputStreamCallback will not be accessible once this method has completed its execution.

Specified by:

append in interface ProcessSession

Parameters:

flowFile - the flowfile for which content should be appended

callback - used to write new bytes to the flowfile content

Returns:

the updated flowfile reference for the new content

write

public MockFlowFile write(FlowFile flowFile,
                          StreamCallback callback)

Description copied from interface: ProcessSession

Executes the given callback against the content corresponding to the given flow file. Note: The InputStream & OutputStream provided to the given StreamCallback will not be accessible once this method has completed its execution.

Specified by:

write in interface ProcessSession

Parameters:

flowFile - to read from and write to

callback - used to read the old content and write new content

Returns:

updated FlowFile

getFlowFilesForRelationship

public java.util.List<MockFlowFile> getFlowFilesForRelationship(Relationship relationship)

getPenalizedFlowFiles

public java.util.List<MockFlowFile> getPenalizedFlowFiles()

getFlowFilesForRelationship

public java.util.List<MockFlowFile> getFlowFilesForRelationship(java.lang.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(java.io.File file)
                            throws java.io.IOException

Throws:

java.io.IOException

createFlowFile

public MockFlowFile createFlowFile(byte[] data)

createFlowFile

public MockFlowFile createFlowFile(byte[] data,
                                   java.util.Map<java.lang.String,java.lang.String> attrs)

merge

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

Description copied from interface: ProcessSession

Combines the content of all given source FlowFiles into a single given destination FlowFile.

Specified by:

merge in interface ProcessSession

Parameters:

sources - to merge together

destination - to merge to

header - bytes that will be added to the beginning of the merged output. May be null or empty.

footer - bytes that will be added to the end of the merged output. May be null or empty.

demarcator - bytes that will be placed in between each object merged together. May be null or empty.

Returns:

updated destination FlowFile (new size, etc...)

assertCommitted

public void assertCommitted()

Assert that commit() has been called

assertNotCommitted

public void assertNotCommitted()

Assert that commit() has not been called

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(java.lang.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(java.lang.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(java.lang.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()

Description copied from interface: ProcessSession

Returns a ProvenanceReporter that is tied to this ProcessSession.

Specified by:

getProvenanceReporter in interface ProcessSession

Returns:

the provenance reporter

penalize

public MockFlowFile penalize(FlowFile flowFile)

Description copied from interface: ProcessSession

Sets a penalty for the given FlowFile which will make it unavailable to be operated on any further during the penalty period.

Specified by:

penalize in interface ProcessSession

Parameters:

flowFile - to penalize

Returns:

FlowFile the new FlowFile reference to use

getContentAsByteArray

public byte[] getContentAsByteArray(MockFlowFile flowFile)