Package 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:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@SideEffectFree @SupportsBatching @Tags({"xml","xslt","transform"}) @InputRequirement(INPUT_REQUIRED) @CapabilityDescription("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 org.apache.nifi.processor.AbstractProcessor

  • Nested Class Summary

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private com.github.benmanes.caffeine.cache.LoadingCache<String,Templates>
    cache
     
    static final org.apache.nifi.components.PropertyDescriptor
    CACHE_SIZE
     
    static final org.apache.nifi.components.PropertyDescriptor
    CACHE_TTL_AFTER_LAST_ACCESS
     
    static final org.apache.nifi.components.PropertyDescriptor
    INDENT_OUTPUT
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.processor.Relationship
    REL_FAILURE
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     
    static final org.apache.nifi.components.PropertyDescriptor
    SECURE_PROCESSING
     
    static final org.apache.nifi.components.PropertyDescriptor
    XSLT_CONTROLLER
     
    static final org.apache.nifi.components.PropertyDescriptor
    XSLT_CONTROLLER_KEY
     
    static final org.apache.nifi.components.PropertyDescriptor
    XSLT_FILE_NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransformXml()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Collection<org.apache.nifi.components.ValidationResult>
    customValidate(org.apache.nifi.components.ValidationContext validationContext)
     
    private TransformXml.ErrorListenerLogger
    getErrorListenerLogger()
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    private Source
    getSecureSource(StreamSource streamSource)
     
    protected org.apache.nifi.components.PropertyDescriptor
    getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    private StreamSource
    getTemplateSource(LookupService<String> lookupService, String path, boolean filePath)
     
    private TransformerFactory
    getTransformerFactory(boolean secureProcessing)
     
    private Templates
    newTemplates(org.apache.nifi.processor.ProcessContext context, String path)
     
    void
    onScheduled(org.apache.nifi.processor.ProcessContext context)
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.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, 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.components.ConfigurableComponent

    getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

    isStateful, migrateProperties, migrateRelationships

  • Field Details

    • XSLT_FILE_NAME

      public static final org.apache.nifi.components.PropertyDescriptor XSLT_FILE_NAME

    • XSLT_CONTROLLER

      public static final org.apache.nifi.components.PropertyDescriptor XSLT_CONTROLLER

    • XSLT_CONTROLLER_KEY

      public static final org.apache.nifi.components.PropertyDescriptor XSLT_CONTROLLER_KEY

    • INDENT_OUTPUT

      public static final org.apache.nifi.components.PropertyDescriptor INDENT_OUTPUT

    • SECURE_PROCESSING

      public static final org.apache.nifi.components.PropertyDescriptor SECURE_PROCESSING

    • CACHE_SIZE

      public static final org.apache.nifi.components.PropertyDescriptor CACHE_SIZE

    • CACHE_TTL_AFTER_LAST_ACCESS

      public static final org.apache.nifi.components.PropertyDescriptor CACHE_TTL_AFTER_LAST_ACCESS

    • PROPERTY_DESCRIPTORS

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

    • REL_SUCCESS

      public static final org.apache.nifi.processor.Relationship REL_SUCCESS

    • REL_FAILURE

      public static final org.apache.nifi.processor.Relationship REL_FAILURE

    • RELATIONSHIPS

      private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

    • cache

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

  • Constructor Details

    • TransformXml

      public TransformXml()

  • Method Details

    • getRelationships

      public Set<org.apache.nifi.processor.Relationship> getRelationships()
      Specified by:
      getRelationships in interface org.apache.nifi.processor.Processor
      Overrides:
      getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    • getSupportedPropertyDescriptors

      protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • customValidate

      protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext)
      Overrides:
      customValidate in class org.apache.nifi.components.AbstractConfigurableComponent

    • getSupportedDynamicPropertyDescriptor

      protected org.apache.nifi.components.PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
      Overrides:
      getSupportedDynamicPropertyDescriptor in class org.apache.nifi.components.AbstractConfigurableComponent

    • onScheduled

      @OnScheduled public void onScheduled(org.apache.nifi.processor.ProcessContext context)

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session)
      Specified by:
      onTrigger in class org.apache.nifi.processor.AbstractProcessor

    • getErrorListenerLogger

      private TransformXml.ErrorListenerLogger getErrorListenerLogger()

    • newTemplates

      private Templates newTemplates(org.apache.nifi.processor.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