Developer Guide

Also available as:

PDF

Contents

1. NiFi Developer's Guide

Hortonworks DataFlow

Developer Guide

Copyright © 2012-2017 Hortonworks, Inc.

Except where otherwise noted, this document is licensed under Creative Commons Attribution ShareAlike 4.0 License

http://creativecommons.org/licenses/by-sa/4.0/legalcode

1. NiFi Developer's Guide

Introduction

NiFi Components

Processor API

Supporting API
AbstractProcessor API
Component Lifecycle
Restricted
State Manager
Reporting Processor Activity

Documenting a Component

Documenting Properties
Documenting Relationships
Documenting Capability and Keywords
Documenting FlowFile Attribute Interaction
Documenting Related Components
Advanced Documentation

Provenance Events

Common Processor Patterns

Data Ingress
Data Egress
Route Based on Content (One-to-One)
Route Based on Content (One-to-Many)
Route Streams Based on Content (One-to-Many)
Route Based on Attributes
Split Content (One-to-Many)
Update Attributes Based on Content
Enrich/Modify Content

Error Handling

Exceptions within the Processor
Exceptions within a callback: IOException, RuntimeException
Penalization vs. Yielding
Session Rollback

General Design Considerations

Consider the User
Cohesion and Reusability
Naming Conventions
Processor Behavior Annotations
Data Buffering

Controller Services

Developing a ControllerService
Interacting with a ControllerService

Reporting Tasks

Developing a Reporting Task

Command Line Tools

tls-toolkit

Instantiate TestRunner
Add ControllerServices
Set Property Values
Enqueue FlowFiles
Run the Processor
Validate Output
Mocking External Resources
Additional Testing Capabilities

NiFi Archives (NARs)

Per-Instance ClassLoading

How to contribute to Apache NiFi

Technologies
Where to Start?
Supplying a contribution