org.apache.nifi.processor

Interface ProcessContext

All Known Subinterfaces:

SchedulingContext

public interface ProcessContext

Provides a bridge between a Processor and the NiFi Framework

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

Method Summary

Methods

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() Provides a ControllerServiceLookup that can be used to obtain a Controller Service
int	getMaxConcurrentTasks()
Map<PropertyDescriptor,String>	getProperties() Returns a Map of all PropertyDescriptors to their configured values.
PropertyValue	getProperty(PropertyDescriptor descriptor) Retrieves the current value set for the given descriptor, if a value is set - else uses the descriptor to determine the appropriate default value
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
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.

Method Detail

getProperty

PropertyValue getProperty(PropertyDescriptor descriptor)

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:

descriptor -

Returns:

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 -

Returns:

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 -

Returns:

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

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

Returns:

encrypt

String encrypt(String unencrypted)

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

Parameters:

unencrypted -

Returns:

decrypt

String decrypt(String encrypted)

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

Parameters:

encrypted -

Returns:

getControllerServiceLookup

ControllerServiceLookup getControllerServiceLookup()

Provides a ControllerServiceLookup that can be used to obtain a Controller Service

Returns:

getAvailableRelationships

Set<Relationship> getAvailableRelationships()

Returns:

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