Package org.apache.nifi.processors.standard

Class ForkRecord

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.standard.ForkRecord
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@SideEffectFree @SupportsBatching @InputRequirement(INPUT_REQUIRED) @Tags({"fork","record","content","array","stream","event"}) @CapabilityDescription("This processor allows the user to fork a record into multiple records. The user must specify at least one Record Path, as a dynamic property, pointing to a field of type ARRAY containing RECORD objects. The processor accepts two modes: \'split\' and \'extract\'. In both modes, there is one record generated per element contained in the designated array. In the \'split\' mode, each generated record will preserve the same schema as given in the input but the array will contain only one element. In the \'extract\' mode, the element of the array must be of record type and will be the generated record. Additionally, in the \'extract\' mode, it is possible to specify if each generated record should contain all the fields of the parent records from the root level to the extracted record. This assumes that the fields to add in the record are defined in the schema of the Record Writer controller service. See examples in the additional details documentation of this processor.") @DynamicProperty(name="Record Path property", value="The Record Path value", expressionLanguageScope=FLOWFILE_ATTRIBUTES, description="A Record Path value, pointing to a field of type ARRAY containing RECORD objects") @WritesAttribute(attribute="record.count",description="The generated FlowFile will have a \'record.count\' attribute indicating the number of records that were written to the FlowFile.") @WritesAttribute(attribute="mime.type",description="The MIME Type indicated by the Record Writer") @WritesAttribute(attribute="<Attributes from Record Writer>",description="Any Attribute that the configured Record Writer returns will be added to the FlowFile.") public class ForkRecord extends org.apache.nifi.processor.AbstractProcessor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    INCLUDE_PARENT_FIELDS
     
    static final org.apache.nifi.components.PropertyDescriptor
    MODE
     
    (package private) static final org.apache.nifi.components.AllowableValue
    MODE_EXTRACT
     
    (package private) static final org.apache.nifi.components.AllowableValue
    MODE_SPLIT
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.components.PropertyDescriptor
    RECORD_READER
     
    static final org.apache.nifi.components.PropertyDescriptor
    RECORD_WRITER
     
    private RecordPathCache
    recordPathCache
     
    static final org.apache.nifi.processor.Relationship
    REL_FAILURE
     
    static final org.apache.nifi.processor.Relationship
    REL_FORK
     
    static final org.apache.nifi.processor.Relationship
    REL_ORIGINAL
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForkRecord()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Collection<org.apache.nifi.components.ValidationResult>
    customValidate(org.apache.nifi.components.ValidationContext validationContext)
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    protected org.apache.nifi.components.PropertyDescriptor
    getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    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

    • recordPathCache

      private volatile RecordPathCache recordPathCache

    • MODE_EXTRACT

      static final org.apache.nifi.components.AllowableValue MODE_EXTRACT

    • MODE_SPLIT

      static final org.apache.nifi.components.AllowableValue MODE_SPLIT

    • RECORD_READER

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

    • RECORD_WRITER

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

    • MODE

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

    • INCLUDE_PARENT_FIELDS

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

    • PROPERTY_DESCRIPTORS

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

    • REL_FORK

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

    • REL_ORIGINAL

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

    • REL_FAILURE

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

    • RELATIONSHIPS

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

  • Constructor Details

    • ForkRecord

      public ForkRecord()

  • Method Details

    • getSupportedPropertyDescriptors

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

    • 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

    • getSupportedDynamicPropertyDescriptor

      protected org.apache.nifi.components.PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
      Overrides:
      getSupportedDynamicPropertyDescriptor 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

    • onTrigger

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