Package org.apache.nifi.processors.standard

Class ConvertCharacterSet

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.standard.ConvertCharacterSet
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@SideEffectFree @InputRequirement(INPUT_REQUIRED) @SupportsBatching @Tags({"text","convert","characterset","character set"}) @CapabilityDescription("Converts a FlowFile\'s content from one character set to another") public class ConvertCharacterSet extends org.apache.nifi.processor.AbstractProcessor

This processor reads files in as text according to the specified character set and it outputs another text file according to the given character set. The character sets supported depend on the version of the JRE and is platform specific. In addition, the JVM can be expanded with additional character sets to support. More information on which character sets are supported can be found in the JDK documentation under the docs directory in the following path: ....\technotes\guides\intl\encoding.doc.html

The conversion process is very passive. For conversions that do not map perfectly the conversion will replace unmappable or unrecognized input using the '?' character.

The following properties are required:

  • input.charset - The character set of the original file contents
  • output.charset - The character set of the resulting file

The following properties are optional:

  • N/A -

The following relationships are required:

  • success - the id of the processor to transfer successfully converted files
  • failure - the id of the processor to transfer unsuccessfully converted files

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    INPUT_CHARSET
     
    static final int
    MAX_BUFFER_SIZE
     
    static final org.apache.nifi.components.PropertyDescriptor
    OUTPUT_CHARSET
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConvertCharacterSet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    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

    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.components.ConfigurableComponent

    getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

    isStateful, migrateProperties, migrateRelationships

  • Field Details

    • INPUT_CHARSET

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

    • OUTPUT_CHARSET

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

    • 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

    • RELATIONSHIPS

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

    • MAX_BUFFER_SIZE

      public static final int MAX_BUFFER_SIZE
      See Also:

  • Constructor Details

    • ConvertCharacterSet

      public ConvertCharacterSet()

  • 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

    • 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