org.apache.nifi.components

Interface ValidationContext

public interface ValidationContext

Method Summary

Modifier and Type	Method and Description
String	getAnnotationData()
ControllerServiceLookup	getControllerServiceLookup()
ValidationContext	getControllerServiceValidationContext(ControllerService controllerService)
Map<PropertyDescriptor,String>	getProperties()
PropertyValue	getProperty(PropertyDescriptor property)
boolean	isExpressionLanguagePresent(String value)
boolean	isExpressionLanguageSupported(String propertyName)
boolean	isValidationRequired(ControllerService service) There are times when the framework needs to consider a component valid, even if it references an invalid ControllerService.
ExpressionLanguageCompiler	newExpressionLanguageCompiler()
PropertyValue	newPropertyValue(String value)

Method Detail

getControllerServiceLookup

ControllerServiceLookup getControllerServiceLookup()

Returns:

the ControllerServiceLookup which can be used to obtain Controller Services

getControllerServiceValidationContext

ValidationContext getControllerServiceValidationContext(ControllerService controllerService)

Parameters:

controllerService - to lookup the validation context of

Returns:

a ValidationContext that is appropriate for validating the given ControllerService

newExpressionLanguageCompiler

ExpressionLanguageCompiler newExpressionLanguageCompiler()

Returns:

a new ExpressionLanguageCompiler that can be used to compile & evaluate Attribute Expressions

getProperty

PropertyValue getProperty(PropertyDescriptor property)

Parameters:

property - being validated

Returns:

a PropertyValue that encapsulates the value configured for the given PropertyDescriptor

newPropertyValue

PropertyValue newPropertyValue(String value)

Parameters:

value - to make a PropertyValue object for

Returns:

a PropertyValue that represents the given value

getProperties

Map<PropertyDescriptor,String> getProperties()

Returns:

a Map of all configured Properties

getAnnotationData

String getAnnotationData()

Returns:

the currently configured Annotation Data

isValidationRequired

boolean isValidationRequired(ControllerService service)

There are times when the framework needs to consider a component valid, even if it references an invalid ControllerService. This method will return false if the component is to be considered valid even if the given Controller Service is referenced and is invalid.

Parameters:

service - to check if validation is required

Returns:

false if the component is to be considered valid even if the given Controller Service is referenced and is invalid

isExpressionLanguagePresent

boolean isExpressionLanguagePresent(String value)

Parameters:

value - to test whether expression language is present

Returns:

true if the given value contains a NiFi Expression Language expression, false if it does not

isExpressionLanguageSupported

boolean isExpressionLanguageSupported(String propertyName)

Parameters:

propertyName - to test whether expression language is supported

Returns:

true if the property with the given name supports the NiFi Expression Language, false if the property does not support the Expression Language or is not a valid property name