Package org.apache.nifi.toolkit.config.transformer

Class XmlFileTransformer

java.lang.Object

org.apache.nifi.toolkit.config.transformer.XmlFileTransformer

All Implemented Interfaces:

FileTransformer

public class XmlFileTransformer
extends Object
implements FileTransformer

File Transformer supporting transformation of XML configuration files containing property elements

Field Summary

Fields

Modifier and Type	Field	Description
private static final QName	ENCRYPTION_ATTRIBUTE
private final XMLEventFactory	eventFactory
private static final String	IDENTIFIER_ELEMENT_NAME
private final SensitivePropertyProvider	inputSensitivePropertyProvider
private static final QName	NAME_ATTRIBUTE
private static final XMLEventReaderProvider	readerProvider
private static final Pattern	SENSITIVE_PATTERN
private final SensitivePropertyProvider	sensitivePropertyProvider
private final SensitivePropertyProviderFactory	sensitivePropertyProviderFactory

Constructor Summary

Constructors

Constructor	Description
XmlFileTransformer(SensitivePropertyProvider inputSensitivePropertyProvider, SensitivePropertyProviderFactory sensitivePropertyProviderFactory, ProtectionScheme protectionScheme)	XML File Transformer with Sensitive Property Provider Factory and Protection Scheme applied when writing output files

Method Summary

Modifier and Type	Method	Description
private StartElement	getEncryptedStartElement(StartElement startElement)
private String	getEncryptionAttribute(StartElement startElement)
private String	getNameAttribute(StartElement startElement)
private boolean	isEncryptionRequired(StartElement startElement)
private boolean	isEncryptionSupported(String propertyName)
void	transform(Path inputPath, Path outputPath)	Read input file using XMLEventReader and write protected values using XMLEventWriter
protected void	transform(XMLEventReader eventReader, XMLEventWriter eventWriter)	Transform input XML Event Reader to output XML Event Writer
private void	transformStartElement(XMLEventReader eventReader, XMLEventWriter eventWriter, StartElement startElement, String groupIdentifier)

Methods inherited from class java.lang.Object

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

Field Details

SENSITIVE_PATTERN

private static final Pattern SENSITIVE_PATTERN

NAME_ATTRIBUTE

private static final QName NAME_ATTRIBUTE

ENCRYPTION_ATTRIBUTE

private static final QName ENCRYPTION_ATTRIBUTE

IDENTIFIER_ELEMENT_NAME

private static final String IDENTIFIER_ELEMENT_NAME

See Also:

• Constant Field Values

readerProvider

private static final XMLEventReaderProvider readerProvider

eventFactory

private final XMLEventFactory eventFactory

inputSensitivePropertyProvider

private final SensitivePropertyProvider inputSensitivePropertyProvider

sensitivePropertyProviderFactory

private final SensitivePropertyProviderFactory sensitivePropertyProviderFactory

sensitivePropertyProvider

private final SensitivePropertyProvider sensitivePropertyProvider

Constructor Details

XmlFileTransformer

public XmlFileTransformer(SensitivePropertyProvider inputSensitivePropertyProvider,
 SensitivePropertyProviderFactory sensitivePropertyProviderFactory,
 ProtectionScheme protectionScheme)

XML File Transformer with Sensitive Property Provider Factory and Protection Scheme applied when writing output files

Parameters:

sensitivePropertyProviderFactory - Sensitive Property Provider Factory for output files

protectionScheme - Protection Scheme for output files

Method Details

transform

public void transform(Path inputPath,
 Path outputPath)
               throws IOException

Read input file using XMLEventReader and write protected values using XMLEventWriter

Specified by:

transform in interface FileTransformer

Parameters:

inputPath - Input file path to be transformed

outputPath - Output file path containing protected values

Throws:

IOException - Thrown on transformation failures

transform

protected void transform(XMLEventReader eventReader,
 XMLEventWriter eventWriter)
                  throws XMLStreamException

Transform input XML Event Reader to output XML Event Writer

Parameters:

eventReader - XML Event Reader

eventWriter - XML Event Writer

Throws:

XMLStreamException - Thrown on XML processing failures

isEncryptionSupported

private boolean isEncryptionSupported(String propertyName)

isEncryptionRequired

private boolean isEncryptionRequired(StartElement startElement)

transformStartElement

private void transformStartElement(XMLEventReader eventReader,
 XMLEventWriter eventWriter,
 StartElement startElement,
 String groupIdentifier)
                            throws XMLStreamException

Throws:

XMLStreamException

getNameAttribute

private String getNameAttribute(StartElement startElement)

getEncryptionAttribute

private String getEncryptionAttribute(StartElement startElement)

getEncryptedStartElement

private StartElement getEncryptedStartElement(StartElement startElement)