All controller services (alphabetical)¶

This topic provides a list of all openflow controller services in alphabetical order. The list includes:

Type of controller service (Snowflake or not)

The name of each controller service

A summary of each controller service

A¶

	Controller	Description
	ADLSCredentialsControllerService	Defines credentials for ADLS processors.
	ADLSCredentialsControllerServiceLookup	Provides an ADLSCredentialsService that can be used to dynamically select another ADLSCredentialsService.
	AmazonGlueEncodedSchemaReferenceReader	Reads Schema Identifier according to AWS Glue Schema encoding as a header consisting of a two byte markers and a 16 byte UUID
	AmazonGlueSchemaRegistry	Provides a Schema Registry that interacts with the AWS Glue Schema Registry so that those Schemas that are stored in the Glue Schema Registry can be used in NiFi.
	AmazonMSKConnectionService	Provides and manages connections to AWS MSK Kafka Brokers for producer or consumer operations.
	AmazonMSKConnectionService	Provides and manages connections to AWS MSK Kafka Brokers for producer or consumer operations.
	ApicurioSchemaRegistry	Provides a Schema Registry that interacts with the Apicurio Schema Registry so that those Schemas that are stored in the Apicurio Schema Registry can be used in NiFi.
	AvroReader	Parses Avro data and returns each Avro record as an separate Record object.
	AvroRecordSetWriter	Writes the contents of a RecordSet in Binary Avro format.
	AvroSchemaRegistry	Provides a service for registering and accessing schemas.
	AWSCredentialsProviderControllerService	Defines credentials for Amazon Web Services processors.
	AzureBlobStorageFileResourceService	Provides an Azure Blob Storage file resource for other components.
	AzureCosmosDBClientService	Provides a controller service that configures a connection to Cosmos DB (Core SQL API) and provides access to that connection to other Cosmos DB-related components.
	AzureDataLakeStorageFileResourceService	Provides an Azure Data Lake Storage (ADLS) file resource for other components.
	AzureEventHubRecordSink	Format and send Records to Azure Event Hubs
	AzureStorageCredentialsControllerService_v12	Provides credentials for Azure Storage processors using Azure Storage client library v12.
	AzureStorageCredentialsControllerServiceLookup_v12	Provides an AzureStorageCredentialsService_v12 that can be used to dynamically select another AzureStorageCredentialsService_v12.

C¶

	Controller	Description
	CEFReader	Parses CEF (Common Event Format) events, returning each row as a record.
	ConfluentEncodedSchemaReferenceReader	Reads Schema Identifier according to Confluent encoding as a header consisting of a byte marker and an integer represented as four bytes
	ConfluentEncodedSchemaReferenceWriter	Writes Schema Identifier according to Confluent encoding as a header consisting of a byte marker and an integer represented as four bytes
	ConfluentProtobufMessageNameResolver	Resolves Protobuf message names from Confluent Schema Registry wire format by decoding message indexes and looking up the fully qualified name in the schema definition For Confluent wire format reference see: https://docs (https://docs).
	ConfluentSchemaRegistry	Provides a Schema Registry that interacts with the Confluent Schema Registry so that those Schemas that are stored in the Confluent Schema Registry can be used in NiFi.
	CSVReader	Parses CSV-formatted data, returning each row in the CSV file as a separate record.
	CSVRecordLookupService	A reloadable CSV file-based lookup service.
	CSVRecordSetWriter	Writes the contents of a RecordSet as CSV data.

D¶

	Controller	Description
	DatabaseLookup	A Lookup Service that allows for enrichment with a database using a user-specified SQL statement.
	DatabaseRecordLookupService	A relational-database-based lookup service.
	DatabaseRecordSink	Provides a service to write records using a configured database connection.
	DBCPConnectionPool	Provides Database Connection Pooling Service.
	DBCPConnectionPoolLookup	Provides a DBCPService that can be used to dynamically select another DBCPService.
	DeveloperBoxClientService	Provides Box client objects through which Box API calls can be used.
	DistributedMapCacheLookupService	Allows to choose a distributed map cache client to retrieve the value associated to a key.

E¶

	Controller	Description
	ElasticSearchClientServiceImpl	A controller service for accessing an Elasticsearch client, using the Elasticsearch (low-level) REST Client.
	ElasticSearchLookupService	Lookup a record from Elasticsearch Server associated with the specified document ID.
	ElasticSearchStringLookupService	Lookup a string value from Elasticsearch Server associated with the specified document ID.
	EmailRecordSink	Provides a RecordSinkService that can be used to send records in email using the specified writer for formatting.
	EmbeddedHazelcastCacheManager	A service that runs embedded Hazelcast and provides cache instances backed by that.
	ExcelReader	Parses a Microsoft Excel document returning each row in each sheet as a separate record.
	ExternalHazelcastCacheManager	A service that provides cache instances backed by Hazelcast running outside of NiFi.

F¶

	Controller	Description
	FreeFormTextRecordSetWriter	Writes the contents of a RecordSet as free-form text.

G¶

	Controller	Description
	GCPCredentialsControllerService	Defines credentials for Google Cloud Platform processors.
	GCSFileResourceService	Provides a Google Compute Storage (GCS) file resource for other components.
	GrokReader	Provides a mechanism for reading unstructured text data, such as log files, and structuring the data so that it can be processed.

H¶

	Controller	Description
	HazelcastMapCacheClient	An implementation of DistributedMapCacheClient that uses Hazelcast as the backing cache.
	HikariCPConnectionPool	Provides Database Connection Pooling Service based on HikariCP.
	HttpRecordSink	Format and send Records to a configured uri using HTTP post.

I¶

	Controller	Description
	IPLookupService	A lookup service that provides several types of enrichment information for IP addresses.

J¶

	Controller	Description
	JettyWebSocketClient	Implementation of WebSocketClientService.
	JettyWebSocketServer	Implementation of WebSocketServerService.
	JMSConnectionFactoryProvider	Provides a generic service to create vendor specific javax.
	JndiJmsConnectionFactoryProvider	Provides a service to lookup an existing JMS ConnectionFactory using the Java Naming and Directory Interface (JNDI).
	JsonConfigBasedBoxClientService	Provides Box client objects through which Box API calls can be used.
	JsonPathReader	Parses JSON records and evaluates user-defined JSON Path ‘s against each JSON object.
	JsonRecordSetWriter	Writes the results of a RecordSet as either a JSON Array or one JSON object per line.
	JsonTableColumnFilter	Provides a table column filter based on a JSON configuration.
	JsonTreeReader	Parses JSON into individual Record objects.
	JWTBearerOAuth2AccessTokenProvider	Provides OAuth 2.

K¶

	Controller	Description
	Kafka3ConnectionService	Provides and manages connections to Kafka Brokers for producer or consumer operations.
	Kafka3ConnectionService	Provides and manages connections to Kafka Brokers for producer or consumer operations.

L¶

	Controller	Description
	LoggingRecordSink	Provides a RecordSinkService that can be used to log records to the application log (nifi-app.

M¶

	Controller	Description
	MapCacheClientService	Provides the ability to communicate with a MapCacheServer.
	MapCacheServer	Provides a map (key/value) cache that can be accessed over a socket.
	MicrosoftClientCertificateOAuth2TokenProvider	Provides OAuth2 access tokens for the Microsoft Graph API using client_credentials with a client certificate.
	MicrosoftGraphAuthenticationProvider	Provides authentication for the Microsoft Graph API, which can be used for interacting with Microsoft 365 services.
	MongoDBControllerService	Provides a controller service that configures a connection to MongoDB and provides access to that connection to other Mongo-related components.
	MongoDBLookupService	Provides a lookup service based around MongoDB.

P¶

	Controller	Description
	ParquetIcebergWriter	Provides record serialization for Apache Iceberg using Apache Parquet formatting
	PEMEncodedSSLContextProvider	SSLContext Provider configurable using PEM Private Key and Certificate files.
	PolarisIcebergCatalog	Provides Apache Iceberg integration with Apache Polaris Catalog access over REST HTTP
	PropertiesFileLookupService	A reloadable properties file-based lookup service
	ProtobufReader	Parses a Protocol Buffers message from binary format.

R¶

	Controller	Description
	ReaderLookup	Provides a RecordReaderFactory that can be used to dynamically select another RecordReaderFactory.
	RecordSetWriterLookup	Provides a RecordSetWriterFactory that can be used to dynamically select another RecordSetWriterFactory.
	RecordSinkServiceLookup	Provides a RecordSinkService that can be used to dynamically select another RecordSinkService.
	RedisConnectionPoolService	A service that provides connections to Redis.
	RedisDistributedMapCacheClientService	An implementation of DistributedMapCacheClient that uses Redis as the backing cache.
	RemoveFieldRecordReader	A wrapper for a RecordReaderFactory that supports filtering out specified fields from NiFi Records.
	RestLookupService	Use a REST service to look up values.

S¶

	Controller	Description
	S3FileResourceService	Provides an Amazon Web Services (AWS) S3 file resource for other components.
	SalesforceDataCloudOAuthTokenProvider	Retrieves an OAuth2 access token from Salesforce using the configured OAuth2 Access Token Provider and exchanges the token for a Data Cloud API token.
	ScriptedLookupService	Allows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file.
	ScriptedReader	Allows the user to provide a scripted RecordReaderFactory instance in order to read/parse/generate records from an incoming flow file.
	ScriptedRecordSetWriter	Allows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.
	ScriptedRecordSink	Allows the user to provide a scripted RecordSinkService instance in order to transmit records to the desired target.
	SetCacheClientService	Provides the ability to communicate with a SetCacheServer.
	SetCacheServer	Provides a set (collection of unique values) cache that can be accessed over a socket.
	SimpleCsvFileLookupService	A reloadable CSV file-based lookup service.
	SimpleDatabaseLookupService	A relational-database-based lookup service.
	SimpleKeyValueLookupService	Allows users to add key/value pairs as User-defined Properties.
	SimpleRedisDistributedMapCacheClientService	An implementation of DistributedMapCacheClient that uses Redis as the backing cache.
	SimpleScriptedLookupService	Allows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file.
	SlackRecordSink	Format and send Records to a configured Channel using the Slack Post Message API.
	SmbjClientProviderService	Provides access to SMB Sessions with shared authentication credentials.
	SnowflakeConnectionService	Provides pooled database connections to Snowflake services
	SnowflakeDatabaseDialectService	Database Dialect Service supporting Snowflake.
	SnowflakeSignJWTService	Provides OAuth2 access token using a JWT signed with a secret stored in Snowflake.
	SnowflakeTableSchemaRegistry	Uses Snowflake tables as the source of schema — utilises Snowpipe Streaming REST API.
	StandardAnthropicLLMService	A Controller Service that provides integration with Anthropic’s Claude AI models through their Messages API.
	StandardAtlassianRequestRateManager	Provides rate limiting coordination for Atlassian API calls across processors to prevent cascading rate limit issues.
	StandardAzureCredentialsControllerService	Provide credentials to use with an Azure client.
	StandardConfluenceClientService	Provides connection service to Confluence APIs
	StandardDatabricksWorkspaceClientService	Databricks client.
	StandardDropboxCredentialService	Defines credentials for Dropbox processors.
	StandardFileResourceService	Provides a file resource for other components.
	StandardHashiCorpVaultClientService	A controller service for interacting with HashiCorp Vault.
	StandardHttpContextMap	Provides the ability to store and retrieve HTTP requests and responses external to a Processor, so that multiple Processors can interact with the same HTTP request.
	StandardHubSpotClientService	HubSpot Controller Service to integrate with HubSpot HTTP api.
	StandardJsonSchemaRegistry	Provides a service for registering and accessing JSON schemas.
	StandardKustoIngestService	Sends batches of flowfile content or stream flowfile content to an Azure ADX cluster.
	StandardKustoQueryService	Standard implementation of Kusto Query Service for Azure Data Explorer
	StandardMilvusConnectionService	Provides connection service to a Milvus instance
	StandardOauth2AccessTokenProvider	Provides OAuth 2.
	StandardOCRService	Provides integration to Openflow OCR Service
	StandardOpenAILLMService	A Controller Service that provides integration with OpenAI’s Chat Completion API.
	StandardPGPPrivateKeyService	PGP Private Key Service provides Private Keys loaded from files or properties
	StandardPGPPublicKeyService	PGP Public Key Service providing Public Keys loaded from files
	StandardPrivateKeyService	Private Key Service provides access to a Private Key loaded from configured sources
	StandardProtobufReader	Parses Protocol Buffers messages from binary format into NiFi Records.
	StandardProxyConfigurationService	Provides a set of configurations for different NiFi components to use a proxy server.
	StandardRestrictedSSLContextService	Restricted implementation of the SSLContextService.
	StandardS3EncryptionService	Adds configurable encryption to S3 Put and S3 Fetch operations.
	StandardSalesforceBulkJobsStateService	Stores Salesforce Bulk Jobs state per object type at cluster scope
	StandardSalesforceClientService	Provides connection service to Salesforce APIs
	StandardSalesforceDataCloudClientService	Provides connection service to Salesforce Data Cloud APIs
	StandardSlackRateLimiterService	Provides rate limiting coordination for Slack API calls across processors to prevent cascading rate limit issues
	StandardSSLContextService	Standard implementation of the SSLContextService.
	StandardTableStateService	A controller Service that provides and manages table state.
	StandardVectaraClientService	Vectara Controller Service to integrate with Vectara HTTP Api.
	StandardWebClientServiceProvider	Web Client Service Provider with support for configuring standard HTTP connection properties
	StateManagedCdcSchemaRegistry	Uses the in-built NiFi State Management to store the hashes of table schemas.
	Syslog5424Reader	Provides a mechanism for reading RFC 5424 compliant Syslog data, such as log files, and structuring the data so that it can be processed.
	SyslogReader	Attempts to parses the contents of a Syslog message in accordance to RFC5424 and RFC3164.

U¶

	Controller	Description
	UDPEventRecordSink	Format and send Records as UDP Datagram Packets to a configurable destination

V¶

	Controller	Description
	VolatileSchemaCache	Provides a Schema Cache that evicts elements based on a Least-Recently-Used algorithm.

W¶

	Controller	Description
	WindowsEventLogReader	Reads Windows Event Log data as XML content having been generated by ConsumeWindowsEventLog, ParseEvtx, etc.

X¶

	Controller	Description
	XMLFileLookupService	A reloadable XML file-based lookup service.
	XMLReader	Reads XML content and creates Record objects.
	XMLRecordSetWriter	Writes a RecordSet to XML.

Y¶

	Controller	Description
	YamlTreeReader	Parses YAML into individual Record objects.