org.apache.nifi.processors.standard

Class TransformXml

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.TransformXml

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"xml","xslt","transform"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Applies the provided XSLT file to the FlowFile XML payload. A new FlowFile is created with transformed content and is routed to the \'success\' relationship. If the XSL transform fails, the original FlowFile is routed to the \'failure\' relationship")
 @DynamicProperty(name="An XSLT transform parameter name",
                 value="An XSLT transform parameter value",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="These XSLT parameters are passed to the transformer")
public class TransformXml
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TransformXml.ErrorListenerLogger

Field Summary

Fields

Modifier and Type	Field and Description
private com.github.benmanes.caffeine.cache.LoadingCache<String,Templates>	cache
static PropertyDescriptor	CACHE_SIZE
static PropertyDescriptor	CACHE_TTL_AFTER_LAST_ACCESS
static PropertyDescriptor	INDENT_OUTPUT
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SECURE_PROCESSING
static PropertyDescriptor	XSLT_CONTROLLER
static PropertyDescriptor	XSLT_CONTROLLER_KEY
static PropertyDescriptor	XSLT_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
TransformXml()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private TransformXml.ErrorListenerLogger	getErrorListenerLogger()
Set<Relationship>	getRelationships()
private Source	getSecureSource(StreamSource streamSource)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private StreamSource	getTemplateSource(LookupService<String> lookupService, String path, boolean filePath)
private TransformerFactory	getTransformerFactory(boolean secureProcessing)
protected void	init(ProcessorInitializationContext context)
private Templates	newTemplates(ProcessContext context, String path)
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, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

equals, getPropertyDescriptor, getPropertyDescriptors, 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

XSLT_FILE_NAME

public static final PropertyDescriptor XSLT_FILE_NAME

XSLT_CONTROLLER

public static final PropertyDescriptor XSLT_CONTROLLER

XSLT_CONTROLLER_KEY

public static final PropertyDescriptor XSLT_CONTROLLER_KEY

INDENT_OUTPUT

public static final PropertyDescriptor INDENT_OUTPUT

SECURE_PROCESSING

public static final PropertyDescriptor SECURE_PROCESSING

CACHE_SIZE

public static final PropertyDescriptor CACHE_SIZE

CACHE_TTL_AFTER_LAST_ACCESS

public static final PropertyDescriptor CACHE_TTL_AFTER_LAST_ACCESS

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

cache

private com.github.benmanes.caffeine.cache.LoadingCache<String,Templates> cache

Constructor Detail

TransformXml

public TransformXml()

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

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

getErrorListenerLogger

private TransformXml.ErrorListenerLogger getErrorListenerLogger()

newTemplates

private Templates newTemplates(ProcessContext context,
                               String path)
                        throws TransformerConfigurationException,
                               LookupFailureException

Throws:

TransformerConfigurationException

LookupFailureException

getTransformerFactory

private TransformerFactory getTransformerFactory(boolean secureProcessing)
                                          throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getTemplateSource

private StreamSource getTemplateSource(LookupService<String> lookupService,
                                       String path,
                                       boolean filePath)
                                throws LookupFailureException

Throws:

LookupFailureException

getSecureSource

private Source getSecureSource(StreamSource streamSource)
                        throws TransformerConfigurationException

Throws:

TransformerConfigurationException