org.apache.nifi.processors.standard

Class ValidateJson

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ValidateJson

All Implemented Interfaces:

ConfigurableComponent, Processor

@SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"JSON","schema","validation"})
 @WritesAttributes(value=@WritesAttribute(attribute="json.validation.errors",description="If the flow file is routed to the invalid relationship , this attribute will contain the error message resulting from the validation failure."))
 @CapabilityDescription(value="Validates the contents of FlowFiles against a configurable JSON Schema. See json-schema.org for specification standards.")
 @SystemResourceConsideration(resource=MEMORY,
                             description="Validating JSON requires reading FlowFile content into memory")
 @Restricted(restrictions=@Restriction(requiredPermission=REFERENCE_REMOTE_RESOURCES,explanation="Schema configuration can reference resources over HTTP"))
public class ValidateJson
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidateJson.SchemaVersion

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_ATTRIBUTE_KEY
private static com.fasterxml.jackson.databind.ObjectMapper	MAPPER
static List<PropertyDescriptor>	PROPERTIES
static Relationship	REL_FAILURE
static Relationship	REL_INVALID
static Relationship	REL_VALID
static Set<Relationship>	RELATIONSHIPS
private com.networknt.schema.JsonSchema	schema
static PropertyDescriptor	SCHEMA_CONTENT
static PropertyDescriptor	SCHEMA_VERSION

Constructor Summary

Constructors

Constructor and Description
ValidateJson()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onScheduled(ProcessContext context)
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

customValidate, 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

ERROR_ATTRIBUTE_KEY

public static final String ERROR_ATTRIBUTE_KEY

See Also:

Constant Field Values

SCHEMA_CONTENT

public static final PropertyDescriptor SCHEMA_CONTENT

SCHEMA_VERSION

public static final PropertyDescriptor SCHEMA_VERSION

PROPERTIES

public static final List<PropertyDescriptor> PROPERTIES

REL_VALID

public static final Relationship REL_VALID

REL_INVALID

public static final Relationship REL_INVALID

REL_FAILURE

public static final Relationship REL_FAILURE

RELATIONSHIPS

public static final Set<Relationship> RELATIONSHIPS

MAPPER

private static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

schema

private com.networknt.schema.JsonSchema schema

Constructor Detail

ValidateJson

public ValidateJson()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)
                              throws IOException

Throws:

IOException

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException