StandardProcessorTestRunner (nifi-mock 0.5.0 API)

java.lang.Object
- org.apache.nifi.util.StandardProcessorTestRunner

All Implemented Interfaces:: TestRunner

public class StandardProcessorTestRunner
extends Object
implements TestRunner

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class StandardProcessorTestRunner.RunProcessor

Nested Classes
Modifier and Type	Class and Description
`private class`	`StandardProcessorTestRunner.RunProcessor`

Field Summary

Fields
Modifier and Type	Field and Description
`private MockProcessContext`	`context`
`private Map<String,MockProcessorLog>`	`controllerServiceLoggers`
`private Map<String,MockStateManager>`	`controllerServiceStateManagers`
`private static Set<Class<? extends Annotation>>`	`deprecatedMethodAnnotations`
`private static Set<Class<? extends Annotation>>`	`deprecatedTypeAnnotations`
`private MockFlowFileQueue`	`flowFileQueue`
`private AtomicLong`	`idGenerator`
`private AtomicInteger`	`invocations`
`private MockProcessorLog`	`logger`
`private int`	`numThreads`
`private Processor`	`processor`
`private MockStateManager`	`processorStateManager`
`private MockSessionFactory`	`sessionFactory`
`private SharedSessionState`	`sharedState`
`private boolean`	`triggerSerially`

Constructor Summary

Constructors
Constructor and Description

StandardProcessorTestRunner(Processor processor)

Constructors
Constructor and Description
`StandardProcessorTestRunner(Processor processor)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addConnection(Relationship relationship)` Indicates to the Framework that the configured processor has a connection for the given Relationship.
`void`	`addConnection(String relationshipName)` Indicates to the Framework that the configured processor has a connection for the Relationship with the given name.
`void`	`addControllerService(String identifier, ControllerService service)` Adds the given `ControllerService` to this TestRunner so that the configured Processor can access it using the given `identifier`.
`void`	`addControllerService(String identifier, ControllerService service, Map<String,String> properties)` Adds the given `ControllerService` to this TestRunner so that the configured Processor can access it using the given `identifier`.
`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(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`	`assertNotValid()` Assert that the currently configured set of properties/annotation data are NOT valid
`void`	`assertNotValid(ControllerService service)` Assert that the currently configured set of properties/annotation data are NOT valid for the given Controller Service.
`void`	`assertPenalizeCount(int count)` Assert that the number of FlowFiles that were penalized is equal to the given count
`void`	`assertQueueEmpty()` Assert that there are no FlowFiles left on the input queue.
`void`	`assertQueueNotEmpty()` Assert that there is at least one FlowFile left on the input queue.
`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(String relationship, int count)` Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
`void`	`assertValid()` Assert that the currently configured set of properties/annotation data are valid
`void`	`assertValid(ControllerService service)` Assert that the currently configured set of properties/annotation data are valid for the given Controller Service.
`void`	`clearProvenanceEvents()` Clears the Provenance Events that have been emitted by the Processor
`void`	`clearTransferState()` Resets the Transfer Counts that indicate how many FlowFiles have been transferred to each Relationship and removes from memory any FlowFiles that have been transferred to this Relationships.
`private static void`	`detectDeprecatedAnnotations(Processor processor)`
`void`	`disableControllerService(ControllerService service)` Marks the Controller Service as disabled so that it cannot be used by other components.
`void`	`enableControllerService(ControllerService service)` Marks the Controller Service as enabled so that it can be used by other components.
`void`	`enqueue(byte[] data)` Copies the content from the given byte array into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(byte[] data, Map<String,String> attributes)` Copies the content from the given byte array into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(FlowFile... flowFiles)` Enqueues the given FlowFiles into the Processor's input queue
`void`	`enqueue(InputStream data)` Reads the content from the given `InputStream` into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(InputStream data, Map<String,String> attributes)` Reads the content from the given `InputStream` into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(Path path)` Reads the content from the given `Path` into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(Path path, Map<String,String> attributes)` Reads the content from the given `Path` into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(String data)` Creates a FlowFile with the content set to the given string (in UTF-8 format), with no attributes, and adds this FlowFile to the Processor's Input Queue
`void`	`enqueue(String data, Map<String,String> attributes)` Creates a FlowFile with the content set to the given string (in UTF-8 format), with the given attributes, and adds this FlowFile to the Processor's Input Queue
`private ControllerServiceConfiguration`	`getConfigToUpdate(ControllerService service)`
`byte[]`	`getContentAsByteArray(MockFlowFile flowFile)` Copies the contents of the given `MockFlowFile` into a byte array and returns that byte array.
`ControllerService`	`getControllerService(String identifier)`
`<T extends ControllerService> T`	`getControllerService(String identifier, Class<T> serviceType)`
`MockProcessorLog`	`getControllerServiceLogger(String identifier)` Returns the `MockProcessorLog` that is used by the specified controller service.
`Long`	`getCounterValue(String name)`
`List<MockFlowFile>`	`getFlowFilesForRelationship(Relationship relationship)` Returns a List of FlowFiles in the order in which they were transferred to the given relationship
`List<MockFlowFile>`	`getFlowFilesForRelationship(String relationship)` Returns a List of FlowFiles in the order in which they were transferred to the given relationship
`MockProcessorLog`	`getLogger()` Returns the `MockProcessorLog` that is used by the Processor under test.
`List<MockFlowFile>`	`getPenalizedFlowFiles()` Returns a List of FlowFiles in the order in which they were transferred that were penalized
`MockProcessContext`	`getProcessContext()`
`Processor`	`getProcessor()`
`ProcessSessionFactory`	`getProcessSessionFactory()`
`List<ProvenanceEventRecord>`	`getProvenanceEvents()` Returns a `List` of all `ProvenanceEventRecord`s that were emitted by the Processor
`ProvenanceReporter`	`getProvenanceReporter()` Deprecated. The ProvenanceReporter should not be accessed through the test runner, as it does not expose the events that were emitted.
`QueueSize`	`getQueueSize()`
`int`	`getRemovedCount()`
`MockStateManager`	`getStateManager()`
`MockStateManager`	`getStateManager(ControllerService controllerService)` Returns the State Manager for the given Controller Service.
`int`	`getThreadCount()`
`boolean`	`isControllerServiceEnabled(ControllerService service)`
`boolean`	`isQueueEmpty()`
`private static void`	`populateDeprecatedMethods()`
`void`	`removeConnection(Relationship relationship)` Removes the connection for the given Relationship from the configured processor.
`void`	`removeConnection(String relationshipName)` Removes the connection for the relationship with the given name from the configured processor.
`void`	`removeControllerService(ControllerService service)` Removes the Controller Service from the TestRunner.
`boolean`	`removeProperty(PropertyDescriptor descriptor)` Removes the `PropertyDescriptor` from the `ProcessContext`, effectively setting its value to null, or the property's default value, if it has one.
`void`	`run()` Performs exactly the same operation as calling `TestRunner.run(int)` with a value of 1.
`void`	`run(int iterations)` Performs the same operation as calling `TestRunner.run(int, boolean)` with a value of `true`
`void`	`run(int iterations, boolean stopOnFinish)` performs the same operation as calling `TestRunner.run(int, boolean, boolean)` with a value of `iterations`, `stopOnFinish`, `true`
`void`	`run(int iterations, boolean stopOnFinish, boolean initialize)` This method runs the `Processor` `iterations` times, using the sequence of steps below: If `initialize` is true, run all methods on the Processor that are annotated with the `@OnScheduled` annotation.
`void`	`run(int iterations, boolean stopOnFinish, boolean initialize, long runWait)` This method runs the `Processor` `iterations` times, using the sequence of steps below: If `initialize` is true, run all methods on the Processor that are annotated with the `@OnScheduled` annotation.
`void`	`setAnnotationData(ControllerService service, String annotationData)` Sets the annontation data of the given service to the provided annotation data.
`void`	`setAnnotationData(String annotationData)` Sets the annotation data.
`void`	`setIncomingConnection(boolean hasIncomingConnection)` Indicates to the framework that the configured processor has one or more incoming connections.
`void`	`setNonLoopConnection(boolean hasNonLoopConnection)` Indicates to the framework that the configured processor has one or more incoming connections for which the processor is not also the source.
`ValidationResult`	`setProperty(ControllerService service, PropertyDescriptor property, AllowableValue value)` Sets the given property on the given ControllerService
`ValidationResult`	`setProperty(ControllerService service, PropertyDescriptor property, String value)` Sets the given property on the given ControllerService
`ValidationResult`	`setProperty(ControllerService service, String propertyName, String value)` Sets the property with the given name on the given ControllerService
`ValidationResult`	`setProperty(PropertyDescriptor descriptor, AllowableValue value)` Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator.
`ValidationResult`	`setProperty(PropertyDescriptor descriptor, String value)` Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator.
`ValidationResult`	`setProperty(String propertyName, String propertyValue)` Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator.
`void`	`setRelationshipAvailable(Relationship relationship)` Indicates to the Framework that the given Relationship should be considered "available", meaning that the queues of all Connections that contain this Relationship are not full.
`void`	`setRelationshipAvailable(String relationshipName)` Indicates to the Framework that the given Relationship with the given name should be considered "available", meaning that the queues of all Connections that contain this Relationship are not full.
`void`	`setRelationshipUnavailable(Relationship relationship)` Indicates to the Framework that the given Relationship should NOT be considered "available", meaning that the queue of at least one Connection that contain this Relationship is full.
`void`	`setRelationshipUnavailable(String relationshipName)` Indicates to the Framework that the Relationship with the given name should NOT be considered "available", meaning that the queue of at least one Connection that contain this Relationship is full.
`void`	`setThreadCount(int threadCount)` Updates the number of threads that will be used to run the Processor when calling the `TestRunner.run()` or `TestRunner.run(int)` methods.
`void`	`setValidateExpressionUsage(boolean validate)` Specifies whether or not the TestRunner will validate the use of Expression Language.
`void`	`shutdown()` Invokes all methods on the Processor that are annotated with the `@OnShutdown` annotation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - processor
```
private final Processor processor
```
  - context
```
private final MockProcessContext context
```
  - flowFileQueue
```
private final MockFlowFileQueue flowFileQueue
```
  - sessionFactory
```
private final MockSessionFactory sessionFactory
```
  - sharedState
```
private final SharedSessionState sharedState
```
  - idGenerator
```
private final AtomicLong idGenerator
```
  - triggerSerially
```
private final boolean triggerSerially
```
  - processorStateManager
```
private final MockStateManager processorStateManager
```
  - controllerServiceStateManagers
```
private final Map<String,MockStateManager> controllerServiceStateManagers
```
  - numThreads
```
private int numThreads
```
  - invocations
```
private final AtomicInteger invocations
```
  - deprecatedTypeAnnotations
```
private static final Set<Class<? extends Annotation>> deprecatedTypeAnnotations
```
  - deprecatedMethodAnnotations
```
private static final Set<Class<? extends Annotation>> deprecatedMethodAnnotations
```
  - controllerServiceLoggers
```
private final Map<String,MockProcessorLog> controllerServiceLoggers
```
  - logger
```
private final MockProcessorLog logger
```
- Constructor Detail
  - StandardProcessorTestRunner
```
StandardProcessorTestRunner(Processor processor)
```
- Method Detail
  - populateDeprecatedMethods
```
private static void populateDeprecatedMethods()
```
  - detectDeprecatedAnnotations
```
private static void detectDeprecatedAnnotations(Processor processor)
```
  - setValidateExpressionUsage
```
public void setValidateExpressionUsage(boolean validate)
```
    Description copied from interface: TestRunner
    
    Specifies whether or not the TestRunner will validate the use of Expression Language. By default, the value is true, which means that an Exception will be thrown if the Processor attempts to obtain the configured value of a Property without calling evaluateAttributeExpressions on the Property Value or if evaluateAttributeExpressions is called but the PropertyDescriptor indicates that the Expression Language is not supported.
    See Also: PropertyDescriptor.Builder#expressionLanguageSupported(boolean)
    
    Specified by:
    
    setValidateExpressionUsage in interface TestRunner
    
    Parameters:
    
    validate - whether there is any need to validate the EL was used
  - getProcessor
```
public Processor getProcessor()
```
    Specified by:
    
    getProcessor in interface TestRunner
    
    Returns:
    
    the Processor for which this TestRunner is configured
  - getProcessContext
```
public MockProcessContext getProcessContext()
```
    Specified by:
    
    getProcessContext in interface TestRunner
    
    Returns:
    
    the that this TestRunner will use to invoke the onTrigger method
  - run
```
public void run()
```
    Description copied from interface: TestRunner
    
    Performs exactly the same operation as calling TestRunner.run(int) with a value of 1.
    
    Specified by:
    
    run in interface TestRunner
  - run
```
public void run(int iterations)
```
    Description copied from interface: TestRunner
    
    Performs the same operation as calling TestRunner.run(int, boolean) with a value of true
    
    Specified by:
    
    run in interface TestRunner
    
    Parameters:
    
    iterations - number of iterations
  - run
```
public void run(int iterations,
                boolean stopOnFinish)
```
    Description copied from interface: TestRunner
    
    performs the same operation as calling TestRunner.run(int, boolean, boolean) with a value of iterations, stopOnFinish, true
    
    Specified by:
    
    run in interface TestRunner
    
    Parameters:
    
    iterations - number of iterations
    
    stopOnFinish - flag to stop when finished
  - run
```
public void run(int iterations,
                boolean stopOnFinish,
                boolean initialize)
```
    Description copied from interface: TestRunner
    This method runs the Processor iterations times, using the sequence of steps below:
    - If initialize is true, run all methods on the Processor that are annotated with the @OnScheduled annotation. If any of these methods throws an Exception, the Unit Test will fail.
    - Schedule the onTrigger method to be invoked iterations times. The number of threads used to run these iterations is determined by the ThreadCount of this TestRunner. By default, the value is set to 1, but it can be modified by calling the TestRunner.setThreadCount(int) method.
    - As soon as the first thread finishes its execution of onTrigger, all methods on the Processor that are annotated with the @OnUnscheduled annotation are invoked. If any of these methods throws an Exception, the Unit Test will fail.
    - Waits for all threads to finish execution.
    - If and only if the value of shutdown is true: Call all methods on the Processor that is annotated with the @OnStopped annotation.
    Specified by:
    
    run in interface TestRunner
    
    Parameters:
    
    iterations - number of iterations
    
    stopOnFinish - whether or not to run the Processor methods that are annotated with @OnStopped
    
    initialize - true if must initialize
  - run
```
public void run(int iterations,
                boolean stopOnFinish,
                boolean initialize,
                long runWait)
```
    Description copied from interface: TestRunner
    This method runs the Processor iterations times, using the sequence of steps below:
    - If initialize is true, run all methods on the Processor that are annotated with the @OnScheduled annotation. If any of these methods throws an Exception, the Unit Test will fail.
    - Schedule the onTrigger method to be invoked iterations times. The number of threads used to run these iterations is determined by the ThreadCount of this TestRunner. By default, the value is set to 1, but it can be modified by calling the TestRunner.setThreadCount(int) method.
    - As soon as the first thread finishes its execution of onTrigger, all methods on the Processor that are annotated with the @OnUnscheduled annotation are invoked. If any of these methods throws an Exception, the Unit Test will fail.
    - Waits for all threads to finish execution.
    - If and only if the value of shutdown is true: Call all methods on the Processor that is annotated with the @OnStopped annotation.
    Specified by:
    
    run in interface TestRunner
    
    Parameters:
    
    iterations - number of iterations
    
    stopOnFinish - whether or not to run the Processor methods that are annotated with @OnStopped
    
    initialize - true if must initialize
    
    runWait - indicates the amount of time in milliseconds that the framework should wait for processors to stop running before calling the @OnUnscheduled annotation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: TestRunner
    
    Invokes all methods on the Processor that are annotated with the @OnShutdown annotation. If any of these methods throws an Exception, the Unit Test will fail
    
    Specified by:
    
    shutdown in interface TestRunner
  - getProcessSessionFactory
```
public ProcessSessionFactory getProcessSessionFactory()
```
    Specified by:
    
    getProcessSessionFactory in interface TestRunner
    
    Returns:
    
    the ProcessSessionFactory that this TestRunner will use to invoke the Processor.onTrigger(ProcessContext, ProcessSessionFactory) method
  - assertAllFlowFilesTransferred
```
public void assertAllFlowFilesTransferred(String relationship)
```
    Description copied from interface: TestRunner
    
    Asserts that all FlowFiles that were transferred were transferred to the given relationship
    
    Specified by:
    
    assertAllFlowFilesTransferred in interface TestRunner
    
    Parameters:
    
    relationship - to verify
  - assertAllFlowFilesTransferred
```
public void assertAllFlowFilesTransferred(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Asserts that all FlowFiles that were transferred were transferred to the given relationship
    
    Specified by:
    
    assertAllFlowFilesTransferred in interface TestRunner
    
    Parameters:
    
    relationship - to verify
  - assertAllFlowFilesTransferred
```
public void assertAllFlowFilesTransferred(String relationship,
                                          int count)
```
    Description copied from interface: TestRunner
    
    Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count
    
    Specified by:
    
    assertAllFlowFilesTransferred in interface TestRunner
    
    Parameters:
    
    relationship - to verify
    
    count - number of expected transfers
  - assertAllFlowFilesTransferred
```
public void assertAllFlowFilesTransferred(Relationship relationship,
                                          int count)
```
    Description copied from interface: TestRunner
    
    Asserts that all FlowFiles that were transferred were transferred to the given relationship and that the number of FlowFiles transferred is equal to count
    
    Specified by:
    
    assertAllFlowFilesTransferred in interface TestRunner
    
    Parameters:
    
    relationship - to verify
    
    count - number of expected transfers
  - assertTransferCount
```
public void assertTransferCount(Relationship relationship,
                                int count)
```
    Description copied from interface: TestRunner
    
    Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
    
    Specified by:
    
    assertTransferCount in interface TestRunner
    
    Parameters:
    
    relationship - to verify
    
    count - number of expected transfers
  - assertTransferCount
```
public void assertTransferCount(String relationship,
                                int count)
```
    Description copied from interface: TestRunner
    
    Assert that the number of FlowFiles transferred to the given relationship is equal to the given count
    
    Specified by:
    
    assertTransferCount in interface TestRunner
    
    Parameters:
    
    relationship - to verify
    
    count - number of expected transfers
  - assertPenalizeCount
```
public void assertPenalizeCount(int count)
```
    Description copied from interface: TestRunner
    
    Assert that the number of FlowFiles that were penalized is equal to the given count
    
    Specified by:
    
    assertPenalizeCount in interface TestRunner
    
    Parameters:
    
    count - number of expected penalized
  - assertValid
```
public void assertValid()
```
    Description copied from interface: TestRunner
    
    Assert that the currently configured set of properties/annotation data are valid
    
    Specified by:
    
    assertValid in interface TestRunner
  - assertNotValid
```
public void assertNotValid()
```
    Description copied from interface: TestRunner
    
    Assert that the currently configured set of properties/annotation data are NOT valid
    
    Specified by:
    
    assertNotValid in interface TestRunner
  - isQueueEmpty
```
public boolean isQueueEmpty()
```
    Specified by:
    
    isQueueEmpty in interface TestRunner
    
    Returns:
    
    true if the Input Queue to the Processor is empty, false otherwise
  - assertQueueEmpty
```
public void assertQueueEmpty()
```
    Description copied from interface: TestRunner
    
    Assert that there are no FlowFiles left on the input queue.
    
    Specified by:
    
    assertQueueEmpty in interface TestRunner
  - assertQueueNotEmpty
```
public void assertQueueNotEmpty()
```
    Description copied from interface: TestRunner
    
    Assert that there is at least one FlowFile left on the input queue.
    
    Specified by:
    
    assertQueueNotEmpty in interface TestRunner
  - clearTransferState
```
public void clearTransferState()
```
    Description copied from interface: TestRunner
    
    Resets the Transfer Counts that indicate how many FlowFiles have been transferred to each Relationship and removes from memory any FlowFiles that have been transferred to this Relationships. This method should be called between successive calls to run if the output is to be examined after each run.
    
    Specified by:
    
    clearTransferState in interface TestRunner
  - enqueue
```
public void enqueue(FlowFile... flowFiles)
```
    Description copied from interface: TestRunner
    
    Enqueues the given FlowFiles into the Processor's input queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    flowFiles - to enqueue
  - enqueue
```
public void enqueue(Path path)
             throws IOException
```
    Description copied from interface: TestRunner
    
    Reads the content from the given Path into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    path - to read content from
    
    Throws:
    
    IOException - if unable to read content
  - enqueue
```
public void enqueue(Path path,
                    Map<String,String> attributes)
             throws IOException
```
    Description copied from interface: TestRunner
    
    Reads the content from the given Path into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    path - to read content from
    
    attributes - attributes to use for new flow file
    
    Throws:
    
    IOException - if unable to read content
  - enqueue
```
public void enqueue(byte[] data)
```
    Description copied from interface: TestRunner
    
    Copies the content from the given byte array into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - to enqueue
  - enqueue
```
public void enqueue(String data)
```
    Description copied from interface: TestRunner
    
    Creates a FlowFile with the content set to the given string (in UTF-8 format), with no attributes, and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - to enqueue
  - enqueue
```
public void enqueue(byte[] data,
                    Map<String,String> attributes)
```
    Description copied from interface: TestRunner
    
    Copies the content from the given byte array into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - to enqueue
    
    attributes - to use for enqueued item
  - enqueue
```
public void enqueue(String data,
                    Map<String,String> attributes)
```
    Description copied from interface: TestRunner
    
    Creates a FlowFile with the content set to the given string (in UTF-8 format), with the given attributes, and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - to enqueue
    
    attributes - to use for enqueued item
  - enqueue
```
public void enqueue(InputStream data)
```
    Description copied from interface: TestRunner
    
    Reads the content from the given InputStream into memory and creates a FlowFile from this content with no attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - to source data from
  - enqueue
```
public void enqueue(InputStream data,
                    Map<String,String> attributes)
```
    Description copied from interface: TestRunner
    
    Reads the content from the given InputStream into memory and creates a FlowFile from this content with the given attributes and adds this FlowFile to the Processor's Input Queue
    
    Specified by:
    
    enqueue in interface TestRunner
    
    Parameters:
    
    data - source of data
    
    attributes - to use for flow files
  - getContentAsByteArray
```
public byte[] getContentAsByteArray(MockFlowFile flowFile)
```
    Description copied from interface: TestRunner
    
    Copies the contents of the given MockFlowFile into a byte array and returns that byte array.
    
    Specified by:
    
    getContentAsByteArray in interface TestRunner
    
    Parameters:
    
    flowFile - to get content for
    
    Returns:
    
    byte array of flowfile content
  - getFlowFilesForRelationship
```
public List<MockFlowFile> getFlowFilesForRelationship(String relationship)
```
    Description copied from interface: TestRunner
    
    Returns a List of FlowFiles in the order in which they were transferred to the given relationship
    
    Specified by:
    
    getFlowFilesForRelationship in interface TestRunner
    
    Parameters:
    
    relationship - to get flowfiles for
    
    Returns:
    
    flowfiles transfered to given relationship
  - getFlowFilesForRelationship
```
public List<MockFlowFile> getFlowFilesForRelationship(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Returns a List of FlowFiles in the order in which they were transferred to the given relationship
    
    Specified by:
    
    getFlowFilesForRelationship in interface TestRunner
    
    Parameters:
    
    relationship - to get flowfiles for
    
    Returns:
    
    flowfiles transfered to given relationship
  - getPenalizedFlowFiles
```
public List<MockFlowFile> getPenalizedFlowFiles()
```
    Description copied from interface: TestRunner
    
    Returns a List of FlowFiles in the order in which they were transferred that were penalized
    
    Specified by:
    
    getPenalizedFlowFiles in interface TestRunner
    
    Returns:
    
    flowfiles that were penalized
  - getProvenanceReporter
```
@Deprecated
public ProvenanceReporter getProvenanceReporter()
```
    Deprecated. The ProvenanceReporter should not be accessed through the test runner, as it does not expose the events that were emitted.
    
    Specified by:
    
    getProvenanceReporter in interface TestRunner
    
    Returns:
    
    the ProvenanceReporter that will be used by the configured Processor for reporting Provenance Events
  - getQueueSize
```
public QueueSize getQueueSize()
```
    Specified by:
    
    getQueueSize in interface TestRunner
    
    Returns:
    
    the current size of the Processor's Input Queue
  - getCounterValue
```
public Long getCounterValue(String name)
```
    Specified by:
    
    getCounterValue in interface TestRunner
    
    Parameters:
    
    name - of counter
    
    Returns:
    
    the current value of the counter with the specified name, or null if no counter exists with the specified name
  - getRemovedCount
```
public int getRemovedCount()
```
    Specified by:
    
    getRemovedCount in interface TestRunner
    
    Returns:
    
    the number of FlowFiles that have been removed from the system
  - setAnnotationData
```
public void setAnnotationData(String annotationData)
```
    Description copied from interface: TestRunner
    
    Sets the annotation data.
    
    Specified by:
    
    setAnnotationData in interface TestRunner
    
    Parameters:
    
    annotationData - data
  - setProperty
```
public ValidationResult setProperty(String propertyName,
                                    String propertyValue)
```
    Description copied from interface: TestRunner
    
    Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator. Otherwise, Assert.fail() is called, causing the unit test to fail
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    propertyName - name
    
    propertyValue - value
    
    Returns:
    
    result
  - setProperty
```
public ValidationResult setProperty(PropertyDescriptor descriptor,
                                    String value)
```
    Description copied from interface: TestRunner
    
    Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator. Otherwise, Assert.fail() is called, causing the unit test to fail
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    descriptor - descriptor
    
    value - value
    
    Returns:
    
    result
  - setProperty
```
public ValidationResult setProperty(PropertyDescriptor descriptor,
                                    AllowableValue value)
```
    Description copied from interface: TestRunner
    
    Updates the value of the property with the given PropertyDescriptor to the specified value IF and ONLY IF the value is valid according to the descriptor's validator. Otherwise, Assert.fail() is called, causing the unit test to fail
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    descriptor - descriptor
    
    value - allowable valu
    
    Returns:
    
    result
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    Description copied from interface: TestRunner
    
    Updates the number of threads that will be used to run the Processor when calling the TestRunner.run() or TestRunner.run(int) methods.
    
    Specified by:
    
    setThreadCount in interface TestRunner
    
    Parameters:
    
    threadCount - num threads
  - getThreadCount
```
public int getThreadCount()
```
    Specified by:
    
    getThreadCount in interface TestRunner
    
    Returns:
    
    the currently configured number of threads that will be used to runt he Processor when calling the TestRunner.run() or TestRunner.run(int) methods
  - setRelationshipAvailable
```
public void setRelationshipAvailable(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the given Relationship should be considered "available", meaning that the queues of all Connections that contain this Relationship are not full. This is generally used only when dealing with Processors that use the TriggerWhenAnyDestinationAvailable annotation.
    
    Specified by:
    
    setRelationshipAvailable in interface TestRunner
    
    Parameters:
    
    relationship - to mark as available
  - setRelationshipAvailable
```
public void setRelationshipAvailable(String relationshipName)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the given Relationship with the given name should be considered "available", meaning that the queues of all Connections that contain this Relationship are not full. This is generally used only when dealing with Processors that use the TriggerWhenAnyDestinationAvailable
    
    Specified by:
    
    setRelationshipAvailable in interface TestRunner
    
    Parameters:
    
    relationshipName - relationship name
  - setRelationshipUnavailable
```
public void setRelationshipUnavailable(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the given Relationship should NOT be considered "available", meaning that the queue of at least one Connection that contain this Relationship is full. This is generally used only when dealing with Processors that use the TriggerWhenAnyDestinationAvailable annotation.
    
    Specified by:
    
    setRelationshipUnavailable in interface TestRunner
    
    Parameters:
    
    relationship - to mark as unavailable
  - setRelationshipUnavailable
```
public void setRelationshipUnavailable(String relationshipName)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the Relationship with the given name should NOT be considered "available", meaning that the queue of at least one Connection that contain this Relationship is full. This is generally used only when dealing with Processors that use the TriggerWhenAnyDestinationAvailable
    
    Specified by:
    
    setRelationshipUnavailable in interface TestRunner
    
    Parameters:
    
    relationshipName - name of relationship.
  - setIncomingConnection
```
public void setIncomingConnection(boolean hasIncomingConnection)
```
    Description copied from interface: TestRunner
    
    Indicates to the framework that the configured processor has one or more incoming connections.
    
    Specified by:
    
    setIncomingConnection in interface TestRunner
    
    Parameters:
    
    hasIncomingConnection - whether or not the configured processor should behave as though it has an incoming connection
  - setNonLoopConnection
```
public void setNonLoopConnection(boolean hasNonLoopConnection)
```
    Description copied from interface: TestRunner
    
    Indicates to the framework that the configured processor has one or more incoming connections for which the processor is not also the source.
    
    Specified by:
    
    setNonLoopConnection in interface TestRunner
    
    Parameters:
    
    hasNonLoopConnection - whether or not the configured processor should behave as though it has a non-looping incoming connection
  - addConnection
```
public void addConnection(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the configured processor has a connection for the given Relationship.
    
    Specified by:
    
    addConnection in interface TestRunner
    
    Parameters:
    
    relationship - that has a connection
  - addConnection
```
public void addConnection(String relationshipName)
```
    Description copied from interface: TestRunner
    
    Indicates to the Framework that the configured processor has a connection for the Relationship with the given name.
    
    Specified by:
    
    addConnection in interface TestRunner
    
    Parameters:
    
    relationshipName - name of relationship that has a connection
  - removeConnection
```
public void removeConnection(Relationship relationship)
```
    Description copied from interface: TestRunner
    
    Removes the connection for the given Relationship from the configured processor.
    
    Specified by:
    
    removeConnection in interface TestRunner
    
    Parameters:
    
    relationship - to remove
  - removeConnection
```
public void removeConnection(String relationshipName)
```
    Description copied from interface: TestRunner
    
    Removes the connection for the relationship with the given name from the configured processor.
    
    Specified by:
    
    removeConnection in interface TestRunner
    
    Parameters:
    
    relationshipName - name of the relationship to remove
  - addControllerService
```
public void addControllerService(String identifier,
                                 ControllerService service)
                          throws InitializationException
```
    Description copied from interface: TestRunner
    
    Adds the given ControllerService to this TestRunner so that the configured Processor can access it using the given identifier. The ControllerService is not expected to be initialized, as the framework will create the appropriate ControllerServiceInitializationContext and initialize the ControllerService with no specified properties. This will call any method on the given Controller Service that is annotated with the @OnAdded annotation.
    
    Specified by:
    
    addControllerService in interface TestRunner
    
    Parameters:
    
    identifier - of service
    
    service - the service
    
    Throws:
    
    InitializationException - ie
  - addControllerService
```
public void addControllerService(String identifier,
                                 ControllerService service,
                                 Map<String,String> properties)
                          throws InitializationException
```
    Description copied from interface: TestRunner
    
    Adds the given ControllerService to this TestRunner so that the configured Processor can access it using the given identifier. The ControllerService is not expected to be initialized, as the framework will create the appropriate ControllerServiceInitializationContext and initialize the ControllerService with the given properties. This will call any method on the given Controller Service that is annotated with the @OnAdded annotation.
    
    Specified by:
    
    addControllerService in interface TestRunner
    
    Parameters:
    
    identifier - of service
    
    service - the service
    
    properties - service properties
    
    Throws:
    
    InitializationException - ie
  - assertNotValid
```
public void assertNotValid(ControllerService service)
```
    Description copied from interface: TestRunner
    
    Assert that the currently configured set of properties/annotation data are NOT valid for the given Controller Service.
    
    Specified by:
    
    assertNotValid in interface TestRunner
    
    Parameters:
    
    service - the service to validate
  - assertValid
```
public void assertValid(ControllerService service)
```
    Description copied from interface: TestRunner
    
    Assert that the currently configured set of properties/annotation data are valid for the given Controller Service.
    
    Specified by:
    
    assertValid in interface TestRunner
    
    Parameters:
    
    service - the service to validate
  - disableControllerService
```
public void disableControllerService(ControllerService service)
```
    Description copied from interface: TestRunner
    
    Marks the Controller Service as disabled so that it cannot be used by other components.
    
    This method will result in calling any method in the Controller Service that is annotated with the @OnDisabled annotation.
    
    Specified by:
    
    disableControllerService in interface TestRunner
    
    Parameters:
    
    service - the service to disable
  - enableControllerService
```
public void enableControllerService(ControllerService service)
```
    Description copied from interface: TestRunner
    
    Marks the Controller Service as enabled so that it can be used by other components.
    
    This method will result in calling any method in the Controller Service that is annotated with the @OnEnabled annotation.
    
    Specified by:
    
    enableControllerService in interface TestRunner
    
    Parameters:
    
    service - the service to enable
  - isControllerServiceEnabled
```
public boolean isControllerServiceEnabled(ControllerService service)
```
    Specified by:
    
    isControllerServiceEnabled in interface TestRunner
    
    Parameters:
    
    service - the service
    
    Returns:
    
    true if the given Controller Service is enabled, false if it is disabled
  - removeControllerService
```
public void removeControllerService(ControllerService service)
```
    Description copied from interface: TestRunner
    
    Removes the Controller Service from the TestRunner. This will call any method on the ControllerService that is annotated with the @OnRemoved annotation.
    
    Specified by:
    
    removeControllerService in interface TestRunner
    
    Parameters:
    
    service - the service
  - setAnnotationData
```
public void setAnnotationData(ControllerService service,
                              String annotationData)
```
    Description copied from interface: TestRunner
    
    Sets the annontation data of the given service to the provided annotation data.
    
    Specified by:
    
    setAnnotationData in interface TestRunner
    
    Parameters:
    
    service - to modify
    
    annotationData - the data
  - getConfigToUpdate
```
private ControllerServiceConfiguration getConfigToUpdate(ControllerService service)
```
  - setProperty
```
public ValidationResult setProperty(ControllerService service,
                                    PropertyDescriptor property,
                                    AllowableValue value)
```
    Description copied from interface: TestRunner
    
    Sets the given property on the given ControllerService
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    service - to modify
    
    property - to modify
    
    value - value to use
    
    Returns:
    
    result
  - setProperty
```
public ValidationResult setProperty(ControllerService service,
                                    PropertyDescriptor property,
                                    String value)
```
    Description copied from interface: TestRunner
    
    Sets the given property on the given ControllerService
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    service - to modify
    
    property - to modify
    
    value - value to use
    
    Returns:
    
    result
  - setProperty
```
public ValidationResult setProperty(ControllerService service,
                                    String propertyName,
                                    String value)
```
    Description copied from interface: TestRunner
    
    Sets the property with the given name on the given ControllerService
    
    Specified by:
    
    setProperty in interface TestRunner
    
    Parameters:
    
    service - to modify
    
    propertyName - to modify
    
    value - value to use
    
    Returns:
    
    result
  - getControllerService
```
public ControllerService getControllerService(String identifier)
```
    Specified by:
    
    getControllerService in interface TestRunner
    
    Parameters:
    
    identifier - of controller service
    
    Returns:
    
    the ControllerService that is registered with the given identifier, or null if no Controller Service exists with the given identifier
  - getControllerService
```
public <T extends ControllerService> T getControllerService(String identifier,
                                                            Class<T> serviceType)
```
    Specified by:
    
    getControllerService in interface TestRunner
    
    Type Parameters:
    
    T - type of service
    
    Parameters:
    
    identifier - identifier of service
    
    serviceType - type of service
    
    Returns:
    
    the ControllerService that is registered with the given identifier, cast as the provided service type, or null if no Controller Service exists with the given identifier
  - removeProperty
```
public boolean removeProperty(PropertyDescriptor descriptor)
```
    Description copied from interface: TestRunner
    
    Removes the PropertyDescriptor from the ProcessContext, effectively setting its value to null, or the property's default value, if it has one.
    
    Specified by:
    
    removeProperty in interface TestRunner
    
    Parameters:
    
    descriptor - of property to remove
    
    Returns:
    
    true if removed, false if the property was not set
  - getProvenanceEvents
```
public List<ProvenanceEventRecord> getProvenanceEvents()
```
    Description copied from interface: TestRunner
    
    Returns a List of all ProvenanceEventRecords that were emitted by the Processor
    
    Specified by:
    
    getProvenanceEvents in interface TestRunner
    
    Returns:
    
    a List of all Provenance Events that were emitted by the Processor
  - clearProvenanceEvents
```
public void clearProvenanceEvents()
```
    Description copied from interface: TestRunner
    
    Clears the Provenance Events that have been emitted by the Processor
    
    Specified by:
    
    clearProvenanceEvents in interface TestRunner
  - getStateManager
```
public MockStateManager getStateManager()
```
    Specified by:
    
    getStateManager in interface TestRunner
    
    Returns:
    
    the State Manager that is used to stored and retrieve state
  - getStateManager
```
public MockStateManager getStateManager(ControllerService controllerService)
```
    Returns the State Manager for the given Controller Service.
    
    Specified by:
    
    getStateManager in interface TestRunner
    
    Parameters:
    
    controllerService - the Controller Service whose State Manager should be returned
    
    Returns:
    
    the State Manager for the given Controller Service
  - getLogger
```
public MockProcessorLog getLogger()
```
    Description copied from interface: TestRunner
    
    Returns the MockProcessorLog that is used by the Processor under test.
    
    Specified by:
    
    getLogger in interface TestRunner
    
    Returns:
    
    the logger
  - getControllerServiceLogger
```
public MockProcessorLog getControllerServiceLogger(String identifier)
```
    Description copied from interface: TestRunner
    
    Returns the MockProcessorLog that is used by the specified controller service.
    
    Specified by:
    
    getControllerServiceLogger in interface TestRunner
    
    Parameters:
    
    identifier - a controller service identifier
    
    Returns:
    
    the logger

Class StandardProcessorTestRunner

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

processor

context

flowFileQueue

sessionFactory

sharedState

idGenerator

triggerSerially

processorStateManager

controllerServiceStateManagers

numThreads

invocations

deprecatedTypeAnnotations

deprecatedMethodAnnotations

controllerServiceLoggers

logger

Constructor Detail

StandardProcessorTestRunner

Method Detail

populateDeprecatedMethods

detectDeprecatedAnnotations

setValidateExpressionUsage

getProcessor

getProcessContext

run

run

run

run

run

shutdown

getProcessSessionFactory

assertAllFlowFilesTransferred

assertAllFlowFilesTransferred

assertAllFlowFilesTransferred

assertAllFlowFilesTransferred

assertTransferCount

assertTransferCount

assertPenalizeCount

assertValid

assertNotValid

isQueueEmpty

assertQueueEmpty

assertQueueNotEmpty

clearTransferState

enqueue

enqueue

enqueue

enqueue

enqueue

enqueue

enqueue

enqueue

enqueue

getContentAsByteArray

getFlowFilesForRelationship

getFlowFilesForRelationship

getPenalizedFlowFiles

getProvenanceReporter

getQueueSize

getCounterValue

getRemovedCount

setAnnotationData

setProperty

setProperty

setProperty

setThreadCount

getThreadCount

setRelationshipAvailable

setRelationshipAvailable

setRelationshipUnavailable

setRelationshipUnavailable

setIncomingConnection

setNonLoopConnection

addConnection