org.apache.nifi.processor

Class StandardSchedulingContext

java.lang.Object

org.apache.nifi.processor.StandardSchedulingContext

All Implemented Interfaces:

PropertyContext, ProcessContext, SchedulingContext

public class StandardSchedulingContext
extends java.lang.Object
implements SchedulingContext

Constructor Summary

Constructors

Constructor and Description
StandardSchedulingContext(ProcessContext processContext, ControllerServiceProvider serviceProvider, ProcessorNode processorNode, StateManager stateManager)

Method Summary

Modifier and Type	Method and Description
java.lang.String	decrypt(java.lang.String encrypted) Decrypts the given value using the password provided in the NiFi Properties
java.lang.String	encrypt(java.lang.String unencrypted) Encrypts the given value using the password provided in the NiFi Properties
java.util.Map<java.lang.String,java.lang.String>	getAllProperties()
java.lang.String	getAnnotationData()
java.util.Set<Relationship>	getAvailableRelationships()
ControllerServiceLookup	getControllerServiceLookup()
int	getMaxConcurrentTasks()
java.lang.String	getName()
java.util.Map<PropertyDescriptor,java.lang.String>	getProperties()
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(java.lang.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
StateManager	getStateManager()
boolean	hasConnection(Relationship relationship)
boolean	hasIncomingConnection()
boolean	hasNonLoopConnection()
boolean	isExpressionLanguagePresent(PropertyDescriptor property)
void	leaseControllerService(java.lang.String identifier) Indicates to the framework that the Controller Service with the given identifier will be used by this Processor.
PropertyValue	newPropertyValue(java.lang.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 class java.lang.Object

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

Constructor Detail

StandardSchedulingContext

public StandardSchedulingContext(ProcessContext processContext,
                                 ControllerServiceProvider serviceProvider,
                                 ProcessorNode processorNode,
                                 StateManager stateManager)

Method Detail

leaseControllerService

public void leaseControllerService(java.lang.String identifier)

Description copied from interface: SchedulingContext

Indicates to the framework that the Controller Service with the given identifier will be used by this Processor. This will prevent any Data Flow Manager from disabling the Controller Service while this Processor is still running.

Generally, a Controller Service is accessed by indicating in a PropertyDescriptor that the PropertyDescriptor identifies a Controller Service via the identifiesControllerService(Class) method and then calling PropertyContext.getProperty(PropertyDescriptor).asControllerService(Class). In this case, it is not necessary to lease the Controller Service, as the Framework will handle this.

There are, however, cases in which a Controller Service must be accessed in a different way, via the ControllerServiceLookup (accessed via ProcessContext.getControllerServiceLookup()). In this case, the Controller Service that is obtained from the ControllerServiceLookup can be disabled by a Data Flow Manager while it is still in use by a Processor, causing IllegalStateException to be thrown whenever the Processor attempts to interact with the service. This method provides a mechanism by which a Processor is able to indicate that the Controller Service with the given identifier should not be disabled while this Processor is running.

For any Controller Service that is leased by calling this method, the lease will automatically be terminated, allowing the Controller Service to be disabled, whenever the Processor is stopped.

Specified by:

leaseControllerService in interface SchedulingContext

getProperty

public PropertyValue getProperty(PropertyDescriptor descriptor)

Description copied from interface: PropertyContext

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

Specified by:

getProperty in interface PropertyContext

Parameters:

descriptor - to lookup the value of

Returns:

the property value of the given descriptor

getProperty

public PropertyValue getProperty(java.lang.String propertyName)

Description copied from interface: ProcessContext

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

Specified by:

getProperty in interface ProcessContext

Parameters:

propertyName - of the property to lookup the value for

Returns:

property value as retrieved by property name

newPropertyValue

public PropertyValue newPropertyValue(java.lang.String rawValue)

Description copied from interface: ProcessContext

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

Specified by:

newPropertyValue in interface ProcessContext

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

public void yield()

Description copied from interface: ProcessContext

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.

Specified by:

yield in interface ProcessContext

getMaxConcurrentTasks

public int getMaxConcurrentTasks()

Specified by:

getMaxConcurrentTasks in interface ProcessContext

Returns:

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

getAnnotationData

public java.lang.String getAnnotationData()

Specified by:

getAnnotationData in interface ProcessContext

Returns:

the annotation data configured for this processor

getProperties

public java.util.Map<PropertyDescriptor,java.lang.String> getProperties()

Specified by:

getProperties in interface ProcessContext

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

getAllProperties

public java.util.Map<java.lang.String,java.lang.String> getAllProperties()

Specified by:

getAllProperties in interface PropertyContext

encrypt

public java.lang.String encrypt(java.lang.String unencrypted)

Description copied from interface: ProcessContext

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

Specified by:

encrypt in interface ProcessContext

Parameters:

unencrypted - plaintext value

Returns:

encrypted value

decrypt

public java.lang.String decrypt(java.lang.String encrypted)

Description copied from interface: ProcessContext

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

Specified by:

decrypt in interface ProcessContext

Parameters:

encrypted - the encrypted value

Returns:

the plaintext value

getControllerServiceLookup

public ControllerServiceLookup getControllerServiceLookup()

Specified by:

getControllerServiceLookup in interface ProcessContext

Returns:

a ControllerServiceLookup that can be used to obtain a Controller Service

getAvailableRelationships

public java.util.Set<Relationship> getAvailableRelationships()

Specified by:

getAvailableRelationships in interface ProcessContext

Returns:

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

hasIncomingConnection

public boolean hasIncomingConnection()

Specified by:

hasIncomingConnection in interface ProcessContext

Returns:

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

hasNonLoopConnection

public boolean hasNonLoopConnection()

Specified by:

hasNonLoopConnection in interface ProcessContext

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

public boolean hasConnection(Relationship relationship)

Specified by:

hasConnection in interface ProcessContext

Parameters:

relationship - a relationship to check for connections

Returns:

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

isExpressionLanguagePresent

public boolean isExpressionLanguagePresent(PropertyDescriptor property)

Specified by:

isExpressionLanguagePresent in interface ProcessContext

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

public StateManager getStateManager()

Specified by:

getStateManager in interface ProcessContext

Returns:

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

getName

public java.lang.String getName()

Specified by:

getName in interface ProcessContext

Returns:

the configured name of this processor