org.apache.nifi.processors.standard

Class ValidateXml

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ValidateXml

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"xml","schema","validation","xsd"})
 @WritesAttributes(value=@WritesAttribute(attribute="validatexml.invalid.error",description="If the flow file is routed to the invalid relationship the attribute will contain the error message resulting from the validation failure."))
 @CapabilityDescription(value="Validates XML contained in a FlowFile. By default, the XML is contained in the FlowFile content. If the \'XML Source Attribute\' property is set, the XML to be validated is contained in the specified attribute. It is not recommended to use attributes to hold large XML documents; doing so could adversely affect system performance. Full schema validation is performed if the processor is configured with the XSD schema details. Otherwise, the only validation performed is to ensure the XML syntax is correct and well-formed, e.g. all opening tags are properly closed.")
 @SystemResourceConsideration(resource=MEMORY,
                             description="While this processor supports processing XML within attributes, it is strongly discouraged to hold large amounts of data in attributes. In general, attribute values should be as small as possible and hold no more than a couple hundred characters.")
 @Restricted(restrictions=@Restriction(requiredPermission=REFERENCE_REMOTE_RESOURCES,explanation="Schema configuration can reference resources over HTTP"))
public class ValidateXml
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_ATTRIBUTE_KEY
private List<PropertyDescriptor>	properties
private static XMLStreamReaderProvider	READER_PROVIDER
static Relationship	REL_INVALID
static Relationship	REL_VALID
private Set<Relationship>	relationships
static PropertyDescriptor	SCHEMA_FILE
private static String	SCHEMA_LANGUAGE
private static SchemaValidator	SCHEMA_VALIDATOR
private AtomicReference<Schema>	schemaRef
static PropertyDescriptor	XML_SOURCE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ValidateXml()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
void	parseSchema(ProcessContext context)
private void	validate(InputStream in)

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

onTrigger

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

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, 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_FILE

public static final PropertyDescriptor SCHEMA_FILE

XML_SOURCE_ATTRIBUTE

public static final PropertyDescriptor XML_SOURCE_ATTRIBUTE

REL_VALID

public static final Relationship REL_VALID

REL_INVALID

public static final Relationship REL_INVALID

SCHEMA_LANGUAGE

private static final String SCHEMA_LANGUAGE

See Also:

Constant Field Values

SCHEMA_VALIDATOR

private static final SchemaValidator SCHEMA_VALIDATOR

READER_PROVIDER

private static final XMLStreamReaderProvider READER_PROVIDER

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

schemaRef

private final AtomicReference<Schema> schemaRef

Constructor Detail

ValidateXml

public ValidateXml()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

parseSchema

@OnScheduled
public void parseSchema(ProcessContext context)
                              throws SAXException

Throws:

SAXException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

validate

private void validate(InputStream in)