org.apache.nifi.processors.standard

Class ValidateRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ValidateRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"record","schema","validate"})
 @CapabilityDescription(value="Validates the Records of an incoming FlowFile against a given schema. All records that adhere to the schema are routed to the \"valid\" relationship while records that do not adhere to the schema are routed to the \"invalid\" relationship. It is therefore possible for a single incoming FlowFile to be split into two individual FlowFiles if some records are valid according to the schema and others are not. Any FlowFile that is routed to the \"invalid\" relationship will emit a ROUTE Provenance Event with the Details field populated to explain why records were invalid. In addition, to gain further explanation of why records were invalid, DEBUG-level logging can be enabled for the \"org.apache.nifi.processors.standard.ValidateRecord\" logger.")
 @WritesAttribute(attribute="mime.type",description="Sets the mime.type attribute to the MIME Type specified by the Record Writer") @WritesAttribute(attribute="record.count",description="The number of records in the FlowFile routed to a relationship")
public class ValidateRecord
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ALLOW_EXTRA_FIELDS
(package private) static PropertyDescriptor	COERCE_TYPES
(package private) static PropertyDescriptor	INVALID_RECORD_WRITER
(package private) static PropertyDescriptor	MAX_VALIDATION_DETAILS_LENGTH
(package private) static AllowableValue	READER_SCHEMA
(package private) static PropertyDescriptor	RECORD_READER
(package private) static PropertyDescriptor	RECORD_WRITER
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_INVALID
(package private) static Relationship	REL_VALID
(package private) static PropertyDescriptor	SCHEMA_ACCESS_STRATEGY
(package private) static PropertyDescriptor	SCHEMA_NAME
(package private) static AllowableValue	SCHEMA_NAME_PROPERTY
static PropertyDescriptor	SCHEMA_REGISTRY
(package private) static PropertyDescriptor	SCHEMA_TEXT
(package private) static AllowableValue	SCHEMA_TEXT_PROPERTY
(package private) static PropertyDescriptor	STRICT_TYPE_CHECKING
(package private) static PropertyDescriptor	VALIDATION_DETAILS_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
ValidateRecord()

Method Summary

Modifier and Type	Method and Description
private void	closeQuietly(RecordSetWriter writer)
private void	completeFlowFile(ProcessContext context, ProcessSession session, FlowFile flowFile, RecordSetWriter writer, Relationship relationship, String details)
private RecordSetWriter	createIfNecessary(RecordSetWriter writer, RecordSetWriterFactory factory, ProcessSession session, FlowFile flowFile, RecordSchema outputSchema)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected RecordSchema	getValidationSchema(ProcessContext context, FlowFile flowFile, RecordReader reader)
private void	logValidationErrors(FlowFile flowFile, int recordCount, SchemaValidationResult result)
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SCHEMA_NAME_PROPERTY

static final AllowableValue SCHEMA_NAME_PROPERTY

SCHEMA_TEXT_PROPERTY

static final AllowableValue SCHEMA_TEXT_PROPERTY

READER_SCHEMA

static final AllowableValue READER_SCHEMA

RECORD_READER

static final PropertyDescriptor RECORD_READER

RECORD_WRITER

static final PropertyDescriptor RECORD_WRITER

INVALID_RECORD_WRITER

static final PropertyDescriptor INVALID_RECORD_WRITER

SCHEMA_ACCESS_STRATEGY

static final PropertyDescriptor SCHEMA_ACCESS_STRATEGY

SCHEMA_REGISTRY

public static final PropertyDescriptor SCHEMA_REGISTRY

SCHEMA_NAME

static final PropertyDescriptor SCHEMA_NAME

SCHEMA_TEXT

static final PropertyDescriptor SCHEMA_TEXT

ALLOW_EXTRA_FIELDS

static final PropertyDescriptor ALLOW_EXTRA_FIELDS

STRICT_TYPE_CHECKING

static final PropertyDescriptor STRICT_TYPE_CHECKING

COERCE_TYPES

static final PropertyDescriptor COERCE_TYPES

VALIDATION_DETAILS_ATTRIBUTE_NAME

static final PropertyDescriptor VALIDATION_DETAILS_ATTRIBUTE_NAME

MAX_VALIDATION_DETAILS_LENGTH

static final PropertyDescriptor MAX_VALIDATION_DETAILS_LENGTH

REL_VALID

static final Relationship REL_VALID

REL_INVALID

static final Relationship REL_INVALID

REL_FAILURE

static final Relationship REL_FAILURE

Constructor Detail

ValidateRecord

public ValidateRecord()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

closeQuietly

private void closeQuietly(RecordSetWriter writer)

completeFlowFile

private void completeFlowFile(ProcessContext context,
                              ProcessSession session,
                              FlowFile flowFile,
                              RecordSetWriter writer,
                              Relationship relationship,
                              String details)
                       throws IOException

Throws:

IOException

createIfNecessary

private RecordSetWriter createIfNecessary(RecordSetWriter writer,
                                          RecordSetWriterFactory factory,
                                          ProcessSession session,
                                          FlowFile flowFile,
                                          RecordSchema outputSchema)
                                   throws SchemaNotFoundException,
                                          IOException

Throws:

SchemaNotFoundException

IOException

logValidationErrors

private void logValidationErrors(FlowFile flowFile,
                                 int recordCount,
                                 SchemaValidationResult result)

getValidationSchema

protected RecordSchema getValidationSchema(ProcessContext context,
                                           FlowFile flowFile,
                                           RecordReader reader)
                                    throws MalformedRecordException,
                                           IOException,
                                           SchemaNotFoundException

Throws:

MalformedRecordException

IOException

SchemaNotFoundException