Package org.apache.nifi.util

Class MockProcessContext

java.lang.Object

org.apache.nifi.util.MockControllerServiceLookup

org.apache.nifi.util.MockProcessContext

All Implemented Interfaces:

ClusterContext, PropertyContext, ControllerServiceLookup, NodeTypeProvider, ProcessContext

public class MockProcessContext
extends MockControllerServiceLookup
implements ProcessContext, ControllerServiceLookup, NodeTypeProvider

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowExpressionValidation
private String	annotationData
private final ConfigurableComponent	component
private final String	componentName
private Set<Relationship>	connections
private boolean	enableExpressionValidation
private Map<String,String>	environmentVariables
private boolean	incomingConnection
private InputRequirement	inputRequirement
private boolean	isClustered
private boolean	isConfiguredForClustering
private boolean	isConnected
private boolean	isPrimaryNode
private int	maxConcurrentTasks
private boolean	nonLoopConnection
private final Map<PropertyDescriptor,String>	properties
private final StateManager	stateManager
private Set<Relationship>	unavailableRelationships
private boolean	yieldCalled

Constructor Summary

Constructors

Constructor	Description
MockProcessContext(ConfigurableComponent component)
MockProcessContext(ConfigurableComponent component, String componentName)
MockProcessContext(ConfigurableComponent component, String componentName, StateManager stateManager, Map<String,String> environmentVariables)	Creates a new MockProcessContext for the given Processor with given name
MockProcessContext(ConfigurableComponent component, StateManager stateManager)	Creates a new MockProcessContext for the given Processor
MockProcessContext(ControllerService component, String componentName, MockProcessContext context, StateManager stateManager, Map<String,String> environmentVariables)
MockProcessContext(ControllerService component, MockProcessContext context, StateManager stateManager, Map<String,String> environmentVariables)

Method Summary

Modifier and Type	Method	Description
void	addConnection(Relationship relationship)
void	addControllerService(String serviceIdentifier, ControllerService controllerService, Map<PropertyDescriptor,String> properties, String annotationData)
void	assertValid()
void	clearProperties()
void	disableExpressionValidation()
void	enableExpressionValidation()
Map<String,String>	getAllProperties()
String	getAnnotationData()
Set<Relationship>	getAvailableRelationships()
(package private) String	getControllerServiceAnnotationData(ControllerService controllerService)
ControllerServiceLookup	getControllerServiceLookup()
(package private) Map<PropertyDescriptor,String>	getControllerServiceProperties(ControllerService controllerService)
Map<String,String>	getEnvironmentVariables()
ExecutionNode	getExecutionNode()
InputRequirement	getInputRequirement()
int	getMaxConcurrentTasks()
String	getName()
Map<PropertyDescriptor,String>	getProperties()
PropertyValue	getProperty(String propertyName)
PropertyValue	getProperty(PropertyDescriptor descriptor)
PropertyDescriptor	getPropertyDescriptor(String propertyName)
PropertyValue	getPropertyWithoutValidatingExpressions(PropertyDescriptor propertyDescriptor)
int	getRetryCount()
StateManager	getStateManager()
Set<Relationship>	getUnavailableRelationships()
boolean	hasConnection(Relationship relationship)
boolean	hasIncomingConnection()
boolean	hasNonLoopConnection()
boolean	isClustered()
boolean	isConfiguredForClustering()
boolean	isConnectedToCluster()
boolean	isExpressionLanguagePresent(PropertyDescriptor property)
boolean	isPrimary()
boolean	isRelationshipRetried(Relationship relationship)
boolean	isValid()
boolean	isYieldCalled()
PropertyValue	newPropertyValue(String rawValue)
void	removeConnection(Relationship relationship)
boolean	removeProperty(String property)
boolean	removeProperty(PropertyDescriptor descriptor)
void	setAnnotationData(String annotationData)
void	setClustered(boolean clustered)
void	setConnected(boolean connected)
void	setConnections(Set<Relationship> connections)
void	setIncomingConnection(boolean hasIncomingConnection)
void	setIsConfiguredForClustering(boolean isConfiguredForClustering)
void	setMaxConcurrentTasks(int maxConcurrentTasks)
void	setNonLoopConnection(boolean hasNonLoopConnection)
void	setPrimaryNode(boolean primaryNode)
ValidationResult	setProperty(String propertyName, String propertyValue)
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.
void	setUnavailableRelationships(Set<Relationship> relationships)
void	setValidateExpressionUsage(boolean validate)
Collection<ValidationResult>	validate()	Validates the current properties, returning ValidationResults for any invalid properties.
protected final Collection<ValidationResult>	validateReferencedControllerServices(ValidationContext validationContext)
void	yield()

Methods inherited from class org.apache.nifi.util.MockControllerServiceLookup

addControllerService, addControllerService, addControllerServices, getConfiguration, getControllerService, getControllerServiceIdentifiers, getControllerServiceName, getControllerServices, isControllerServiceEnabled, isControllerServiceEnabled, isControllerServiceEnabling, removeControllerService

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.controller.ControllerServiceLookup

getControllerService, getControllerServiceIdentifiers, getControllerServiceName, isControllerServiceEnabled, isControllerServiceEnabled, isControllerServiceEnabling

Methods inherited from interface org.apache.nifi.controller.NodeTypeProvider

getClusterMembers, getCurrentNode, isConnected

Field Details

component

private final ConfigurableComponent component

componentName

private final String componentName

properties

private final Map<PropertyDescriptor,String> properties

stateManager

private final StateManager stateManager

annotationData

private String annotationData

yieldCalled

private boolean yieldCalled

enableExpressionValidation

private boolean enableExpressionValidation

allowExpressionValidation

private boolean allowExpressionValidation

incomingConnection

private volatile boolean incomingConnection

nonLoopConnection

private volatile boolean nonLoopConnection

inputRequirement

private volatile InputRequirement inputRequirement

maxConcurrentTasks

private int maxConcurrentTasks

connections

private volatile Set<Relationship> connections

unavailableRelationships

private volatile Set<Relationship> unavailableRelationships

isClustered

private volatile boolean isClustered

isConfiguredForClustering

private volatile boolean isConfiguredForClustering

isPrimaryNode

private volatile boolean isPrimaryNode

isConnected

private volatile boolean isConnected

environmentVariables

private Map<String,String> environmentVariables

Constructor Details

MockProcessContext

public MockProcessContext(ConfigurableComponent component)

MockProcessContext

public MockProcessContext(ConfigurableComponent component,
 String componentName)

MockProcessContext

public MockProcessContext(ConfigurableComponent component,
 StateManager stateManager)

Creates a new MockProcessContext for the given Processor

Parameters:

component - being mocked

stateManager - state manager

MockProcessContext

public MockProcessContext(ControllerService component,
 MockProcessContext context,
 StateManager stateManager,
 Map<String,String> environmentVariables)

MockProcessContext

public MockProcessContext(ControllerService component,
 String componentName,
 MockProcessContext context,
 StateManager stateManager,
 Map<String,String> environmentVariables)

MockProcessContext

public MockProcessContext(ConfigurableComponent component,
 String componentName,
 StateManager stateManager,
 Map<String,String> environmentVariables)

Creates a new MockProcessContext for the given Processor with given name

Parameters:

component - being mocked

componentName - the name to be given the component;

stateManager - state manager

Method Details

getProperty

public PropertyValue getProperty(PropertyDescriptor descriptor)

Specified by:

getProperty in interface PropertyContext

getPropertyWithoutValidatingExpressions

public PropertyValue getPropertyWithoutValidatingExpressions(PropertyDescriptor propertyDescriptor)

getProperty

public PropertyValue getProperty(String propertyName)

Specified by:

getProperty in interface ProcessContext

newPropertyValue

public PropertyValue newPropertyValue(String rawValue)

Specified by:

newPropertyValue in interface ProcessContext

setProperty

public ValidationResult setProperty(String propertyName,
 String propertyValue)

getPropertyDescriptor

public PropertyDescriptor getPropertyDescriptor(String propertyName)

setProperty

public 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. Otherwise, the property value is not updated. In either case, the ValidationResult is returned, indicating whether or not the property is valid

Parameters:

descriptor - of property to modify

value - new value

Returns:

result

removeProperty

public boolean removeProperty(PropertyDescriptor descriptor)

removeProperty

public boolean removeProperty(String property)

clearProperties

public void clearProperties()

yield

public void yield()

Specified by:

yield in interface ProcessContext

isYieldCalled

public boolean isYieldCalled()

addControllerService

public void addControllerService(String serviceIdentifier,
 ControllerService controllerService,
 Map<PropertyDescriptor,String> properties,
 String annotationData)

getMaxConcurrentTasks

public int getMaxConcurrentTasks()

Specified by:

getMaxConcurrentTasks in interface ProcessContext

getExecutionNode

public ExecutionNode getExecutionNode()

Specified by:

getExecutionNode in interface ProcessContext

setAnnotationData

public void setAnnotationData(String annotationData)

getAnnotationData

public String getAnnotationData()

Specified by:

getAnnotationData in interface ProcessContext

getProperties

public Map<PropertyDescriptor,String> getProperties()

Specified by:

getProperties in interface ProcessContext

getAllProperties

public Map<String,String> getAllProperties()

Specified by:

getAllProperties in interface PropertyContext

validate

public Collection<ValidationResult> validate()

Validates the current properties, returning ValidationResults for any invalid properties. All processor defined properties will be validated. If they are not included in the in the purposed configuration, the default value will be used.

Returns:

Collection of validation result objects for any invalid findings only. If the collection is empty then the processor is valid. Guaranteed non-null

validateReferencedControllerServices

protected final Collection<ValidationResult> validateReferencedControllerServices(ValidationContext validationContext)

isValid

public boolean isValid()

assertValid

public void assertValid()

setValidateExpressionUsage

public void setValidateExpressionUsage(boolean validate)

enableExpressionValidation

public void enableExpressionValidation()

disableExpressionValidation

public void disableExpressionValidation()

getControllerServiceProperties

Map<PropertyDescriptor,String> getControllerServiceProperties(ControllerService controllerService)

getControllerServiceAnnotationData

String getControllerServiceAnnotationData(ControllerService controllerService)

getControllerServiceLookup

public ControllerServiceLookup getControllerServiceLookup()

Specified by:

getControllerServiceLookup in interface ProcessContext

getAvailableRelationships

public Set<Relationship> getAvailableRelationships()

Specified by:

getAvailableRelationships in interface ProcessContext

setUnavailableRelationships

public void setUnavailableRelationships(Set<Relationship> relationships)

getUnavailableRelationships

public Set<Relationship> getUnavailableRelationships()

hasIncomingConnection

public boolean hasIncomingConnection()

Specified by:

hasIncomingConnection in interface ProcessContext

setIncomingConnection

public void setIncomingConnection(boolean hasIncomingConnection)

hasConnection

public boolean hasConnection(Relationship relationship)

Specified by:

hasConnection in interface ProcessContext

setNonLoopConnection

public void setNonLoopConnection(boolean hasNonLoopConnection)

hasNonLoopConnection

public boolean hasNonLoopConnection()

Specified by:

hasNonLoopConnection in interface ProcessContext

addConnection

public void addConnection(Relationship relationship)

removeConnection

public void removeConnection(Relationship relationship)

setConnections

public void setConnections(Set<Relationship> connections)

isExpressionLanguagePresent

public boolean isExpressionLanguagePresent(PropertyDescriptor property)

Specified by:

isExpressionLanguagePresent in interface ProcessContext

getStateManager

public StateManager getStateManager()

Specified by:

getStateManager in interface ProcessContext

getName

public String getName()

Specified by:

getName in interface ProcessContext

setMaxConcurrentTasks

public void setMaxConcurrentTasks(int maxConcurrentTasks)

isClustered

public boolean isClustered()

Specified by:

isClustered in interface NodeTypeProvider

isConfiguredForClustering

public boolean isConfiguredForClustering()

Specified by:

isConfiguredForClustering in interface NodeTypeProvider

isPrimary

public boolean isPrimary()

Specified by:

isPrimary in interface NodeTypeProvider

setClustered

public void setClustered(boolean clustered)

setIsConfiguredForClustering

public void setIsConfiguredForClustering(boolean isConfiguredForClustering)

setPrimaryNode

public void setPrimaryNode(boolean primaryNode)

getInputRequirement

public InputRequirement getInputRequirement()

Overrides:

getInputRequirement in class MockControllerServiceLookup

setConnected

public void setConnected(boolean connected)

isConnectedToCluster

public boolean isConnectedToCluster()

Specified by:

isConnectedToCluster in interface ClusterContext

getRetryCount

public int getRetryCount()

Specified by:

getRetryCount in interface ProcessContext

isRelationshipRetried

public boolean isRelationshipRetried(Relationship relationship)

Specified by:

isRelationshipRetried in interface ProcessContext

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()