org.apache.nifi.processor

Interface ProcessContext

All Superinterfaces:

ClusterContext, PropertyContext

public interface ProcessContext
extends PropertyContext, ClusterContext

Provides a bridge between a Processor and the NiFi Framework

Note: Implementations of this interface are NOT necessarily thread-safe.

Method Summary

Modifier and Type	Method and Description
String	decrypt(String encrypted) Decrypts the given value using the password provided in the NiFi Properties
String	encrypt(String unencrypted) Encrypts the given value using the password provided in the NiFi Properties
String	getAnnotationData()
Set<Relationship>	getAvailableRelationships()
ControllerServiceLookup	getControllerServiceLookup()
ExecutionNode	getExecutionNode()
int	getMaxConcurrentTasks()
String	getName()
Map<PropertyDescriptor,String>	getProperties()
PropertyValue	getProperty(String propertyName) Retrieves the current value set for the given descriptor, if a value is set - else uses the descriptor to determine the appropriate default value
int	getRetryCount()
StateManager	getStateManager()
boolean	hasConnection(Relationship relationship)
boolean	hasIncomingConnection()
boolean	hasNonLoopConnection()
boolean	isExpressionLanguagePresent(PropertyDescriptor property)
boolean	isRelationshipRetried(Relationship relationship)
PropertyValue	newPropertyValue(String rawValue) Creates and returns a PropertyValue object that can be used for evaluating the value of the given String
void	yield() Causes the Processor not to be scheduled for some pre-configured amount of time.

Methods inherited from interface org.apache.nifi.context.PropertyContext

getAllProperties, getProperty

Methods inherited from interface org.apache.nifi.context.ClusterContext

isConnectedToCluster

Method Detail

getProperty

PropertyValue getProperty(String propertyName)

Retrieves the current value set for the given descriptor, if a value is set - else uses the descriptor to determine the appropriate default value

Parameters:

propertyName - of the property to lookup the value for

Returns:

property value as retrieved by property name

newPropertyValue

PropertyValue newPropertyValue(String rawValue)

Creates and returns a PropertyValue object that can be used for evaluating the value of the given String

Parameters:

rawValue - the raw input before any property evaluation has occurred

Returns:

a PropertyValue object that can be used for evaluating the value of the given String

yield

void yield()

Causes the Processor not to be scheduled for some pre-configured amount of time. The duration of time for which the processor will not be scheduled is configured in the same manner as the processor's scheduling period.

Note: This is NOT a blocking call and does not suspend execution of the current thread.

getMaxConcurrentTasks

int getMaxConcurrentTasks()

Returns:

the maximum number of threads that may be executing this processor's code at any given time

getExecutionNode

ExecutionNode getExecutionNode()

Returns:

the Nodes where this processor will be scheduled to run.

getAnnotationData

String getAnnotationData()

Returns:

the annotation data configured for this processor

getProperties

Map<PropertyDescriptor,String> getProperties()

Returns:

a Map of all PropertyDescriptors to their configured values. This Map may or may not be modifiable, but modifying its values will not change the values of the processor's properties

encrypt

String encrypt(String unencrypted)

Encrypts the given value using the password provided in the NiFi Properties

Parameters:

unencrypted - plaintext value

Returns:

encrypted value

decrypt

String decrypt(String encrypted)

Decrypts the given value using the password provided in the NiFi Properties

Parameters:

encrypted - the encrypted value

Returns:

the plaintext value

getControllerServiceLookup

ControllerServiceLookup getControllerServiceLookup()

Returns:

a ControllerServiceLookup that can be used to obtain a Controller Service

getAvailableRelationships

Set<Relationship> getAvailableRelationships()

Returns:

the set of all relationships for which space is available to receive new objects

hasIncomingConnection

boolean hasIncomingConnection()

Returns:

true if the processor has one or more incoming connections, false otherwise

hasNonLoopConnection

boolean hasNonLoopConnection()

Returns:

true if the processor has one or more incoming connections for which the source of the connection is NOT the processor; returns false if the processor has no incoming connections or if all incoming connections are self-loops (i.e., the processor is also the source of all incoming connections).

hasConnection

boolean hasConnection(Relationship relationship)

Parameters:

relationship - a relationship to check for connections

Returns:

true if the relationship has one or more outbound connections, false otherwise

isExpressionLanguagePresent

boolean isExpressionLanguagePresent(PropertyDescriptor property)

Parameters:

property - the Property whose value should be inspected to determined if it contains an Expression Language Expression

Returns:

true if the value of the given Property contains a NiFi Expression Language Expression, false if it does not. Note that false will be returned if the Property Descriptor does not allow the Expression Language, even if a seemingly valid Expression is present in the value.

getStateManager

StateManager getStateManager()

Returns:

the StateManager that can be used to store and retrieve state for this component

getName

String getName()

Returns:

the configured name of this processor

isRelationshipRetried

boolean isRelationshipRetried(Relationship relationship)

Returns:

the configured relationships to be retried of this processor

getRetryCount

int getRetryCount()

Returns:

the actual value of the retry counter of this processor