Introduction

Apache NiFi 2.0.0 includes the removal of multiple deprecated extension components and legacy product features. Version 1.18.0 introduced deprecation logging to provide runtime warnings for elements targeted for removal. Upgrading to the latest version 1 release provides the most accurate set of deprecation warnings.

Configuration changes must be completed prior to upgrading from version 1 to avoid failures. Application settings and flow design changes should be completed and tested before upgrading.

Migrating from deprecated components and features requires different steps depending on configured properties. The level of difficulty varies based on the number of properties to be changed and the steps involved to maintain similar behavior.

Processors

Migrating deprecated Processors and properties requires flow design changes. The steps required range from setting different property values to replacing one Processor with one or more Processors providing similar capabilities.

Base64EncodeContent

Alternatives

Migration

Base64EncodeContent supports a single Mode property that can be set to Encode or Decode.

The standard EncodeContent Processor supports Base64 and other formats for both encoding and decoding.

The EncodeContent Processor provides a direct replacement for Base64EncodeContent using standard properties.

Flow Definitions

The Deprecated Flow Definition includes Base64EncodeContent configured for encoding.

• Base64EncodeContent-Deprecated.json

The Migrated Flow Definition replaces Base64EncodeContent with EncodeContent configured with Base64 encoding.

• Base64EncodeContent-Migrated.json

GetHTTP

Alternatives

Migration

GetHTTP supports a number of configurable properties to retrieve data using the HTTP GET method. The URL property controls the primary behavior of the Processor.

GetHTTP requires the Filename property to set the corresponding FlowFile attribute for content retrieved. The Processor requires an SSL Context Service when the URL starts with the HTTPS scheme.

The standard InvokeHTTP Processor supports standard HTTP methods including GET. Unlike GetHTTP, InvokeHTTP does not require an SSL Context Service for accessing HTTPS locations as it defaults to the Java Runtime default certificate authorities.

InvokeHTTP has a required HTTP URL property and defaults to setting the FlowFile filename attribute to a random UUID. The filename attribute can be derived from the URL path using the Response FlowFile Naming Strategy property set to URL_PATH.

InvokeHTTP has lower default socket timeout settings than GetHTTP.

Setting standard InvokeHTTP properties provides functionality similar to GetHTTP,

Flow Definitions

The Deprecated Flow Definition includes GetHTTP configured to retrieve the SHA-256 checksum for the NiFi 1.20.0 distribution. The Flow Definition also includes a required SSL Context Service configured with the Java Runtime cacerts Trust Store.

• GetHTTP-Deprecated.json

The Migrated Flow Definition includes InvokeHTTP configured with the same URL but without the SSL Context Service, which is not required for public trusted HTTPS services.

• GetHTTP-Migrated.json

GetJMSQueue

Alternatives

Migration

GetJMSQueue supports retrieving messages using the Java Message Service Queue interface to access Apache ActiveMQ.

The Processor bundles the ActiveMQ libraries and requires the URL property to specify the JMS server location, and the Destination Name property to specify the JMS queue for retrieval. Additional optional properties support TLS communication and authentication as well as batching.

The standard ConsumeJMS Processor similar functionality to GetJMSQueue, but requires additional configuration. ConsumeJMS does not bundle JMS libraries and requires referencing a local directory containing implementation JAR files.

ConsumeJMS should be configured with a Connection Factory Service implementation of JMSConnectionFactoryProvider with required properties. The ActiveMQ Artemis library provides the current supported version of JMS access.

ConsumeJMS uses the Connection Factory Service along with several other properties to access JMS Queues.

Flow Definitions

The Deprecated Flow Definition includes GetJMSQueue configured for ActiveMQ running on the localhost address with a specified Destination Name.

• GetJMSQueue-Deprecated.json

The Migrated Flow Definition includes ConsumeJMS configured with a JMSConnectionFactoryProvider using the same JMS broker information. The Migrated Flow Definition includes a JMS Parameters context with a Parameter named JmsClientLibrariesPath referencing the local directory containing the Apache ActiveMQ Artemis libraries.

• GetJMSQueue-Migrated.json

HashAttribute

Alternatives

Migration

HashAttribute supports generating an MD5 digest of one more FlowFile attribute name and value pairs. The MD5 algorithm is not secure for cryptographic operations, and alternatives such as the SHA-2 or SHA-3 algorithms should be used.

The CryptographicHashAttribute Processor supports generating a digest of FlowFile attributes using a configurable algorithm.

Each Processor uses different approaches for specifying which FlowFile attributes to hash.

HashAttribute uses the Hash Value Attribute Key property to specify the destination FlowFile attribute name for the computed digest. HashAttribute uses one or more dynamic properties to provide source FlowFile attribute name, and a regular expression value to determine whether the FlowFile attribute should be included in the digest calculation. HashAttribute converts all attribute values to bytes using UTF-8 encoding.

Generating a hash attribute from a single FlowFile attribute name and value pair requires the both standard and dynamic properties.

CryptographicHashAttribute uses dynamic properties to specify the source and destination FlowFile attribute names. The Hash Algorithm property should be configured with SHA-256 or other SHA-2 algorithm.

Generating a hash attribute from a single FlowFile attribute value requires both standard and dynamic properties.

Flow Definitions

The Deprecated Flow Definition includes HashAttribute configured to write a FlowFile attribute named label-hash using the label attribute name and the value of the attribute from the incoming FlowFile.

• HashAttribute-Deprecated.json

The Migrated Flow Definition includes CryptographicHashAttribute configured to write a FlowFile attribute named label-hash using the value of the label attribute from the incoming FlowFile.

• HashAttribute-Migrated.json

HashContent

Alternatives

Migration

HashContent supports generating a digest of FlowFile content using a configurable algorithm and writing the hash to a specified FlowFile attribute.

CryptographicHashContent supports the same basic digest capabilities and writes the hash to a FlowFile attribute name based on the configured algorithm.

The CryptographicHashContent FlowFile attribute name begins with content. When configured with the SHA-256 algorithm, CryptographicHashContent writes a FlowFile attribute named content_SHA-256.

Both Processors have a Hash Algorithm property, but the CryptographicHashContent Processor supports a scoped set of well-defined algorithms instead of depending on the algorithms that the Java Runtime Security Provider enumerates.

Flow Definitions

The Deprecated Flow Definition includes HashContent configured to write a FlowFile attribute named hash.value using the SHA-256 algorithm.

• HashContent-Deprecated.json

The Migrated Flow Definition includes CryptographicHashContent configured with the SHA-256 algorithm. The Migrated Flow Definition also includes an UpdateAttribute Processor that writes a FlowFile attribute named hash.value using the value of content_SHA-256, providing behavior equivalent to the HashContent Hash Attribute Name property.

• HashContent-Migrated.json

InvokeHTTP

Migration

InvokeHTTP includes several deprecated properties for configuring access through a proxy server.

• Proxy Host
• Proxy Port
• Proxy Type
• Proxy Username
• Proxy Password

InvokeHTTP supports a Controller Service property that abstracts proxy server access.

• Proxy Configuration Service

Creating and configuring an instance of StandardProxyConfigurationService with the corresponding property values is required for upgrading.

Flow Definitions

The Deprecated Flow Definition includes InvokeHTTP configured with Proxy Host and Proxy Port properties.

• InvokeHTTP-Proxy-Deprecated.json

The Migrated Flow Definition includes InvokeHTTP configured with a StandardProxyConfigurationService containing the same proxy property values.

• InvokeHTTP-Proxy-Migrated.json